-
Notifications
You must be signed in to change notification settings - Fork 3
/
ecs_pod_creator.go
1777 lines (1506 loc) · 58.9 KB
/
ecs_pod_creator.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
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package cocoa
import (
"context"
"sort"
"strconv"
"github.com/pkg/errors"
"github.com/aws/aws-sdk-go-v2/service/ecs/types"
"github.com/evergreen-ci/utility"
"github.com/mongodb/grip"
)
// ECSPodCreator provides a means to create a new pod backed by AWS ECS.
type ECSPodCreator interface {
// CreatePod creates a new pod backed by ECS with the given options. Options
// are applied in the order they're specified and conflicting options are
// overwritten.
CreatePod(ctx context.Context, opts ...ECSPodCreationOptions) (ECSPod, error)
// CreatePodFromExistingDefinition creates a new pod backed by ECS from an
// existing task definition.
CreatePodFromExistingDefinition(ctx context.Context, def ECSTaskDefinition, opts ...ECSPodExecutionOptions) (ECSPod, error)
}
// ECSPodCreationOptions provide options to create a pod backed by ECS.
type ECSPodCreationOptions struct {
// DefinitionOpts specify options to configure the pod's definition.
DefinitionOpts ECSPodDefinitionOptions
// ExecutionOpts specify options to configure how the pod executes.
ExecutionOpts *ECSPodExecutionOptions
}
// NewECSPodCreationOptions returns new uninitialized options to create a pod.
func NewECSPodCreationOptions() *ECSPodCreationOptions {
return &ECSPodCreationOptions{}
}
// SetDefinitionOptions sets the options to configure the pod definition.
func (o *ECSPodCreationOptions) SetDefinitionOptions(opts ECSPodDefinitionOptions) *ECSPodCreationOptions {
o.DefinitionOpts = opts
return o
}
// SetExecutionOptions sets the options to configure how the pod executes.
func (o *ECSPodCreationOptions) SetExecutionOptions(opts ECSPodExecutionOptions) *ECSPodCreationOptions {
o.ExecutionOpts = &opts
return o
}
// Validate checks that all the required parameters are given and the values are
// valid. It sets defaults where possible.
func (o *ECSPodCreationOptions) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.Wrap(o.DefinitionOpts.Validate(), "invalid pod definition options")
networkMode := o.DefinitionOpts.getNetworkMode()
catcher.NewWhen(networkMode == NetworkModeAWSVPC && (o.ExecutionOpts == nil || o.ExecutionOpts.AWSVPCOpts == nil), "must specify AWSVPC configuration when using AWSVPC network mode")
catcher.NewWhen(networkMode != NetworkModeAWSVPC && o.ExecutionOpts != nil && o.ExecutionOpts.AWSVPCOpts != nil, "cannot specify AWSVPC configuration when network mode is not AWSVPC")
if o.ExecutionOpts != nil {
catcher.Wrap(o.ExecutionOpts.Validate(), "invalid execution options")
}
if catcher.HasErrors() {
return catcher.Resolve()
}
if o.ExecutionOpts == nil {
placementOpts := NewECSPodPlacementOptions().SetStrategy(StrategyBinpack).SetStrategyParameter(StrategyParamBinpackMemory)
o.ExecutionOpts = NewECSPodExecutionOptions().SetPlacementOptions(*placementOpts)
}
return nil
}
// MergeECSPodCreationOptions merges all the given options to create an ECS pod.
// Options are applied in the order that they're specified and conflicting
// options are overwritten.
func MergeECSPodCreationOptions(opts ...ECSPodCreationOptions) ECSPodCreationOptions {
merged := ECSPodCreationOptions{}
for _, opt := range opts {
merged.DefinitionOpts = MergeECSPodDefinitionOptions(merged.DefinitionOpts, opt.DefinitionOpts)
if opt.ExecutionOpts != nil {
var execOpts ECSPodExecutionOptions
if merged.ExecutionOpts != nil {
execOpts = MergeECSPodExecutionOptions(*merged.ExecutionOpts, *opt.ExecutionOpts)
} else {
execOpts = *opt.ExecutionOpts
}
merged.ExecutionOpts = &execOpts
}
}
return merged
}
// ECSPodDefinitionOptions represent options to configure a template for running
// a pod.
type ECSPodDefinitionOptions struct {
// Name is the friendly name of the pod. By default, this is a random
// string.
Name *string
// ContainerDefinitions defines settings that apply to individual containers
// within the pod. This is required.
ContainerDefinitions []ECSContainerDefinition
// MemoryMB is the hard memory limit (in MB) across all containers in the
// pod. If this is not specified, then each container is required to specify
// its own memory. This is ignored for pods running Windows containers.
MemoryMB *int
// CPU is the hard CPU limit (in CPU units) across all containers in the
// pod. 1024 CPU units is equivalent to 1 vCPU on a machine. If this is not
// specified, then each container is required to specify its own CPU.
// This is ignored for pods running Windows containers.
CPU *int
// NetworkMode describes the networking capabilities of the pod's
// containers. If the NetworkMode is unspecified for a pod running Linux
// containers, the default value is NetworkModeBridge. If the NetworkMode is
// unspecified for a pod running Windows containers, the default network
// mode is to use the Windows NAT network.
NetworkMode *ECSNetworkMode
// TaskRole is the role that the pod can use. Depending on the
// configuration, this may be required if
// (ECSPodExecutionOptions).SupportsDebugMode is true.
TaskRole *string
// ExecutionRole is the role that ECS container agent can use. Depending on
// the configuration, this may be required if the container uses secrets.
ExecutionRole *string
// Tags are resource tags to apply to the pod definition.
Tags map[string]string
}
// NewECSPodDefinitionOptions returns new uninitialized options to create a pod
// definition.
func NewECSPodDefinitionOptions() *ECSPodDefinitionOptions {
return &ECSPodDefinitionOptions{}
}
// SetName sets the friendly name of the pod.
func (o *ECSPodDefinitionOptions) SetName(name string) *ECSPodDefinitionOptions {
o.Name = &name
return o
}
// SetContainerDefinitions sets the container definitions for the pod. This
// overwrites any existing container definitions.
func (o *ECSPodDefinitionOptions) SetContainerDefinitions(defs []ECSContainerDefinition) *ECSPodDefinitionOptions {
o.ContainerDefinitions = defs
return o
}
// AddContainerDefinitions add new container definitions to the existing ones
// for the pod.
func (o *ECSPodDefinitionOptions) AddContainerDefinitions(defs ...ECSContainerDefinition) *ECSPodDefinitionOptions {
o.ContainerDefinitions = append(o.ContainerDefinitions, defs...)
return o
}
// SetMemoryMB sets the memory limit (in MB) that applies across the entire
// pod's containers.
func (o *ECSPodDefinitionOptions) SetMemoryMB(mem int) *ECSPodDefinitionOptions {
o.MemoryMB = &mem
return o
}
// SetCPU sets the CPU limit (in CPU units) that applies across the entire pod's
// containers.
func (o *ECSPodDefinitionOptions) SetCPU(cpu int) *ECSPodDefinitionOptions {
o.CPU = &cpu
return o
}
// SetTaskRole sets the task role that the pod can use.
func (o *ECSPodDefinitionOptions) SetTaskRole(role string) *ECSPodDefinitionOptions {
o.TaskRole = &role
return o
}
// SetExecutionRole sets the execution role that the pod can use.
func (o *ECSPodDefinitionOptions) SetExecutionRole(role string) *ECSPodDefinitionOptions {
o.ExecutionRole = &role
return o
}
// SetNetworkMode sets the network mode that applies for all the pod's
// containers.
func (o *ECSPodDefinitionOptions) SetNetworkMode(mode ECSNetworkMode) *ECSPodDefinitionOptions {
o.NetworkMode = &mode
return o
}
// SetTags sets the tags for the pod definition. This overwrites any existing
// tags.
func (o *ECSPodDefinitionOptions) SetTags(tags map[string]string) *ECSPodDefinitionOptions {
o.Tags = tags
return o
}
// AddTags adds new tags to the existing ones for the pod definition.
func (o *ECSPodDefinitionOptions) AddTags(tags map[string]string) *ECSPodDefinitionOptions {
if o.Tags == nil {
o.Tags = map[string]string{}
}
for k, v := range tags {
o.Tags[k] = v
}
return o
}
// getNetworkMode returns the network mode. If no network mode is explicitly
// set, this returns the default network mode.
func (o *ECSPodDefinitionOptions) getNetworkMode() ECSNetworkMode {
if o.NetworkMode != nil {
return *o.NetworkMode
}
return NetworkModeBridge
}
// Validate checks that all the required parameters are given and the values are
// valid. It sets default values where possible.
func (o *ECSPodDefinitionOptions) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(o.Name != nil && *o.Name == "", "cannot specify an empty name")
catcher.NewWhen(o.MemoryMB != nil && *o.MemoryMB <= 0, "must have positive memory value if non-default")
catcher.NewWhen(o.CPU != nil && *o.CPU <= 0, "must have positive CPU value if non-default")
catcher.Wrap(o.validateContainerDefinitions(), "invalid container definitions")
networkMode := o.getNetworkMode()
catcher.Wrap(networkMode.Validate(), "invalid network mode")
if o.Name == nil {
o.Name = utility.ToStringPtr(utility.RandomString())
}
return catcher.Resolve()
}
// validateContainerDefinitions checks that all the individual container
// definitions are valid.
func (o *ECSPodDefinitionOptions) validateContainerDefinitions() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(len(o.ContainerDefinitions) == 0, "must specify at least one container definition")
networkMode := o.getNetworkMode()
var totalContainerMemMB, totalContainerCPU int
for i, def := range o.ContainerDefinitions {
catcher.Wrapf(o.ContainerDefinitions[i].Validate(), "container definition '%s'", utility.FromStringPtr(def.Name))
switch networkMode {
case NetworkModeNone:
catcher.NewWhen(len(def.PortMappings) != 0, "cannot specify port mappings because networking is disabled")
case NetworkModeHost, NetworkModeAWSVPC:
for _, pm := range def.PortMappings {
containerPort := utility.FromIntPtr(pm.ContainerPort)
if pm.HostPort != nil {
hostPort := utility.FromIntPtr(pm.HostPort)
catcher.ErrorfWhen(hostPort != containerPort,
"host port '%d' must be omitted or identical to the container port '%d' when network mode is '%s'", hostPort, containerPort, networkMode)
}
}
}
if def.MemoryMB != nil {
totalContainerMemMB += *def.MemoryMB
} else if o.MemoryMB == nil {
catcher.Errorf("must specify container-level memory to allocate for each container if pod-level memory is not specified")
}
if o.ContainerDefinitions[i].CPU != nil {
totalContainerCPU += *o.ContainerDefinitions[i].CPU
} else if o.CPU == nil {
catcher.Errorf("must specify container-level CPU to allocate for each container if pod-level CPU is not specified")
}
}
if o.MemoryMB != nil {
catcher.ErrorfWhen(*o.MemoryMB < totalContainerMemMB, "total memory requested for the individual containers (%d MB) is greater than the memory available for the entire task (%d MB)", totalContainerMemMB, *o.MemoryMB)
}
if o.CPU != nil {
catcher.ErrorfWhen(*o.CPU < totalContainerCPU, "total CPU requested for the individual containers (%d units) is greater than the memory available for the entire task (%d units)", totalContainerCPU, *o.CPU)
}
return catcher.Resolve()
}
// pair represents a key and value pair.
type pair struct {
key string
value string
}
// hash returns the hash digest of the tag pair.
func (tp pair) hash() string {
h := utility.NewSHA1Hash()
h.Add(tp.key)
h.Add(tp.value)
return h.Sum()
}
// hashablePairs represents a slice of key-value pairs that can be hashed.
type hashablePairs []pair
// newHashablePairs returns a sorted slice of hashable key value pairs.
func newHashablePairs(tags map[string]string) hashablePairs {
var htp hashablePairs
for k, v := range tags {
htp = append(htp, pair{key: k, value: v})
}
sort.Sort(htp)
return htp
}
// Len returns the number of container definitions.
func (htp hashablePairs) Len() int {
return len(htp)
}
// Less returns whether or not the key for the pair at index i is
// lexicographically before the key for the pair at index j.
func (htp hashablePairs) Less(i, j int) bool {
return htp[i].key < htp[j].key
}
// Swap swaps the tag pairs at indexes i and j.
func (htp hashablePairs) Swap(i, j int) {
htp[i], htp[j] = htp[j], htp[i]
}
// hash returns the hash digest of the tag pairs.
func (htp hashablePairs) hash() string {
if !sort.IsSorted(htp) {
sort.Sort(htp)
}
h := utility.NewSHA1Hash()
for _, tp := range htp {
h.Add(tp.hash())
}
return h.Sum()
}
// Hash returns the hash digest of the pod definition.
func (o *ECSPodDefinitionOptions) Hash() string {
h := utility.NewSHA1Hash()
if o.Name != nil {
h.Add(utility.FromStringPtr(o.Name))
}
if len(o.ContainerDefinitions) != 0 {
h.Add(newHashableContainerDefinitions(o.ContainerDefinitions).hash())
}
if o.MemoryMB != nil {
h.Add(strconv.Itoa(utility.FromIntPtr(o.MemoryMB)))
}
if o.CPU != nil {
h.Add(strconv.Itoa(utility.FromIntPtr(o.CPU)))
}
if o.NetworkMode != nil {
h.Add(string(*o.NetworkMode))
}
if o.TaskRole != nil {
h.Add(utility.FromStringPtr(o.TaskRole))
}
if o.ExecutionRole != nil {
h.Add(utility.FromStringPtr(o.ExecutionRole))
}
if len(o.Tags) != 0 {
h.Add(newHashablePairs(o.Tags).hash())
}
return h.Sum()
}
// MergeECSPodDefinitionOptions merges all the given options to create an ECS
// pod definition. Options are applied in the order that they're specified and
// conflicting options are overwritten.
func MergeECSPodDefinitionOptions(opts ...ECSPodDefinitionOptions) ECSPodDefinitionOptions {
merged := ECSPodDefinitionOptions{}
for _, opt := range opts {
if opt.Name != nil {
merged.Name = opt.Name
}
if opt.ContainerDefinitions != nil {
merged.ContainerDefinitions = opt.ContainerDefinitions
}
if opt.MemoryMB != nil {
merged.MemoryMB = opt.MemoryMB
}
if opt.CPU != nil {
merged.CPU = opt.CPU
}
if opt.NetworkMode != nil {
merged.NetworkMode = opt.NetworkMode
}
if opt.TaskRole != nil {
merged.TaskRole = opt.TaskRole
}
if opt.ExecutionRole != nil {
merged.ExecutionRole = opt.ExecutionRole
}
if opt.Tags != nil {
merged.Tags = opt.Tags
}
}
return merged
}
// ECSContainerDefinition defines settings that apply to a single container
// within an ECS pod.
type ECSContainerDefinition struct {
// Name is the friendly name of the container. By default, this is a random
// string.
Name *string
// Image is the Docker image to use. This is required.
Image *string
// Command is the command to run, separated into individual arguments. By
// default, there is no command.
Command []string
// WorkingDir is the container working directory in which commands will be
// run.
WorkingDir *string
// MemoryMB is the amount of memory (in MB) to allocate. This must be set if
// a pod-level memory limit is not given.
MemoryMB *int
// CPU is the number of CPU units to allocate. 1024 CPU units is equivalent
// to 1 vCPU on a machine. This must be set if a pod-level CPU limit is not
// given.
CPU *int
// EnvVars are environment variables to make available in the container.
EnvVars []EnvironmentVariable
// RepoCreds are private repository credentials for using images that
// require authentication.
RepoCreds *RepositoryCredentials
// PortMappings are mappings between the ports within the container to
// allow network traffic.
PortMappings []PortMapping
// LogConfiguration is the configuration for logging the container's output.
LogConfiguration *LogConfiguration
}
// NewECSContainerDefinition returns a new uninitialized container definition.
func NewECSContainerDefinition() *ECSContainerDefinition {
return &ECSContainerDefinition{}
}
// SetName sets the friendly name for the container.
func (d *ECSContainerDefinition) SetName(name string) *ECSContainerDefinition {
d.Name = &name
return d
}
// SetImage sets the image for the container.
func (d *ECSContainerDefinition) SetImage(img string) *ECSContainerDefinition {
d.Image = &img
return d
}
// SetCommand sets the command for the container to run.
func (d *ECSContainerDefinition) SetCommand(cmd []string) *ECSContainerDefinition {
d.Command = cmd
return d
}
// SetWorkingDir sets the working directory where the container's commands
// will run.
func (d *ECSContainerDefinition) SetWorkingDir(dir string) *ECSContainerDefinition {
d.WorkingDir = &dir
return d
}
// SetMemoryMB sets the amount of memory (in MB) to allocate.
func (d *ECSContainerDefinition) SetMemoryMB(mem int) *ECSContainerDefinition {
d.MemoryMB = &mem
return d
}
// SetCPU sets the number of CPU units to allocate.
func (d *ECSContainerDefinition) SetCPU(cpu int) *ECSContainerDefinition {
d.CPU = &cpu
return d
}
// SetEnvironmentVariables sets the environment variables for the container.
// This overwrites any existing environment variables.
func (d *ECSContainerDefinition) SetEnvironmentVariables(envVars []EnvironmentVariable) *ECSContainerDefinition {
d.EnvVars = envVars
return d
}
// AddEnvironmentVariables adds new environment variables to the existing ones
// for the container.
func (d *ECSContainerDefinition) AddEnvironmentVariables(envVars ...EnvironmentVariable) *ECSContainerDefinition {
d.EnvVars = append(d.EnvVars, envVars...)
return d
}
// SetRepositoryCredentials sets the private repository credentials for using
// images that require authentication.
func (d *ECSContainerDefinition) SetRepositoryCredentials(creds RepositoryCredentials) *ECSContainerDefinition {
d.RepoCreds = &creds
return d
}
// SetPortMappings sets the port mappings for the container. This overwrites any
// existing port mappings.
func (d *ECSContainerDefinition) SetPortMappings(mappings []PortMapping) *ECSContainerDefinition {
d.PortMappings = mappings
return d
}
// AddPortMappings adds new port mappings to the existing ones for the
// container.
func (d *ECSContainerDefinition) AddPortMappings(mappings ...PortMapping) *ECSContainerDefinition {
d.PortMappings = append(d.PortMappings, mappings...)
return d
}
// SetLogConfiguration sets the log configuration for the container.
func (d *ECSContainerDefinition) SetLogConfiguration(lc LogConfiguration) *ECSContainerDefinition {
d.LogConfiguration = &lc
return d
}
// Validate checks that the container definition is valid and sets defaults
// where possible.
func (d *ECSContainerDefinition) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(d.Image == nil, "must specify an image")
catcher.NewWhen(d.Image != nil && *d.Image == "", "cannot specify an empty image")
catcher.NewWhen(d.MemoryMB != nil && *d.MemoryMB <= 0, "must have positive memory value if non-default")
catcher.NewWhen(d.CPU != nil && *d.CPU <= 0, "must have positive CPU value if non-default")
for _, ev := range d.EnvVars {
catcher.Wrapf(ev.Validate(), "environment variable '%s'", utility.FromStringPtr(ev.Name))
}
if d.RepoCreds != nil {
catcher.Wrap(d.RepoCreds.Validate(), "invalid repository credentials")
}
if d.LogConfiguration != nil {
catcher.Wrap(d.LogConfiguration.Validate(), "invalid log configuration")
}
for _, pm := range d.PortMappings {
catcher.Wrapf(pm.Validate(), "invalid port mapping")
}
if catcher.HasErrors() {
return catcher.Resolve()
}
if d.Name == nil {
d.Name = utility.ToStringPtr(utility.RandomString())
}
return nil
}
// hash returns the hash digest of the container definition.
func (d *ECSContainerDefinition) hash() string {
h := utility.NewSHA1Hash()
if d.Name != nil {
h.Add(utility.FromStringPtr(d.Name))
}
if d.Image != nil {
h.Add(utility.FromStringPtr(d.Image))
}
if len(d.Command) != 0 {
for _, arg := range d.Command {
h.Add(arg)
}
}
if d.WorkingDir != nil {
h.Add(utility.FromStringPtr(d.WorkingDir))
}
if d.MemoryMB != nil {
h.Add(strconv.Itoa(utility.FromIntPtr(d.MemoryMB)))
}
if d.CPU != nil {
h.Add(strconv.Itoa(utility.FromIntPtr(d.CPU)))
}
if len(d.EnvVars) != 0 {
h.Add(newHashableEnvironmentVariables(d.EnvVars).hash())
}
if d.RepoCreds != nil {
h.Add(d.RepoCreds.hash())
}
if d.LogConfiguration != nil {
h.Add(d.LogConfiguration.hash())
}
if len(d.PortMappings) != 0 {
h.Add(newHashablePortMappings(d.PortMappings).hash())
}
return h.Sum()
}
// hashableECSContainerDefinitions represents a hashable slice of ECS container
// definitions ordered by container name.
type hashableECSContainerDefinitions []ECSContainerDefinition
func newHashableContainerDefinitions(containerDefs []ECSContainerDefinition) hashableECSContainerDefinitions {
hcd := hashableECSContainerDefinitions(containerDefs)
sort.Sort(hcd)
return hcd
}
// Len returns the number of container definitions.
func (hcd hashableECSContainerDefinitions) Len() int {
return len(hcd)
}
// Less returns whether or not the name of the container definition at index i
// is lexicographically before the name of the container definition at index j.
func (hcd hashableECSContainerDefinitions) Less(i, j int) bool {
return utility.FromStringPtr(hcd[i].Name) < utility.FromStringPtr(hcd[j].Name)
}
// Swap swaps the container definitions at indexes i and j.
func (hcd hashableECSContainerDefinitions) Swap(i, j int) {
hcd[i], hcd[j] = hcd[j], hcd[i]
}
// hash returns the hash digest of the container definitions.
func (hcd hashableECSContainerDefinitions) hash() string {
if !sort.IsSorted(hcd) {
sort.Sort(hcd)
}
h := utility.NewSHA1Hash()
for _, cd := range hcd {
h.Add(cd.hash())
}
return h.Sum()
}
// EnvironmentVariable represents an environment variable, which can be
// optionally backed by a secret.
type EnvironmentVariable struct {
// KeyValue represents the environment variable's name and plaintext value.
// The plaintext value is required if SecretOpts is not given.
KeyValue
// SecretOpts are options to define a stored secret that the environment
// variable refers to. This is required if the non-secret Value is not
// given.
SecretOpts *SecretOptions
}
// NewEnvironmentVariable returns a new uninitialized environment variable.
func NewEnvironmentVariable() *EnvironmentVariable {
return &EnvironmentVariable{}
}
// SetName sets the environment variable name.
func (e *EnvironmentVariable) SetName(name string) *EnvironmentVariable {
e.Name = &name
return e
}
// SetValue sets the environment variable's value. This is mutually exclusive
// with setting the (EnvironmentVariable).SecretOptions.
func (e *EnvironmentVariable) SetValue(val string) *EnvironmentVariable {
e.Value = &val
return e
}
// SetSecretOptions sets the environment variable's secret options. This is
// mutually exclusive with setting the non-secret (EnvironmentVariable).Value.
func (e *EnvironmentVariable) SetSecretOptions(opts SecretOptions) *EnvironmentVariable {
e.SecretOpts = &opts
return e
}
// Validate checks that the environment variable name is given and that either
// the raw environment variable value or the referenced secret is given.
func (e *EnvironmentVariable) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.Add(e.KeyValue.Validate())
catcher.NewWhen(e.Value == nil && e.SecretOpts == nil, "must either specify a value or reference a secret")
catcher.NewWhen(e.Value != nil && e.SecretOpts != nil, "cannot both specify a value and reference a secret")
if e.SecretOpts != nil {
catcher.Wrap(e.SecretOpts.Validate(), "invalid secret options")
}
return catcher.Resolve()
}
// hash is the hash digest of the environment variable.
func (e *EnvironmentVariable) hash() string {
h := utility.NewSHA1Hash()
if e.Name != nil {
h.Add(utility.FromStringPtr(e.Name))
}
if e.Value != nil {
h.Add(utility.FromStringPtr(e.Value))
}
if e.SecretOpts != nil {
h.Add(e.SecretOpts.hash())
}
return h.Sum()
}
// hashableEnvironmentVariables represents a slice of environment variables that
// can be hashed.
type hashableEnvironmentVariables []EnvironmentVariable
// newHashableEnvironmentVariables returns a sorted slice of hashable
// environment variables.
func newHashableEnvironmentVariables(ev []EnvironmentVariable) hashableEnvironmentVariables {
hev := hashableEnvironmentVariables(ev)
sort.Sort(hev)
return hev
}
// Len returns the number of environment variables.
func (hev hashableEnvironmentVariables) Len() int {
return len(hev)
}
// Less returns whether or not the name of the environment variable at index i
// is lexicographically before the name of the environment variable at index j.
func (hev hashableEnvironmentVariables) Less(i, j int) bool {
return utility.FromStringPtr(hev[i].Name) < utility.FromStringPtr(hev[j].Name)
}
// Swap swaps the environment variables at indexes i and j.
func (hev hashableEnvironmentVariables) Swap(i, j int) {
hev[i], hev[j] = hev[j], hev[i]
}
// hash returns the hash digest of the environment variables.
func (hev hashableEnvironmentVariables) hash() string {
if !sort.IsSorted(hev) {
sort.Sort(hev)
}
h := utility.NewSHA1Hash()
for _, ev := range hev {
h.Add(ev.hash())
}
return h.Sum()
}
// KeyValue represents a key-value pair of strings.
type KeyValue struct {
// Name is the name of the key-value pair.
Name *string
// Value is the plaintext value associated with the name.
Value *string
}
// NewKeyValue returns a new uninitialized key-value pair.
func NewKeyValue() *KeyValue {
return &KeyValue{}
}
// SetName sets the name of the key.
func (kv *KeyValue) SetName(name string) *KeyValue {
kv.Name = &name
return kv
}
// SetValue sets the value associated with the key.
func (kv *KeyValue) SetValue(value string) *KeyValue {
kv.Value = &value
return kv
}
// Validate checks that the key name is set.
func (kv *KeyValue) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(kv.Name == nil, "must specify a name")
catcher.NewWhen(kv.Name != nil && *kv.Name == "", "cannot specify an empty name")
return catcher.Resolve()
}
// SecretOptions represents a secret with a name and value that may or may not
// be owned by its container.
type SecretOptions struct {
// ID is the unique resource identfier for an existing secret.
ID *string
// Name is the friendly name of the secret.
Name *string
// NewValue is the value of the secret if it must be created.
NewValue *string
// Owned determines whether or not the secret is owned by its container or
// not.
Owned *bool
}
// NewSecretOptions returns new uninitialized options for a secret.
func NewSecretOptions() *SecretOptions {
return &SecretOptions{}
}
// SetID sets the unique resource identifier for an existing secret.
func (s *SecretOptions) SetID(id string) *SecretOptions {
s.ID = &id
return s
}
// SetName sets the friendly name of the secret.
func (s *SecretOptions) SetName(name string) *SecretOptions {
s.Name = &name
return s
}
// SetNewValue sets the value of the new secret to be created.
func (s *SecretOptions) SetNewValue(val string) *SecretOptions {
s.NewValue = &val
return s
}
// SetOwned returns whether or not the secret is owned by its container.
func (s *SecretOptions) SetOwned(owned bool) *SecretOptions {
s.Owned = &owned
return s
}
// Validate validates that the secret name is given and that either the secret
// already exists or the new secret's value is given.
func (s *SecretOptions) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(s.ID == nil && s.NewValue == nil, "must specify either an existing secret ID or a new secret to be created")
catcher.NewWhen(s.ID != nil && s.NewValue != nil, "cannot specify both an existing secret ID and a new secret to be created")
catcher.NewWhen(s.NewValue != nil && s.Name == nil, "cannot specify a new secret to be created without a name")
catcher.NewWhen(s.ID != nil && utility.FromStringPtr(s.ID) == "", "cannot specify an empty secret ID")
return catcher.Resolve()
}
// hash returns the hash digest of the secret options.
func (s *SecretOptions) hash() string {
h := utility.NewSHA1Hash()
if s.ID != nil {
h.Add(utility.FromStringPtr(s.ID))
}
if s.Name != nil {
h.Add(utility.FromStringPtr(s.Name))
}
if s.NewValue != nil {
h.Add(utility.FromStringPtr(s.NewValue))
}
if s.Owned != nil {
h.Add(strconv.FormatBool(utility.FromBoolPtr(s.Owned)))
}
return h.Sum()
}
// LogConfiguration represents the configuration for a container's logging.
type LogConfiguration struct {
// LogDriver is the logging driver to use.
LogDriver *string
// Options are the logging driver options.
Options map[string]string
}
// NewLogConfiguration returns a new uninitialized log configuration.
func NewLogConfiguration() *LogConfiguration {
return &LogConfiguration{}
}
// SetLogDriver sets the logging driver to use.
func (c *LogConfiguration) SetLogDriver(ld string) *LogConfiguration {
c.LogDriver = &ld
return c
}
// SetOptions sets the logging driver options.
func (c *LogConfiguration) SetOptions(o map[string]string) *LogConfiguration {
c.Options = o
return c
}
// Validate checks that the log driver as well as required groups "awslogs-group" and "awslogs-region" are both set.
func (c *LogConfiguration) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(c.LogDriver == nil, "must specify a log driver")
catcher.NewWhen(c.Options == nil, "must specify log driver options")
if c.Options != nil {
catcher.NewWhen(c.Options["awslogs-group"] == "", "must specify awslogs-group in options")
catcher.NewWhen(c.Options["awslogs-region"] == "", "must specify awslogs-region in options")
}
return catcher.Resolve()
}
// hash returns the hash digest of the log configuration.
func (c *LogConfiguration) hash() string {
h := utility.NewSHA1Hash()
if c.LogDriver != nil {
h.Add(utility.FromStringPtr(c.LogDriver))
}
if c.Options != nil {
h.Add(newHashablePairs(c.Options).hash())
}
return h.Sum()
}
// RepositoryCredentials are credentials for using images from private
// repositories. The credentials must be stored in a secret vault.
type RepositoryCredentials struct {
// ID is the unique resource identifier for an existing secret containing
// the credentials for a private repository.
ID *string
// Name is the friendly name of the secret containing the credentials
// for a private repository.
Name *string
// NewCreds are the new credentials to be stored. If this is unspecified,
// the secrets are assumed to already exist.
NewCreds *StoredRepositoryCredentials
// Owned determines whether or not the secret is owned by its pod or not.
Owned *bool
}
// NewRepositoryCredentials returns a new uninitialized set of repository
// credentials.
func NewRepositoryCredentials() *RepositoryCredentials {
return &RepositoryCredentials{}
}
// SetID sets the unique resource identifier for an existing secret.
func (c *RepositoryCredentials) SetID(id string) *RepositoryCredentials {
c.ID = &id
return c
}
// SetName sets the friendly name of the secret containing the credentials.
func (c *RepositoryCredentials) SetName(name string) *RepositoryCredentials {
c.Name = &name
return c
}
// SetNewCredentials sets the new credentials to be stored.
func (c *RepositoryCredentials) SetNewCredentials(creds StoredRepositoryCredentials) *RepositoryCredentials {
c.NewCreds = &creds
return c
}
// SetOwned sets whether or not the secret credentials are owned by its pod or
// not.
func (c *RepositoryCredentials) SetOwned(owned bool) *RepositoryCredentials {
c.Owned = &owned
return c
}
// Validate check that the secret options are given and that either the
// new credentials to create are specified, or the secret already exists.
func (c *RepositoryCredentials) Validate() error {
catcher := grip.NewBasicCatcher()
catcher.NewWhen(c.ID == nil && c.NewCreds == nil, "must specify either an existing secret ID or new credentials to create")
catcher.NewWhen(c.ID != nil && c.NewCreds != nil, "cannot specify both an existing secret ID and a new secret to create")
catcher.NewWhen(c.NewCreds != nil && c.Name == nil, "cannot specify a new secret to be created without a name")
catcher.NewWhen(c.ID != nil && utility.FromStringPtr(c.ID) == "", "cannot specify an empty secret ID")
if c.NewCreds != nil {
catcher.Wrap(c.NewCreds.Validate(), "invalid new credentials to create")
}
return catcher.Resolve()
}
// hash returns the hash digest of the repository credentials.
func (c *RepositoryCredentials) hash() string {
h := utility.NewSHA1Hash()
if c.ID != nil {
h.Add(utility.FromStringPtr(c.ID))
}