Skip to content

Commit a15ee8d

Browse files
committed
Rename IMDSCredentialRefresher to IMDSCredentialsRefresher
Align with the plural naming used by sibling types in the credentials package (CredentialsManager, IAMRoleCredentials). Single-entity types (TaskCredential) and per-credential methods (upsertCredential, parseCredentialKey, etc.) stay singular per Go entity convention.
1 parent 9ff6ead commit a15ee8d

9 files changed

Lines changed: 43 additions & 43 deletions

File tree

agent/app/agent.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -971,8 +971,8 @@ func (agent *ecsAgent) startAsyncRoutines(
971971
go agent.startSpotInstanceDrainingPoller(agent.ctx, client)
972972
}
973973

974-
// Start IMDS credential refresher for periodic task credential retrieval via IMDS.
975-
if imdsRefresher := agent.getIMDSCredentialRefresher(credentialsManager, taskEngine); imdsRefresher != nil {
974+
// Start IMDS credentials refresher for periodic task credential retrieval via IMDS.
975+
if imdsRefresher := agent.getIMDSCredentialsRefresher(credentialsManager, taskEngine); imdsRefresher != nil {
976976
go imdsRefresher.Start()
977977
}
978978

@@ -1027,15 +1027,15 @@ func (agent *ecsAgent) startSpotInstanceDrainingPoller(ctx context.Context, clie
10271027
}
10281028
}
10291029

