Skip to content

Commit 3d11c01

Browse files
gabriel-samfiragabriel-samfira
committed
Amend README
Signed-off-by: Gabriel Adrian Samfira <[email protected]>
1 parent beb3f5f commit 3d11c01

File tree

6 files changed

+34
-31
lines changed

6 files changed

+34
-31
lines changed

‎README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ region = "eu-central-1"
2828
subnet_id = "sample_subnet_id"
2929

3030
[credentials]
31-
credential_type = "access_key"
31+
# Allowed values are: static, role
32+
# When using IAM roles, you can omit the [credentials.static] section
33+
credential_type = "static"
34+
[credentials.static]
3235
access_key_id = "sample_access_key_id"
3336
secret_access_key = "sample_secret_access_key"
3437
session_token = "sample_session_token"

‎config/config.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import (
2828
type AWSCredentialType string
2929

3030
const (
31-
AWSCredentialTypeStaticCredentials AWSCredentialType = "static"
32-
AWSCredentialTypeRole AWSCredentialType = "role"
31+
AWSCredentialTypeStatic AWSCredentialType = "static"
32+
AWSCredentialTypeRole AWSCredentialType = "role"
3333
)
3434

3535
// NewConfig returns a new Config
@@ -99,7 +99,7 @@ type Credentials struct {
9999

100100
func (c Credentials) Validate() error {
101101
switch c.CredentialType {
102-
case AWSCredentialTypeStaticCredentials:
102+
case AWSCredentialTypeStatic:
103103
return c.StaticCredentials.Validate()
104104
case AWSCredentialTypeRole:
105105
case "":
@@ -118,7 +118,7 @@ func (c Config) GetAWSConfig(ctx context.Context) (aws.Config, error) {
118118
var cfg aws.Config
119119
var err error
120120
switch c.Credentials.CredentialType {
121-
case AWSCredentialTypeStaticCredentials:
121+
case AWSCredentialTypeStatic:
122122
cfg, err = config.LoadDefaultConfig(ctx,
123123
config.WithCredentialsProvider(
124124
credentials.NewStaticCredentialsProvider(

‎config/config_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func TestConfigValidate(t *testing.T) {
3232
name: "valid config",
3333
c: &Config{
3434
Credentials: Credentials{
35-
CredentialType: AWSCredentialTypeStaticCredentials,
35+
CredentialType: AWSCredentialTypeStatic,
3636
StaticCredentials: StaticCredentials{
3737
AccessKeyID: "access_key_id",
3838
SecretAccessKey: "secret_access_key",
@@ -48,7 +48,7 @@ func TestConfigValidate(t *testing.T) {
4848
name: "missing subnet_id",
4949
c: &Config{
5050
Credentials: Credentials{
51-
CredentialType: AWSCredentialTypeStaticCredentials,
51+
CredentialType: AWSCredentialTypeStatic,
5252
StaticCredentials: StaticCredentials{
5353
AccessKeyID: "access_key_id",
5454
SecretAccessKey: "secret_access_key",
@@ -63,7 +63,7 @@ func TestConfigValidate(t *testing.T) {
6363
name: "missing region",
6464
c: &Config{
6565
Credentials: Credentials{
66-
CredentialType: AWSCredentialTypeStaticCredentials,
66+
CredentialType: AWSCredentialTypeStatic,
6767
StaticCredentials: StaticCredentials{
6868
AccessKeyID: "access_key_id",
6969
SecretAccessKey: "secret_access_key",
@@ -116,7 +116,7 @@ func TestCredentialsValidate(t *testing.T) {
116116
{
117117
name: "valid credentials",
118118
c: Credentials{
119-
CredentialType: AWSCredentialTypeStaticCredentials,
119+
CredentialType: AWSCredentialTypeStatic,
120120
StaticCredentials: StaticCredentials{
121121
AccessKeyID: "access_key_id",
122122
SecretAccessKey: "secret_access_key",
@@ -128,7 +128,7 @@ func TestCredentialsValidate(t *testing.T) {
128128
{
129129
name: "missing access_key_id",
130130
c: Credentials{
131-
CredentialType: AWSCredentialTypeStaticCredentials,
131+
CredentialType: AWSCredentialTypeStatic,
132132
StaticCredentials: StaticCredentials{
133133
AccessKeyID: "",
134134
SecretAccessKey: "secret_access_key",
@@ -140,7 +140,7 @@ func TestCredentialsValidate(t *testing.T) {
140140
{
141141
name: "missing secret_access_key",
142142
c: Credentials{
143-
CredentialType: AWSCredentialTypeStaticCredentials,
143+
CredentialType: AWSCredentialTypeStatic,
144144
StaticCredentials: StaticCredentials{
145145
AccessKeyID: "access_key_id",
146146
SecretAccessKey: "",
@@ -152,7 +152,7 @@ func TestCredentialsValidate(t *testing.T) {
152152
{
153153
name: "missing session_token",
154154
c: Credentials{
155-
CredentialType: AWSCredentialTypeStaticCredentials,
155+
CredentialType: AWSCredentialTypeStatic,
156156
StaticCredentials: StaticCredentials{
157157
AccessKeyID: "access_key_id",
158158
SecretAccessKey: "secret_access_key",
@@ -205,7 +205,7 @@ func TestNewConfig(t *testing.T) {
205205
require.NoError(t, err, "NewConfig() should not have returned an error")
206206
require.Equal(t, &Config{
207207
Credentials: Credentials{
208-
CredentialType: AWSCredentialTypeStaticCredentials,
208+
CredentialType: AWSCredentialTypeStatic,
209209
StaticCredentials: StaticCredentials{
210210
AccessKeyID: "access_key_id",
211211
SecretAccessKey: "secret",

‎internal/client/aws_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func TestStartInstance(t *testing.T) {
3535
Region: "us-west-2",
3636
SubnetID: "subnet-1234567890abcdef0",
3737
Credentials: config.Credentials{
38-
CredentialType: config.AWSCredentialTypeStaticCredentials,
38+
CredentialType: config.AWSCredentialTypeStatic,
3939
StaticCredentials: config.StaticCredentials{
4040
AccessKeyID: "AccessKeyID",
4141
SecretAccessKey: "SecretAccessKey",
@@ -65,7 +65,7 @@ func TestStopInstance(t *testing.T) {
6565
Region: "us-west-2",
6666
SubnetID: "subnet-1234567890abcdef0",
6767
Credentials: config.Credentials{
68-
CredentialType: config.AWSCredentialTypeStaticCredentials,
68+
CredentialType: config.AWSCredentialTypeStatic,
6969
StaticCredentials: config.StaticCredentials{
7070
AccessKeyID: "AccessKeyID",
7171
SecretAccessKey: "SecretAccessKey",
@@ -95,7 +95,7 @@ func TestFindInstances(t *testing.T) {
9595
Region: "us-west-2",
9696
SubnetID: "subnet-1234567890abcdef0",
9797
Credentials: config.Credentials{
98-
CredentialType: config.AWSCredentialTypeStaticCredentials,
98+
CredentialType: config.AWSCredentialTypeStatic,
9999
StaticCredentials: config.StaticCredentials{
100100
AccessKeyID: "AccessKeyID",
101101
SecretAccessKey: "SecretAccessKey",
@@ -154,7 +154,7 @@ func TestFindOneInstanceWithName(t *testing.T) {
154154
Region: "us-west-2",
155155
SubnetID: "subnet-1234567890abcdef0",
156156
Credentials: config.Credentials{
157-
CredentialType: config.AWSCredentialTypeStaticCredentials,
157+
CredentialType: config.AWSCredentialTypeStatic,
158158
StaticCredentials: config.StaticCredentials{
159159
AccessKeyID: "AccessKeyID",
160160
SecretAccessKey: "SecretAccessKey",
@@ -207,7 +207,7 @@ func TestFindOneInstanceWithID(t *testing.T) {
207207
Region: "us-west-2",
208208
SubnetID: "subnet-1234567890abcdef0",
209209
Credentials: config.Credentials{
210-
CredentialType: config.AWSCredentialTypeStaticCredentials,
210+
CredentialType: config.AWSCredentialTypeStatic,
211211
StaticCredentials: config.StaticCredentials{
212212
AccessKeyID: "AccessKeyID",
213213
SecretAccessKey: "SecretAccessKey",
@@ -249,7 +249,7 @@ func TestGetInstance(t *testing.T) {
249249
Region: "us-west-2",
250250
SubnetID: "subnet-1234567890abcdef0",
251251
Credentials: config.Credentials{
252-
CredentialType: config.AWSCredentialTypeStaticCredentials,
252+
CredentialType: config.AWSCredentialTypeStatic,
253253
StaticCredentials: config.StaticCredentials{
254254
AccessKeyID: "AccessKeyID",
255255
SecretAccessKey: "SecretAccessKey",
@@ -288,7 +288,7 @@ func TestTerminateInstance(t *testing.T) {
288288
Region: "us-west-2",
289289
SubnetID: "subnet-1234567890abcdef0",
290290
Credentials: config.Credentials{
291-
CredentialType: config.AWSCredentialTypeStaticCredentials,
291+
CredentialType: config.AWSCredentialTypeStatic,
292292
StaticCredentials: config.StaticCredentials{
293293
AccessKeyID: "AccessKeyID",
294294
SecretAccessKey: "SecretAccessKey",
@@ -336,7 +336,7 @@ func TestCreateRunningInstance(t *testing.T) {
336336
Region: "us-west-2",
337337
SubnetID: "subnet-1234567890abcdef0",
338338
Credentials: config.Credentials{
339-
CredentialType: config.AWSCredentialTypeStaticCredentials,
339+
CredentialType: config.AWSCredentialTypeStatic,
340340
StaticCredentials: config.StaticCredentials{
341341
AccessKeyID: "AccessKeyID",
342342
SecretAccessKey: "SecretAccessKey",

‎internal/spec/spec_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ func TestGetRunnerSpecFromBootstrapParams(t *testing.T) {
120120

121121
config := &config.Config{
122122
Credentials: config.Credentials{
123-
CredentialType: config.AWSCredentialTypeStaticCredentials,
123+
CredentialType: config.AWSCredentialTypeStatic,
124124
StaticCredentials: config.StaticCredentials{
125125
AccessKeyID: "AccessKeyID",
126126
SecretAccessKey: "SecretAccessKey",

‎provider/provider_test.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ func TestCreateInstance(t *testing.T) {
7474
Region: "us-east-1",
7575
SubnetID: "subnet-123456",
7676
Credentials: config.Credentials{
77-
CredentialType: config.AWSCredentialTypeStaticCredentials,
77+
CredentialType: config.AWSCredentialTypeStatic,
7878
StaticCredentials: config.StaticCredentials{
7979
AccessKeyID: "AccessKeyID",
8080
SecretAccessKey: "SecretAccessKey",
@@ -109,7 +109,7 @@ func TestDeleteInstanceWithID(t *testing.T) {
109109
Region: "us-east-1",
110110
SubnetID: "subnet-123456",
111111
Credentials: config.Credentials{
112-
CredentialType: config.AWSCredentialTypeStaticCredentials,
112+
CredentialType: config.AWSCredentialTypeStatic,
113113
StaticCredentials: config.StaticCredentials{
114114
AccessKeyID: "AccessKeyID",
115115
SecretAccessKey: "SecretAccessKey",
@@ -140,7 +140,7 @@ func TestDeleteInstanceWithName(t *testing.T) {
140140
Region: "us-east-1",
141141
SubnetID: "subnet-123456",
142142
Credentials: config.Credentials{
143-
CredentialType: config.AWSCredentialTypeStaticCredentials,
143+
CredentialType: config.AWSCredentialTypeStatic,
144144
StaticCredentials: config.StaticCredentials{
145145
AccessKeyID: "AccessKeyID",
146146
SecretAccessKey: "SecretAccessKey",
@@ -204,7 +204,7 @@ func TestGetInstanceWithID(t *testing.T) {
204204
Region: "us-east-1",
205205
SubnetID: "subnet-123456",
206206
Credentials: config.Credentials{
207-
CredentialType: config.AWSCredentialTypeStaticCredentials,
207+
CredentialType: config.AWSCredentialTypeStatic,
208208
StaticCredentials: config.StaticCredentials{
209209
AccessKeyID: "AccessKeyID",
210210
SecretAccessKey: "SecretAccessKey",
@@ -276,7 +276,7 @@ func TestGetInstanceWithName(t *testing.T) {
276276
Region: "us-east-1",
277277
SubnetID: "subnet-123456",
278278
Credentials: config.Credentials{
279-
CredentialType: config.AWSCredentialTypeStaticCredentials,
279+
CredentialType: config.AWSCredentialTypeStatic,
280280
StaticCredentials: config.StaticCredentials{
281281
AccessKeyID: "AccessKeyID",
282282
SecretAccessKey: "SecretAccessKey",
@@ -363,7 +363,7 @@ func TestListInstances(t *testing.T) {
363363
Region: "us-east-1",
364364
SubnetID: "subnet-123456",
365365
Credentials: config.Credentials{
366-
CredentialType: config.AWSCredentialTypeStaticCredentials,
366+
CredentialType: config.AWSCredentialTypeStatic,
367367
StaticCredentials: config.StaticCredentials{
368368
AccessKeyID: "AccessKeyID",
369369
SecretAccessKey: "SecretAccessKey",
@@ -452,7 +452,7 @@ func TestStop(t *testing.T) {
452452
Region: "us-east-1",
453453
SubnetID: "subnet-123456",
454454
Credentials: config.Credentials{
455-
CredentialType: config.AWSCredentialTypeStaticCredentials,
455+
CredentialType: config.AWSCredentialTypeStatic,
456456
StaticCredentials: config.StaticCredentials{
457457
AccessKeyID: "AccessKeyID",
458458
SecretAccessKey: "SecretAccessKey",
@@ -482,7 +482,7 @@ func TestStartStoppedInstance(t *testing.T) {
482482
Region: "us-east-1",
483483
SubnetID: "subnet-123456",
484484
Credentials: config.Credentials{
485-
CredentialType: config.AWSCredentialTypeStaticCredentials,
485+
CredentialType: config.AWSCredentialTypeStatic,
486486
StaticCredentials: config.StaticCredentials{
487487
AccessKeyID: "AccessKeyID",
488488
SecretAccessKey: "SecretAccessKey",
@@ -534,7 +534,7 @@ func TestStartStoppingInstance(t *testing.T) {
534534
Region: "us-east-1",
535535
SubnetID: "subnet-123456",
536536
Credentials: config.Credentials{
537-
CredentialType: config.AWSCredentialTypeStaticCredentials,
537+
CredentialType: config.AWSCredentialTypeStatic,
538538
StaticCredentials: config.StaticCredentials{
539539
AccessKeyID: "AccessKeyID",
540540
SecretAccessKey: "SecretAccessKey",

0 commit comments

Comments
 (0)