/
config.go
842 lines (739 loc) · 37.4 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
// Package eksconfig defines EKS test configuration.
package eksconfig
import (
"bytes"
"fmt"
"io/ioutil"
"path/filepath"
"text/template"
"time"
"github.com/aws/aws-k8s-tester/ec2config"
"sigs.k8s.io/yaml"
)
// Config defines EKS test configuration.
type Config struct {
// ConfigPath is the configuration file path.
// Deployer is expected to update this file with latest status.
ConfigPath string `json:"config-path,omitempty"`
// KubectlCommandsOutputPath is the output path for kubectl commands.
KubectlCommandsOutputPath string `json:"kubectl-commands-output-path,omitempty"`
// SSHCommandsOutputPath is the output path for ssh commands.
SSHCommandsOutputPath string `json:"ssh-commands-output-path,omitempty"`
// Region is the AWS geographic area for EKS deployment.
// If empty, set default region.
Region string `json:"region,omitempty"`
// Name is the cluster name.
// If empty, deployer auto-populates it.
Name string `json:"name,omitempty"`
// LogLevel configures log level. Only supports debug, info, warn, error, panic, or fatal. Default 'info'.
LogLevel string `json:"log-level"`
// LogOutputs is a list of log outputs. Valid values are 'default', 'stderr', 'stdout', or file names.
// Logs are appended to the existing file, if any.
// Multiple values are accepted. If empty, it sets to 'default', which outputs to stderr.
// See https://pkg.go.dev/go.uber.org/zap#Open and https://pkg.go.dev/go.uber.org/zap#Config for more details.
LogOutputs []string `json:"log-outputs,omitempty"`
// AWSCLIPath is the path for AWS CLI path.
AWSCLIPath string `json:"aws-cli-path,omitempty"`
// KubectlPath is the path to download the "kubectl".
KubectlPath string `json:"kubectl-path,omitempty"`
// KubectlDownloadURL is the download URL to download "kubectl" binary from.
// https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html
KubectlDownloadURL string `json:"kubectl-download-url,omitempty"`
// KubeConfigPath is the file path of KUBECONFIG for the EKS cluster.
// If empty, auto-generate one.
// Deployer is expected to delete this on cluster tear down.
KubeConfigPath string `json:"kubeconfig-path,omitempty"`
// AWSIAMAuthenticatorPath is the path to aws-iam-authenticator.
AWSIAMAuthenticatorPath string `json:"aws-iam-authenticator-path,omitempty"`
// AWSIAMAuthenticatorDownloadURL is the download URL to download "aws-iam-authenticator" binary from.
AWSIAMAuthenticatorDownloadURL string `json:"aws-iam-authenticator-download-url,omitempty"`
// OnFailureDelete is true to delete all resources on creation fail.
OnFailureDelete bool `json:"on-failure-delete"`
// OnFailureDeleteWaitSeconds is the seconds to wait before deleting
// all resources on creation fail.
OnFailureDeleteWaitSeconds uint64 `json:"on-failure-delete-wait-seconds"`
// Parameters defines EKS "cluster" creation parameters.
// It's ok to leave any parameters empty.
// If empty, it will use default values.
Parameters *Parameters `json:"parameters,omitempty"`
// AddOnManagedNodeGroups defines EKS "Managed Node Group"
// creation parameters. If empty, it will use default values.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
AddOnManagedNodeGroups *AddOnManagedNodeGroups `json:"add-on-managed-node-groups,omitempty"`
// AddOnNLBHelloWorld defines parameters for EKS cluster
// add-on NLB hello-world service.
AddOnNLBHelloWorld *AddOnNLBHelloWorld `json:"add-on-nlb-hello-world,omitempty"`
// AddOnALB2048 defines parameters for EKS cluster
// add-on ALB 2048 service.
AddOnALB2048 *AddOnALB2048 `json:"add-on-alb-2048,omitempty"`
// AddOnJobPerl defines parameters for EKS cluster
// add-on Job with Perl.
AddOnJobPerl *AddOnJobPerl `json:"add-on-job-perl,omitempty"`
// AddOnJobEcho defines parameters for EKS cluster
// add-on Job with echo.
AddOnJobEcho *AddOnJobEcho `json:"add-on-job-echo,omitempty"`
// AddOnSecrets defines parameters for EKS cluster
// add-on "Secrets".
AddOnSecrets *AddOnSecrets `json:"add-on-secrets,omitempty"`
// AddOnIRSA defines parameters for EKS cluster
// add-on "IAM Roles for Service Accounts (IRSA)".
AddOnIRSA *AddOnIRSA `json:"add-on-irsa,omitempty"`
// AddOnFargate defines parameters for EKS cluster
// add-on "EKS on Fargate".
AddOnFargate *AddOnFargate `json:"add-on-fargate,omitempty"`
// Status represents the current status of AWS resources.
// Status is read-only.
// Status cannot be configured via environmental variables.
Status *Status `json:"status,omitempty" read-only:"true"`
// StatusManagedNodeGroups represents EKS "Managed Node Group" status.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
StatusManagedNodeGroups *StatusManagedNodeGroups `json:"status-managed-node-groups" read-only:"true"`
}
// Parameters defines parameters for EKS "cluster" creation.
type Parameters struct {
// ClusterRoleServicePrincipals is the EKS Role Service Principals
ClusterRoleServicePrincipals []string `json:"cluster-role-service-principals,omitempty"`
// ClusterRoleManagedPolicyARNs is EKS Role managed policy ARNs.
ClusterRoleManagedPolicyARNs []string `json:"cluster-role-managed-policy-arns,omitempty"`
// ClusterRoleARN is the role ARN that EKS uses to create AWS resources for Kubernetes.
// By default, it's empty which triggers tester to create one.
ClusterRoleARN string `json:"cluster-role-arn,omitempty"`
// ClusterTags defines EKS create cluster tags.
ClusterTags map[string]string `json:"cluster-tags,omitempty"`
// ClusterRequestHeaderKey defines EKS create cluster request header key.
ClusterRequestHeaderKey string `json:"cluster-request-header-key,omitempty"`
// ClusterRequestHeaderValue defines EKS create cluster request header value.
ClusterRequestHeaderValue string `json:"cluster-request-header-value,omitempty"`
// ClusterResolverURL defines an AWS resolver endpoint for EKS API.
// Must be left empty to use production EKS service.
ClusterResolverURL string `json:"cluster-resolver-url"`
// ClusterSigningName is the EKS create request signing name.
ClusterSigningName string `json:"cluster-signing-name"`
// VPCID is the VPC ID for cluster creation.
// If not empty, VPC is reused and not deleted.
// If empty, VPC is created anew and deleted on cluster deletion.
VPCID string `json:"vpc-id"`
// VpcCIDR is the IP range (CIDR notation) for VPC, must be a valid private
// (RFC 1918) CIDR range.
VPCCIDR string `json:"vpc-cidr,omitempty"`
// PublicSubnetCIDR1 is the CIDR Block for subnet 1 within the VPC.
PublicSubnetCIDR1 string `json:"public-subnet-cidr-1,omitempty"`
// PublicSubnetCIDR2 is the CIDR Block for subnet 2 within the VPC.
PublicSubnetCIDR2 string `json:"public-subnet-cidr-2,omitempty"`
// PublicSubnetCIDR3 is the CIDR Block for subnet 3 within the VPC.
PublicSubnetCIDR3 string `json:"public-subnet-cidr-3,omitempty"`
// PrivateSubnetCIDR1 is the CIDR Block for subnet 1 within the VPC.
PrivateSubnetCIDR1 string `json:"private-subnet-cidr-1,omitempty"`
// PrivateSubnetCIDR2 is the CIDR Block for subnet 2 within the VPC.
PrivateSubnetCIDR2 string `json:"private-subnet-cidr-2,omitempty"`
// Version is the version of EKS Kubernetes "cluster".
// If empty, set default version.
Version string `json:"version,omitempty"`
}
// AddOnManagedNodeGroups defines parameters for EKS "Managed Node Group" creation.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
type AddOnManagedNodeGroups struct {
// Enable is true to auto-create a managed node group.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// RoleName is the name of the managed node group.
RoleName string `json:"role-name,omitempty"`
// RoleServicePrincipals is the node group Service Principals
RoleServicePrincipals []string `json:"role-service-principals,omitempty"`
// RoleManagedPolicyARNs is node group managed policy ARNs.
RoleManagedPolicyARNs []string `json:"role-managed-policy-arns,omitempty"`
// RoleARN is the role ARN that EKS managed node group uses to create AWS resources for Kubernetes.
// By default, it's empty which triggers tester to create one.
RoleARN string `json:"role-arn,omitempty"`
// RequestHeaderKey defines EKS managed node group create cluster request header key.
RequestHeaderKey string `json:"request-header-key,omitempty"`
// RequestHeaderValue defines EKS managed node group create cluster request header value.
RequestHeaderValue string `json:"request-header-value,omitempty"`
// ResolverURL defines an AWS resolver endpoint for EKS API.
// Must be left empty to use production EKS managed node group service.
ResolverURL string `json:"resolver-url"`
// SigningName is the EKS managed node group create request signing name.
SigningName string `json:"signing-name"`
// SSHKeyPairName is the key name for node group SSH EC2 key pair.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
SSHKeyPairName string `json:"ssh-key-pair-name,omitempty"`
// RemoteAccessPrivateKeyPath is the file path to store node group key pair private key.
// Thus, deployer must delete the private key right after node group creation.
// MAKE SURE PRIVATE KEY NEVER GETS UPLOADED TO CLOUD STORAGE AND DELETE AFTER USE!!!
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
RemoteAccessPrivateKeyPath string `json:"remote-access-private-key-path,omitempty"`
// RemoteAccessUserName is the user name for managed node group SSH access.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
RemoteAccessUserName string `json:"remote-access-user-name,omitempty"`
// LogsDir is set to specify the target directory to store all remote log files.
// If empty, it stores in the same directory as "ConfigPath".
LogsDir string `json:"logs-dir,omitempty"`
// MNGs maps from EKS Managed Node Group name to "MNG".
MNGs map[string]MNG `json:"mngs,omitempty"`
}
// MNG represents parameters for one EKS "Managed Node Group".
type MNG struct {
// Name is the name of the managed node group.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
Name string `json:"name,omitempty"`
// Tags defines EKS managed node group create tags.
Tags map[string]string `json:"tags,omitempty"`
// ReleaseVersion is the AMI version of the Amazon EKS-optimized AMI for the node group.
// The version may differ from EKS "cluster" version.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ReleaseVersion string `json:"release-version,omitempty"`
// AMIType is the AMI type for the node group.
// Allowed values are AL2_x86_64 and AL2_x86_64_GPU.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
AMIType string `json:"ami-type,omitempty"`
// ASGMinSize is the minimum size of Node Group Auto Scaling Group.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ASGMinSize int `json:"asg-min-size,omitempty"`
// ASGMaxSize is the maximum size of Node Group Auto Scaling Group.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ASGMaxSize int `json:"asg-max-size,omitempty"`
// ASGDesiredCapacity is the desired capacity of Node Group ASG.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ASGDesiredCapacity int `json:"asg-desired-capacity,omitempty"`
// InstanceTypes is the EC2 instance types for the node instances.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
InstanceTypes []string `json:"instance-types,omitempty"`
// VolumeSize is the node volume size.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
VolumeSize int `json:"volume-size,omitempty"`
}
// AddOnNLBHelloWorld defines parameters for EKS cluster
// add-on NLB hello-world service.
type AddOnNLBHelloWorld struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// DeploymentReplicas is the number of replicas to deploy using "Deployment" object.
DeploymentReplicas int32 `json:"deployment-replicas"`
// Namespace is the namespace to create "NLB" objects in.
Namespace string `json:"namespace"`
// NLBARN is the ARN of the NLB created from the service.
NLBARN string `json:"nlb-arn" read-only:"true"`
// NLBName is the name of the NLB created from the service.
NLBName string `json:"nlb-name" read-only:"true"`
// URL is the host name for hello-world service.
URL string `json:"url" read-only:"true"`
}
// AddOnALB2048 defines parameters for EKS cluster
// add-on ALB 2048 service.
type AddOnALB2048 struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// PolicyCFNStackID is the CloudFormation stack ID
// for ALB Ingress Controller IAM policy.
PolicyCFNStackID string `json:"policy-cfn-stack-id" read-only:"true"`
PolicyName string `json:"policy-name"`
// Namespace is the namespace to create "ALB" objects in.
Namespace string `json:"namespace"`
// DeploymentReplicasALB is the number of ALB replicas to deploy using "Deployment" object.
DeploymentReplicasALB int32 `json:"deployment-replicas-alb"`
// DeploymentReplicas2048 is the number of 2048 replicas to deploy using "Deployment" object.
DeploymentReplicas2048 int32 `json:"deployment-replicas-2048"`
// ALBARN is the ARN of the ALB created from the service.
ALBARN string `json:"alb-arn" read-only:"true"`
// ALBName is the name of the ALB created from the service.
ALBName string `json:"alb-name" read-only:"true"`
// URL is the URL for ALB 2048 Service.
URL string `json:"url" read-only:"true"`
}
// AddOnJobPerl defines parameters for EKS cluster
// add-on Job with Perl.
type AddOnJobPerl struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// Namespace is the namespace to create "Job" objects in.
Namespace string `json:"namespace"`
// Completes the desired number of successfully finished pods.
Completes int `json:"completes"`
// Parallels is the the maximum desired number of pods the
// job should run at any given time.
Parallels int `json:"parallels"`
}
// AddOnJobEcho defines parameters for EKS cluster
// add-on Job with echo.
type AddOnJobEcho struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// Namespace is the namespace to create "Job" objects in.
Namespace string `json:"namespace"`
// Completes the desired number of successfully finished pods.
Completes int `json:"completes"`
// Parallels is the the maximum desired number of pods the
// job should run at any given time.
Parallels int `json:"parallels"`
// Size is the job object size in bytes.
// "Request entity too large: limit is 3145728" (3.1 MB).
// "The Job "echo" is invalid: metadata.annotations:
// Too long: must have at most 262144 characters". (0.26 MB)
Size int `json:"size"`
}
// AddOnSecrets defines parameters for EKS cluster
// add-on "Secrets".
type AddOnSecrets struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// Namespace is the namespace to create "Secret" and "Pod" objects in.
Namespace string `json:"namespace"`
// Objects is the number of "Secret" objects to write/read.
Objects int `json:"objects"`
// Size is the "Secret" value size in bytes.
Size int `json:"size"`
// SecretQPS is the number of "Secret" create requests to send
// per second. Requests may be throttled by kube-apiserver.
// Default rate limits from kube-apiserver are:
// FLAG: --max-mutating-requests-inflight="200"
// FLAG: --max-requests-inflight="400"
SecretQPS uint `json:"secret-qps"`
// SecretBurst is the number of "Secret" create requests that
// a client can make in excess of the rate specified by the limiter.
// Requests may be throttled by kube-apiserver.
// Default rate limits from kube-apiserver are:
// FLAG: --max-mutating-requests-inflight="200"
// FLAG: --max-requests-inflight="400"
SecretBurst uint `json:"secret-burst"`
// CreatedSecretNames is the list of created "Secret" object names.
CreatedSecretNames []string `json:"created-secret-names" read-only:"true"`
// PodQPS is the number of "Pod" create requests to send
// per second. Requests may be throttled by kube-apiserver.
// Default rate limits from kube-apiserver are:
// FLAG: --max-mutating-requests-inflight="200"
// FLAG: --max-requests-inflight="400"
PodQPS uint `json:"pod-qps"`
// PodBurst is the number of "Pod" create requests that
// a client can make in excess of the rate specified by the limiter.
// Requests may be throttled by kube-apiserver.
// Default rate limits from kube-apiserver are:
// FLAG: --max-mutating-requests-inflight="200"
// FLAG: --max-requests-inflight="400"
PodBurst uint `json:"pod-burst"`
// CreatedPodNames is the list of created "Pod" object names.
CreatedPodNames []string `json:"created-pod-names" read-only:"true"`
// WritesResultPath is the CSV file path to output Secret writes test results.
WritesResultPath string `json:"writes-result-path"`
// ReadsResultPath is the CSV file path to output Secret reads test results.
ReadsResultPath string `json:"reads-result-path"`
}
// AddOnIRSA defines parameters for EKS cluster
// add-on "IAM Roles for Service Accounts (IRSA)".
type AddOnIRSA struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// Namespace is the namespace to create "Secret" and "Pod" objects in.
Namespace string `json:"namespace"`
// RoleName is the role name for IRSA.
RoleName string `json:"role-name"`
// RoleCFNStackID is the CloudFormation stack ID for IRSA.
RoleCFNStackID string `json:"role-cfn-stack-id"`
// RoleARN is the role ARN for IRSA.
RoleARN string `json:"role-arn"`
// RoleManagedPolicyARNs is IRSA role managed policy ARNs.
// ref. https://aws.amazon.com/blogs/opensource/introducing-fine-grained-iam-roles-service-accounts/
RoleManagedPolicyARNs []string `json:"role-managed-policy-arns,omitempty"`
// ServiceAccountName is the ServiceAccount name.
ServiceAccountName string `json:"service-account-name"`
// ConfigMapName is the ConfigMap name.
ConfigMapName string `json:"config-map-name"`
// ConfigMapScriptFileName is the ConfigMap script name.
ConfigMapScriptFileName string `json:"config-map-script-file-name"`
// S3BucketName is the S3 bucket for IRSA tests.
S3BucketName string `json:"s3-bucket-name"`
// S3Key is the S3 key to write for IRSA tests.
S3Key string `json:"s3-key"`
// DeploymentName is the Deployment name.
DeploymentName string `json:"deployment-name"`
// DeploymentReplicas is the number of Deployment replicas.
DeploymentReplicas int32 `json:"deployment-replicas"`
// DeploymentResultPath is the output of "Deployment" run.
DeploymentResultPath string `json:"deployment-result-path"`
// DeploymentTook is the duration that took for Deployment resource.
DeploymentTook time.Duration `json:"deployment-took,omitempty" read-only:"true"`
// DeploymentTookString is the duration that took for Deployment resource.
DeploymentTookString string `json:"deployment-took-string,omitempty" read-only:"true"`
}
// AddOnFargate defines parameters for EKS cluster
// add-on "EKS on Fargate".
type AddOnFargate struct {
// Enable is 'true' to create this add-on.
Enable bool `json:"enable"`
// Created is true when the resource has been created.
// Used for delete operations.
Created bool `json:"created" read-only:"true"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// Namespace is the namespace to create "Secret" and "Pod" objects in.
Namespace string `json:"namespace"`
// RoleName is the role name for Fargate.
RoleName string `json:"role-name"`
// RoleCFNStackID is the CloudFormation stack ID for Fargate.
RoleCFNStackID string `json:"role-cfn-stack-id"`
// RoleARN is the role ARN for Fargate.
RoleARN string `json:"role-arn"`
// RoleServicePrincipals is the Fargate role Service Principals
RoleServicePrincipals []string `json:"role-service-principals,omitempty"`
// RoleManagedPolicyARNs is Fargate role managed policy ARNs.
RoleManagedPolicyARNs []string `json:"role-managed-policy-arns,omitempty"`
// ProfileName is the profile name for Fargate.
ProfileName string `json:"profile-name"`
// SecretName is the secret name for Fargate.
SecretName string `json:"secret-name"`
// PodName is the name of the Fargate Pod.
PodName string `json:"pod-name"`
// ContainerName is the name of the Fargate container.
ContainerName string `json:"container-name"`
}
// Status represents the current status of AWS resources.
// Read-only. Cannot be configured via environmental variables.
type Status struct {
// Up is true if the cluster is up.
Up bool `json:"up"`
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// AWSAccountID is the account ID of the eks tester caller session.
AWSAccountID string `json:"aws-account-id"`
// AWSUserID is the user ID of the eks tester caller session.
AWSUserID string `json:"aws-user-id"`
// AWSIAMRoleARN is the user IAM Role ARN of the eks tester caller session.
AWSIAMRoleARN string `json:"aws-iam-role-arn"`
// AWSCredentialPath is automatically set via AWS SDK Go.
// And to be mounted as a volume as 'Secret' object.
AWSCredentialPath string `json:"aws-credential-path"`
ClusterRoleCFNStackID string `json:"cluster-role-cfn-stack-id"`
ClusterRoleARN string `json:"cluster-role-arn"`
ClusterRoleName string `json:"cluster-role-name"`
VPCCFNStackID string `json:"vpc-cfn-stack-id"`
VPCID string `json:"vpc-id"`
// PublicSubnetIDs is the list of all public subnets in the VPC.
PublicSubnetIDs []string `json:"public-subnet-ids"`
// PrivateSubnetIDs is the list of all private subnets in the VPC.
PrivateSubnetIDs []string `json:"private-subnet-ids"`
// ControlPlaneSecurityGroupID is the security group ID for the cluster control
// plane communication with worker nodes.
ControlPlaneSecurityGroupID string `json:"control-plane-security-group-id"`
ClusterCFNStackID string `json:"cluster-cfn-stack-id"`
ClusterARN string `json:"cluster-arn"`
// ClusterAPIServerEndpoint is the cluster endpoint of the EKS cluster,
// required for KUBECONFIG write.
ClusterAPIServerEndpoint string `json:"cluster-api-server-endpoint"`
// ClusterOIDCIssuerURL is the issuer URL for the OpenID Connect
// (https://openid.net/connect/) identity provider .
ClusterOIDCIssuerURL string `json:"cluster-oidc-issuer-url"`
// ClusterOIDCIssuerHostPath is the issuer host path.
ClusterOIDCIssuerHostPath string `json:"cluster-oidc-issuer-host-path"`
// ClusterOIDCIssuerARN is the issuer ARN for the OpenID Connect
// (https://openid.net/connect/) identity provider .
ClusterOIDCIssuerARN string `json:"cluster-oidc-issuer-arn"`
// ClusterOIDCIssuerCAThumbprint is the issuer CA thumbprint.
ClusterOIDCIssuerCAThumbprint string `json:"cluster-oidc-issuer-ca-thumbprint"`
// ClusterCA is the EKS cluster CA, required for KUBECONFIG write.
ClusterCA string `json:"cluster-ca"`
// ClusterCADecoded is the decoded EKS cluster CA, required for k8s.io/client-go.
ClusterCADecoded string `json:"cluster-ca-decoded"`
// ClusterStatus represents the current status of the cluster.
ClusterStatus string `json:"cluster-status"`
}
// StatusManagedNodeGroups represents the status of EKS "Managed Node Group".
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
type StatusManagedNodeGroups struct {
// CreateTook is the duration that took to create the resource.
CreateTook time.Duration `json:"create-took,omitempty" read-only:"true"`
// CreateTookString is the duration that took to create the resource.
CreateTookString string `json:"create-took-string,omitempty" read-only:"true"`
// DeleteTook is the duration that took to create the resource.
DeleteTook time.Duration `json:"delete-took,omitempty" read-only:"true"`
// DeleteTookString is the duration that took to create the resource.
DeleteTookString string `json:"delete-took-string,omitempty" read-only:"true"`
// RoleCFNStackID is the CloudFormation stack ID for a managed node group role.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
RoleCFNStackID string `json:"role-cfn-stack-id"`
// NvidiaDriverInstalled is true if nvidia driver has been installed.
NvidiaDriverInstalled bool `json:"nvidia-driver-installed"`
// Nodes maps from EKS "Managed Node Group" name to its status.
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
Nodes map[string]StatusManagedNodeGroup `json:"nodes"`
}
// StatusManagedNodeGroup represents the status of EKS "Managed Node Group".
// ref. https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html
// ref. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
type StatusManagedNodeGroup struct {
// CreateRequested is true if "CreateNodegroupRequest" has been sent.
CreateRequested bool `json:"create-requested"`
// CFNStackID is the CloudFormation stack ID for a managed node group.
CFNStackID string `json:"cfn-stack-id"`
RemoteAccessSecurityGroupID string `json:"remote-access-security-group-id"`
// PhysicalID is the Physical ID for the created "AWS::EKS::Nodegroup".
PhysicalID string `json:"physical-id"`
// Status is the current status of EKS "Managed Node Group".
Status string `json:"status"`
// Instances maps an instance ID to an EC2 instance object for the node group.
Instances map[string]ec2config.Instance `json:"instances"`
// Logs maps each instance ID to a list of log file paths fetched via SSH access.
Logs map[string][]string `json:"logs"`
}
// Load loads configuration from YAML.
// Useful when injecting shared configuration via ConfigMap.
//
// Example usage:
//
// import "github.com/aws/aws-k8s-tester/eksconfig"
// cfg := eksconfig.Load("test.yaml")
// err := cfg.ValidateAndSetDefaults()
//
// Do not set default values in this function.
// "ValidateAndSetDefaults" must be called separately,
// to prevent overwriting previous data when loaded from disks.
func Load(p string) (cfg *Config, err error) {
var d []byte
d, err = ioutil.ReadFile(p)
if err != nil {
return nil, err
}
cfg = new(Config)
if err = yaml.Unmarshal(d, cfg); err != nil {
return nil, err
}
if cfg.ConfigPath != p {
cfg.ConfigPath = p
}
var ap string
ap, err = filepath.Abs(p)
if err != nil {
return nil, err
}
cfg.ConfigPath = ap
cfg.Sync()
return cfg, nil
}
// Sync persists current configuration and states to disk.
func (cfg *Config) Sync() (err error) {
var p string
if cfg.ConfigPath != "" && !filepath.IsAbs(cfg.ConfigPath) {
p, err = filepath.Abs(cfg.ConfigPath)
if err != nil {
return fmt.Errorf("failed to 'filepath.Abs(%s)' %v", cfg.ConfigPath, err)
}
cfg.ConfigPath = p
}
if cfg.KubeConfigPath != "" && !filepath.IsAbs(cfg.KubeConfigPath) {
p, err = filepath.Abs(cfg.KubeConfigPath)
if err != nil {
return fmt.Errorf("failed to 'filepath.Abs(%s)' %v", cfg.KubeConfigPath, err)
}
cfg.KubeConfigPath = p
}
var d []byte
d, err = yaml.Marshal(cfg)
if err != nil {
return fmt.Errorf("failed to 'yaml.Marshal' %v", err)
}
err = ioutil.WriteFile(cfg.ConfigPath, d, 0600)
if err != nil {
return fmt.Errorf("failed to write file %q (%v)", cfg.ConfigPath, err)
}
err = ioutil.WriteFile(cfg.KubectlCommandsOutputPath, []byte(cmdTop+cfg.KubectlCommands()), 0600)
if err != nil {
return fmt.Errorf("failed to write file %q (%v)", cfg.KubectlCommandsOutputPath, err)
}
err = ioutil.WriteFile(cfg.SSHCommandsOutputPath, []byte(cmdTop+cfg.SSHCommands()), 0600)
if err != nil {
return fmt.Errorf("failed to write file %q (%v)", cfg.SSHCommandsOutputPath, err)
}
return err
}
const cmdTop = `#!/bin/bash
set -e
set -x
`
// KubectlCommand returns the kubectl command.
func (cfg *Config) KubectlCommand() string {
return fmt.Sprintf("%s --kubeconfig=%s", cfg.KubectlPath, cfg.KubeConfigPath)
}
// KubectlCommands returns the various kubectl commands.
func (cfg *Config) KubectlCommands() (s string) {
if cfg.KubeConfigPath == "" {
return ""
}
tpl := template.Must(template.New("kubectlCmdTmpl").Parse(kubectlCmdTmpl))
buf := bytes.NewBuffer(nil)
if err := tpl.Execute(buf, struct {
KubectlPath string
KubeConfigPath string
KubectlCmd string
Version string
}{
cfg.KubectlPath,
cfg.KubeConfigPath,
fmt.Sprintf("%s --kubeconfig=%s", cfg.KubectlPath, cfg.KubeConfigPath),
cfg.Parameters.Version,
}); err != nil {
return ""
}
return buf.String()
}
const kubectlCmdTmpl = `
# kubectl commands
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} version
${KUBECTL} cluster-info
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} get cs
${KUBECTL} get nodes
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} --namespace=kube-system get pods
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} get pods
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} --namespace=kube-system get ds
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} get secrets --all-namespaces
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} get configmap --all-namespaces
export KUBECONFIG={{ .KubeConfigPath }}
export KUBECTL="{{ .KubectlCmd }}"
${KUBECTL} get all --all-namespaces
# sonobuoy commands
go get -v -u github.com/heptio/sonobuoy
sonobuoy delete --wait --kubeconfig={{ .KubeConfigPath }}
sonobuoy run \
--mode Quick \
--wait \
--kube-conformance-image gcr.io/heptio-images/kube-conformance:v{{ .Version }}.0 \
--kubeconfig={{ .KubeConfigPath }}
sonobuoy delete --wait --kubeconfig={{ .KubeConfigPath }}
sonobuoy run \
--wait \
--kube-conformance-image gcr.io/heptio-images/kube-conformance:v{{ .Version }}.0 \
--kubeconfig={{ .KubeConfigPath }}
sonobuoy status --kubeconfig={{ .KubeConfigPath }}
results=$(sonobuoy retrieve --kubeconfig={{ .KubeConfigPath }})
sonobuoy e2e --kubeconfig={{ .KubeConfigPath }} $results --show all
sonobuoy e2e --kubeconfig={{ .KubeConfigPath }} $results
`
// SSHCommands returns the SSH commands.
func (cfg *Config) SSHCommands() (s string) {
if cfg.StatusManagedNodeGroups == nil {
return ""
}
if len(cfg.StatusManagedNodeGroups.Nodes) == 0 {
return ""
}
buf := bytes.NewBuffer(nil)
for name, ng := range cfg.StatusManagedNodeGroups.Nodes {
buf.WriteString("ASG name \"" + name + "\":\n")
ec := &ec2config.Config{
UserName: cfg.AddOnManagedNodeGroups.RemoteAccessUserName,
KeyPath: cfg.AddOnManagedNodeGroups.RemoteAccessPrivateKeyPath,
Instances: ng.Instances,
}
buf.WriteString(ec.SSHCommands())
buf.WriteString("\n")
}
return buf.String()
}