1030-
// getIMDSCredentialRefresher returns an IMDS credential refresher
1030+
// getIMDSCredentialsRefresher returns an IMDS credentials refresher
10311031
// if the IMDSIAMRolesEnabled configuration is enabled.
1032-
func (agent *ecsAgent) getIMDSCredentialRefresher(
1032+
func (agent *ecsAgent) getIMDSCredentialsRefresher(
10331033
credentialsManager credentials.Manager,
10341034
taskEngine engine.TaskEngine,
1035-
) *imdscreds.IMDSCredentialRefresher {
1035+
) *imdscreds.IMDSCredentialsRefresher {
10361036
if agent.cfg.IMDSIAMRolesEnabled {
10371037
imdsScanner := imds.NewScanner(agent.ec2MetadataClient)
1038-
return imdscreds.NewIMDSCredentialRefresher(
1038+
return imdscreds.NewIMDSCredentialsRefresher(
10391039
agent.ctx, imdsScanner, credentialsManager,
10401040
taskEngine, imdscreds.ScanInterval,
10411041
)

agent/app/agent_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2119,7 +2119,7 @@ func TestLoadManagedDaemonImage(t *testing.T) {
21192119
}
21202120
}
21212121

2122-
func TestGetIMDSCredentialRefresher(t *testing.T) {
2122+
func TestGetIMDSCredentialsRefresher(t *testing.T) {
21232123
tests := []struct {
21242124
name string
21252125
enabled bool
@@ -2155,7 +2155,7 @@ func TestGetIMDSCredentialRefresher(t *testing.T) {
21552155
ec2MetadataClient: mockEC2Metadata,
21562156
}
21572157

2158-
result := agent.getIMDSCredentialRefresher(
2158+
result := agent.getIMDSCredentialsRefresher(
21592159
mockCredManager, mockEngine,
21602160
)
21612161
if tc.expectRefresher {

agent/imdscreds/refresher.go

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,30 @@ import (
2828
)
2929

3030
const (
31-
// ScanInterval is the default interval between IMDS credential scans.
31+
// ScanInterval is the default interval between IMDS credentials scans.
3232
// TODO: this value will be finalized based on load testing.
3333
ScanInterval = 15 * time.Minute
3434
)
3535

36-
// IMDSCredentialRefresher periodically scans IMDS for rotated task credentials
36+
// IMDSCredentialsRefresher periodically scans IMDS for rotated task credentials
3737
// and upserts them into the credentials manager.
38-
type IMDSCredentialRefresher struct {
38+
type IMDSCredentialsRefresher struct {
3939
ctx context.Context
4040
scanner imds.Scanner
4141
credManager credentials.Manager
4242
taskEngine engine.TaskEngine
4343
scanInterval time.Duration
4444
}
4545

46-
// NewIMDSCredentialRefresher creates a new IMDS credential refresher.
47-
func NewIMDSCredentialRefresher(
46+
// NewIMDSCredentialsRefresher creates a new IMDS credentials refresher.
47+
func NewIMDSCredentialsRefresher(
4848
ctx context.Context,
4949
scanner imds.Scanner,
5050
credManager credentials.Manager,
5151
taskEngine engine.TaskEngine,
5252
scanInterval time.Duration,
53-
) *IMDSCredentialRefresher {
54-
return &IMDSCredentialRefresher{
53+
) *IMDSCredentialsRefresher {
54+
return &IMDSCredentialsRefresher{
5555
ctx: ctx,
5656
scanner: scanner,
5757
credManager: credManager,
@@ -60,29 +60,29 @@ func NewIMDSCredentialRefresher(
6060
}
6161
}
6262

63-
// Start begins the periodic IMDS credential scan loop. It blocks until the
63+
// Start begins the periodic IMDS credentials scan loop. It blocks until the
6464
// context is cancelled.
65-
func (r *IMDSCredentialRefresher) Start() {
66-
logger.Info("Starting IMDS credential refresher")
65+
func (r *IMDSCredentialsRefresher) Start() {
66+
logger.Info("Starting IMDS credentials refresher")
6767
ticker := time.NewTicker(r.scanInterval)
6868
defer ticker.Stop()
6969
for {
7070
select {
7171
case <-ticker.C:
7272
r.refresh()
7373
case <-r.ctx.Done():
74-
logger.Info("IMDS credential refresher stopped")
74+
logger.Info("IMDS credentials refresher stopped")
7575
return
7676
}
7777
}
7878
}
7979

80-
// refresh performs a single IMDS credential scan and upserts any matching
80+
// refresh performs a single IMDS credentials scan and upserts any matching
8181
// credentials into the credentials manager.
82-
func (r *IMDSCredentialRefresher) refresh() {
82+
func (r *IMDSCredentialsRefresher) refresh() {
8383
tasks, err := r.taskEngine.ListTasks()
8484
if err != nil {
85-
logger.Error("IMDS credential refresh: failed to list tasks", logger.Fields{
85+
logger.Error("IMDS credentials refresh: failed to list tasks", logger.Fields{
8686
field.Error: err,
8787
})
8888
return
@@ -91,13 +91,13 @@ func (r *IMDSCredentialRefresher) refresh() {
9191
// Build a map of task ID -> task for non-terminal tasks.
9292
nonTerminalTasks := nonTerminalTasksByID(tasks)
9393
if len(nonTerminalTasks) == 0 {
94-
logger.Debug("IMDS credential refresh: no non-terminal tasks, skipping scan")
94+
logger.Debug("IMDS credentials refresh: no non-terminal tasks, skipping scan")
9595
return
9696
}
9797

9898
creds, err := r.scanner.Scan(r.ctx)
9999
if err != nil {
100-
logger.Error("IMDS credential refresh: scan failed", logger.Fields{
100+
logger.Error("IMDS credentials refresh: scan failed", logger.Fields{
101101
field.Error: err,
102102
})
103103
return
@@ -108,7 +108,7 @@ func (r *IMDSCredentialRefresher) refresh() {
108108
if !ok {
109109
// Credential for a task that's either terminal or unknown
110110
// (for example, due to data corruption); skip.
111-
logger.Debug("IMDS credential refresh: task not in non-terminal set, skipping", logger.Fields{
111+
logger.Debug("IMDS credentials refresh: task not in non-terminal set, skipping", logger.Fields{
112112
field.TaskID: cred.TaskID,
113113
})
114114
continue
@@ -119,12 +119,12 @@ func (r *IMDSCredentialRefresher) refresh() {
119119

120120
// upsertCredential maps an IMDS credential to the task's role type
121121
// and upserts it into the credentials manager.
122-
func (r *IMDSCredentialRefresher) upsertCredential(
122+
func (r *IMDSCredentialsRefresher) upsertCredential(
123123
task *apitask.Task, cred imds.TaskCredential,
124124
) {
125125
credentialsID := task.GetCredentialsIDForRoleType(cred.RoleType)
126126
if credentialsID == "" {
127-
logger.Warn("IMDS credential refresh: no credentials ID for task",
127+
logger.Warn("IMDS credentials refresh: no credentials ID for task",
128128
logger.Fields{
129129
field.TaskID: cred.TaskID,
130130
"roleType": cred.RoleType,
@@ -145,7 +145,7 @@ func (r *IMDSCredentialRefresher) upsertCredential(
145145
},
146146
})
147147
if err != nil {
148-
logger.Error("IMDS credential refresh: failed to upsert credential",
148+
logger.Error("IMDS credentials refresh: failed to upsert credential",
149149
logger.Fields{
150150
field.TaskID: cred.TaskID,
151151
field.Error: err,

agent/imdscreds/refresher_integ_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ const (
5252
credID2Exec = "cred-b-exec"
5353
)
5454

55-
// TestIMDSCredentialRefresh tests the integration between the IMDS
56-
// credential refresher, scanner, task engine state, credentials manager,
55+
// TestIMDSCredentialsRefresh tests the integration between the IMDS
56+
// credentials refresher, scanner, task engine state, credentials manager,
5757
// and a mock IMDS HTTP server.
5858
//
5959
// Phase 1: Setup the mock IMDS server, task engine, and credentials refresher.
@@ -63,7 +63,7 @@ const (
6363
//
6464
// Phase 3: Rotate credentials on the mock server and verify the refresher
6565
// picks up the new values on the next scan cycle.
66-
func TestIMDSCredentialRefresh(t *testing.T) {
66+
func TestIMDSCredentialsRefresh(t *testing.T) {
6767
// Phase 1: Setup.
6868
//
6969
// Start a mock IMDS server.
@@ -78,8 +78,8 @@ func TestIMDSCredentialRefresh(t *testing.T) {
7878
scanner := ecsagentimds.NewScanner(newEC2Client(t, mockIMDS.URL()))
7979
ctx, cancel := context.WithCancel(context.Background())
8080

81-
// Setup the credential refresher.
82-
refresher := NewIMDSCredentialRefresher(
81+
// Setup the credentials refresher.
82+
refresher := NewIMDSCredentialsRefresher(
8383
ctx, scanner, credManager, taskEngine, testScanInterval,
8484
)
8585

agent/imdscreds/refresher_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ func TestRefresh(t *testing.T) {
318318
Times(0)
319319
}
320320

321-
refresher := &IMDSCredentialRefresher{
321+
refresher := &IMDSCredentialsRefresher{
322322
ctx: context.Background(),
323323
scanner: mockScanner,
324324
credManager: mockCredManager,
@@ -426,7 +426,7 @@ func TestUpsertCredential(t *testing.T) {
426426
Times(0)
427427
}
428428

429-
refresher := &IMDSCredentialRefresher{
429+
refresher := &IMDSCredentialsRefresher{
430430
ctx: context.Background(),
431431
credManager: mockCredManager,
432432
}

agent/vendor/github.com/aws/amazon-ecs-agent/ecs-agent/credentials/imds/scanner.go

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

agent/vendor/github.com/aws/amazon-ecs-agent/ecs-agent/credentials/imds/testutil/mock_imds_server.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

ecs-agent/credentials/imds/scanner.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
// express or implied. See the License for the specific language governing
1212
// permissions and limitations under the License.
1313

14-
// Package imds provides an IMDS credential scanner that retrieves task
14+
// Package imds provides an IMDS credentials scanner that retrieves task
1515
// credentials from IMDS.
1616
package imds
1717

@@ -48,7 +48,7 @@ const (
4848
// IMDS shares a 1024 packets-per-second (PPS) limit with other
4949
// link local services (Route 53 DNS, NTP).
5050
// Ref: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
51-
// The rate limiter keeps credential scanning within ~10% of the total PPS budget
51+
// The rate limiter keeps credentials scanning within ~10% of the total PPS budget
5252
// to leave headroom for other link-local requests on the instance.
5353
//
5454
// TODO: this value will be finalized based on load testing.
@@ -75,7 +75,7 @@ type scanner struct {
7575
lastUpdated map[string]time.Time
7676
}
7777

78-
// NewScanner creates a new IMDS credential scanner.
78+
// NewScanner creates a new IMDS credentials scanner.
7979
func NewScanner(ec2MetadataClient ec2.EC2MetadataClient) Scanner {
8080
return &scanner{
8181
ec2MetadataClient: ec2MetadataClient,

ecs-agent/credentials/imds/testutil/mock_imds_server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
// permissions and limitations under the License.
1616

1717
// Package testutil provides a mock IMDS HTTP server for integration testing
18-
// the IMDS credential scanner with agent's refresher.
18+
// the IMDS credentials scanner with agent's refresher.
1919
package testutil
2020

2121
import (

0 commit comments

Comments
 (0)