-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
applicationset_types.go
916 lines (810 loc) · 49.2 KB
/
applicationset_types.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
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1alpha1
import (
"encoding/json"
"fmt"
"sort"
"github.com/argoproj/argo-cd/v2/common"
"github.com/argoproj/argo-cd/v2/util/security"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
)
// Utility struct for a reference to a secret key.
type SecretRef struct {
SecretName string `json:"secretName" protobuf:"bytes,1,opt,name=secretName"`
Key string `json:"key" protobuf:"bytes,2,opt,name=key"`
}
// ApplicationSet is a set of Application resources
// +genclient
// +genclient:noStatus
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:path=applicationsets,shortName=appset;appsets
// +kubebuilder:subresource:status
type ApplicationSet struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"`
Spec ApplicationSetSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
Status ApplicationSetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// RBACName formats fully qualified application name for RBAC check.
func (a *ApplicationSet) RBACName(defaultNS string) string {
return security.RBACName(defaultNS, a.Spec.Template.Spec.GetProject(), a.Namespace, a.Name)
}
// ApplicationSetSpec represents a class of application set state.
type ApplicationSetSpec struct {
GoTemplate bool `json:"goTemplate,omitempty" protobuf:"bytes,1,name=goTemplate"`
Generators []ApplicationSetGenerator `json:"generators" protobuf:"bytes,2,name=generators"`
Template ApplicationSetTemplate `json:"template" protobuf:"bytes,3,name=template"`
SyncPolicy *ApplicationSetSyncPolicy `json:"syncPolicy,omitempty" protobuf:"bytes,4,name=syncPolicy"`
Strategy *ApplicationSetStrategy `json:"strategy,omitempty" protobuf:"bytes,5,opt,name=strategy"`
PreservedFields *ApplicationPreservedFields `json:"preservedFields,omitempty" protobuf:"bytes,6,opt,name=preservedFields"`
GoTemplateOptions []string `json:"goTemplateOptions,omitempty" protobuf:"bytes,7,opt,name=goTemplateOptions"`
// ApplyNestedSelectors enables selectors defined within the generators of two level-nested matrix or merge generators
ApplyNestedSelectors bool `json:"applyNestedSelectors,omitempty" protobuf:"bytes,8,name=applyNestedSelectors"`
IgnoreApplicationDifferences ApplicationSetIgnoreDifferences `json:"ignoreApplicationDifferences,omitempty" protobuf:"bytes,9,name=ignoreApplicationDifferences"`
TemplatePatch *string `json:"templatePatch,omitempty" protobuf:"bytes,10,name=templatePatch"`
}
type ApplicationPreservedFields struct {
Annotations []string `json:"annotations,omitempty" protobuf:"bytes,1,name=annotations"`
Labels []string `json:"labels,omitempty" protobuf:"bytes,2,name=labels"`
}
// ApplicationSetStrategy configures how generated Applications are updated in sequence.
type ApplicationSetStrategy struct {
Type string `json:"type,omitempty" protobuf:"bytes,1,opt,name=type"`
RollingSync *ApplicationSetRolloutStrategy `json:"rollingSync,omitempty" protobuf:"bytes,2,opt,name=rollingSync"`
// RollingUpdate *ApplicationSetRolloutStrategy `json:"rollingUpdate,omitempty" protobuf:"bytes,3,opt,name=rollingUpdate"`
}
type ApplicationSetRolloutStrategy struct {
Steps []ApplicationSetRolloutStep `json:"steps,omitempty" protobuf:"bytes,1,opt,name=steps"`
}
type ApplicationSetRolloutStep struct {
MatchExpressions []ApplicationMatchExpression `json:"matchExpressions,omitempty" protobuf:"bytes,1,opt,name=matchExpressions"`
MaxUpdate *intstr.IntOrString `json:"maxUpdate,omitempty" protobuf:"bytes,2,opt,name=maxUpdate"`
}
type ApplicationMatchExpression struct {
Key string `json:"key,omitempty" protobuf:"bytes,1,opt,name=key"`
Operator string `json:"operator,omitempty" protobuf:"bytes,2,opt,name=operator"`
Values []string `json:"values,omitempty" protobuf:"bytes,3,opt,name=values"`
}
// ApplicationsSyncPolicy representation
// "create-only" means applications are only created. If the generator's result contains update, applications won't be updated
// "create-update" means applications are only created/Updated. If the generator's result contains update, applications will be updated, but not deleted
// "create-delete" means applications are only created/deleted. If the generator's result contains update, applications won't be updated, if it results in deleted applications, the applications will be deleted
// "sync" means create/update/deleted. If the generator's result contains update, applications will be updated, if it results in deleted applications, the applications will be deleted
// If no ApplicationsSyncPolicy is defined, it defaults it to sync
type ApplicationsSyncPolicy string
// sync / create-only / create-update / create-delete
const (
ApplicationsSyncPolicyCreateOnly ApplicationsSyncPolicy = "create-only"
ApplicationsSyncPolicyCreateUpdate ApplicationsSyncPolicy = "create-update"
ApplicationsSyncPolicyCreateDelete ApplicationsSyncPolicy = "create-delete"
ApplicationsSyncPolicySync ApplicationsSyncPolicy = "sync"
)
func (s ApplicationsSyncPolicy) AllowUpdate() bool {
return s == ApplicationsSyncPolicyCreateUpdate || s == ApplicationsSyncPolicySync
}
func (s ApplicationsSyncPolicy) AllowDelete() bool {
return s == ApplicationsSyncPolicySync || s == ApplicationsSyncPolicyCreateDelete
}
// ApplicationSetSyncPolicy configures how generated Applications will relate to their
// ApplicationSet.
type ApplicationSetSyncPolicy struct {
// PreserveResourcesOnDeletion will preserve resources on deletion. If PreserveResourcesOnDeletion is set to true, these Applications will not be deleted.
PreserveResourcesOnDeletion bool `json:"preserveResourcesOnDeletion,omitempty" protobuf:"bytes,1,name=syncPolicy"`
// ApplicationsSync represents the policy applied on the generated applications. Possible values are create-only, create-update, create-delete, sync
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Enum=create-only;create-update;create-delete;sync
ApplicationsSync *ApplicationsSyncPolicy `json:"applicationsSync,omitempty" protobuf:"bytes,2,opt,name=applicationsSync,casttype=ApplicationsSyncPolicy"`
}
// ApplicationSetIgnoreDifferences configures how the ApplicationSet controller will ignore differences in live
// applications when applying changes from generated applications.
type ApplicationSetIgnoreDifferences []ApplicationSetResourceIgnoreDifferences
func (a ApplicationSetIgnoreDifferences) ToApplicationIgnoreDifferences() []ResourceIgnoreDifferences {
var result []ResourceIgnoreDifferences
for _, item := range a {
result = append(result, item.ToApplicationResourceIgnoreDifferences())
}
return result
}
// ApplicationSetResourceIgnoreDifferences configures how the ApplicationSet controller will ignore differences in live
// applications when applying changes from generated applications.
type ApplicationSetResourceIgnoreDifferences struct {
// Name is the name of the application to ignore differences for. If not specified, the rule applies to all applications.
Name string `json:"name,omitempty" protobuf:"bytes,1,name=name"`
// JSONPointers is a list of JSON pointers to fields to ignore differences for.
JSONPointers []string `json:"jsonPointers,omitempty" protobuf:"bytes,2,name=jsonPointers"`
// JQPathExpressions is a list of JQ path expressions to fields to ignore differences for.
JQPathExpressions []string `json:"jqPathExpressions,omitempty" protobuf:"bytes,3,name=jqExpressions"`
}
func (a *ApplicationSetResourceIgnoreDifferences) ToApplicationResourceIgnoreDifferences() ResourceIgnoreDifferences {
return ResourceIgnoreDifferences{
Kind: ApplicationSchemaGroupVersionKind.Kind,
Group: ApplicationSchemaGroupVersionKind.Group,
Name: a.Name,
JSONPointers: a.JSONPointers,
JQPathExpressions: a.JQPathExpressions,
}
}
// ApplicationSetTemplate represents argocd ApplicationSpec
type ApplicationSetTemplate struct {
ApplicationSetTemplateMeta `json:"metadata" protobuf:"bytes,1,name=metadata"`
Spec ApplicationSpec `json:"spec" protobuf:"bytes,2,name=spec"`
}
// ApplicationSetTemplateMeta represents the Argo CD application fields that may
// be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
type ApplicationSetTemplateMeta struct {
Name string `json:"name,omitempty" protobuf:"bytes,1,name=name"`
Namespace string `json:"namespace,omitempty" protobuf:"bytes,2,name=namespace"`
Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,3,name=labels"`
Annotations map[string]string `json:"annotations,omitempty" protobuf:"bytes,4,name=annotations"`
Finalizers []string `json:"finalizers,omitempty" protobuf:"bytes,5,name=finalizers"`
}
// ApplicationSetGenerator represents a generator at the top level of an ApplicationSet.
type ApplicationSetGenerator struct {
List *ListGenerator `json:"list,omitempty" protobuf:"bytes,1,name=list"`
Clusters *ClusterGenerator `json:"clusters,omitempty" protobuf:"bytes,2,name=clusters"`
Git *GitGenerator `json:"git,omitempty" protobuf:"bytes,3,name=git"`
SCMProvider *SCMProviderGenerator `json:"scmProvider,omitempty" protobuf:"bytes,4,name=scmProvider"`
ClusterDecisionResource *DuckTypeGenerator `json:"clusterDecisionResource,omitempty" protobuf:"bytes,5,name=clusterDecisionResource"`
PullRequest *PullRequestGenerator `json:"pullRequest,omitempty" protobuf:"bytes,6,name=pullRequest"`
Matrix *MatrixGenerator `json:"matrix,omitempty" protobuf:"bytes,7,name=matrix"`
Merge *MergeGenerator `json:"merge,omitempty" protobuf:"bytes,8,name=merge"`
// Selector allows to post-filter all generator.
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,9,name=selector"`
Plugin *PluginGenerator `json:"plugin,omitempty" protobuf:"bytes,10,name=plugin"`
}
// ApplicationSetNestedGenerator represents a generator nested within a combination-type generator (MatrixGenerator or
// MergeGenerator).
type ApplicationSetNestedGenerator struct {
List *ListGenerator `json:"list,omitempty" protobuf:"bytes,1,name=list"`
Clusters *ClusterGenerator `json:"clusters,omitempty" protobuf:"bytes,2,name=clusters"`
Git *GitGenerator `json:"git,omitempty" protobuf:"bytes,3,name=git"`
SCMProvider *SCMProviderGenerator `json:"scmProvider,omitempty" protobuf:"bytes,4,name=scmProvider"`
ClusterDecisionResource *DuckTypeGenerator `json:"clusterDecisionResource,omitempty" protobuf:"bytes,5,name=clusterDecisionResource"`
PullRequest *PullRequestGenerator `json:"pullRequest,omitempty" protobuf:"bytes,6,name=pullRequest"`
// Matrix should have the form of NestedMatrixGenerator
Matrix *apiextensionsv1.JSON `json:"matrix,omitempty" protobuf:"bytes,7,name=matrix"`
// Merge should have the form of NestedMergeGenerator
Merge *apiextensionsv1.JSON `json:"merge,omitempty" protobuf:"bytes,8,name=merge"`
// Selector allows to post-filter all generator.
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,9,name=selector"`
Plugin *PluginGenerator `json:"plugin,omitempty" protobuf:"bytes,10,name=plugin"`
}
type ApplicationSetNestedGenerators []ApplicationSetNestedGenerator
// ApplicationSetTerminalGenerator represents a generator nested within a nested generator (for example, a list within
// a merge within a matrix). A generator at this level may not be a combination-type generator (MatrixGenerator or
// MergeGenerator). ApplicationSet enforces this nesting depth limit because CRDs do not support recursive types.
// https://github.com/kubernetes-sigs/controller-tools/issues/477
type ApplicationSetTerminalGenerator struct {
List *ListGenerator `json:"list,omitempty" protobuf:"bytes,1,name=list"`
Clusters *ClusterGenerator `json:"clusters,omitempty" protobuf:"bytes,2,name=clusters"`
Git *GitGenerator `json:"git,omitempty" protobuf:"bytes,3,name=git"`
SCMProvider *SCMProviderGenerator `json:"scmProvider,omitempty" protobuf:"bytes,4,name=scmProvider"`
ClusterDecisionResource *DuckTypeGenerator `json:"clusterDecisionResource,omitempty" protobuf:"bytes,5,name=clusterDecisionResource"`
PullRequest *PullRequestGenerator `json:"pullRequest,omitempty" protobuf:"bytes,6,name=pullRequest"`
Plugin *PluginGenerator `json:"plugin,omitempty" protobuf:"bytes,7,name=plugin"`
// Selector allows to post-filter all generator.
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,8,name=selector"`
}
type ApplicationSetTerminalGenerators []ApplicationSetTerminalGenerator
// toApplicationSetNestedGenerators converts a terminal generator (a generator which cannot be a combination-type
// generator) to a "nested" generator. The conversion is for convenience, allowing generator g to be used where a nested
// generator is expected.
func (g ApplicationSetTerminalGenerators) toApplicationSetNestedGenerators() []ApplicationSetNestedGenerator {
nestedGenerators := make([]ApplicationSetNestedGenerator, len(g))
for i, terminalGenerator := range g {
nestedGenerators[i] = ApplicationSetNestedGenerator{
List: terminalGenerator.List,
Clusters: terminalGenerator.Clusters,
Git: terminalGenerator.Git,
SCMProvider: terminalGenerator.SCMProvider,
ClusterDecisionResource: terminalGenerator.ClusterDecisionResource,
PullRequest: terminalGenerator.PullRequest,
Plugin: terminalGenerator.Plugin,
Selector: terminalGenerator.Selector,
}
}
return nestedGenerators
}
// ListGenerator include items info
type ListGenerator struct {
// +kubebuilder:validation:Optional
Elements []apiextensionsv1.JSON `json:"elements" protobuf:"bytes,1,name=elements"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,2,name=template"`
ElementsYaml string `json:"elementsYaml,omitempty" protobuf:"bytes,3,opt,name=elementsYaml"`
}
// MatrixGenerator generates the cartesian product of two sets of parameters. The parameters are defined by two nested
// generators.
type MatrixGenerator struct {
Generators []ApplicationSetNestedGenerator `json:"generators" protobuf:"bytes,1,name=generators"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,2,name=template"`
}
// NestedMatrixGenerator is a MatrixGenerator nested under another combination-type generator (MatrixGenerator or
// MergeGenerator). NestedMatrixGenerator does not have an override template, because template overriding has no meaning
// within the constituent generators of combination-type generators.
//
// NOTE: Nested matrix generator is not included directly in the CRD struct, instead it is included
// as a generic 'apiextensionsv1.JSON' object, and then marshalled into a NestedMatrixGenerator
// when processed.
type NestedMatrixGenerator struct {
Generators ApplicationSetTerminalGenerators `json:"generators" protobuf:"bytes,1,name=generators"`
}
// ToNestedMatrixGenerator converts a JSON struct (from the K8s resource) to corresponding
// NestedMatrixGenerator object.
func ToNestedMatrixGenerator(j *apiextensionsv1.JSON) (*NestedMatrixGenerator, error) {
if j == nil {
return nil, nil
}
nestedMatrixGenerator := NestedMatrixGenerator{}
err := json.Unmarshal(j.Raw, &nestedMatrixGenerator)
if err != nil {
return nil, err
}
return &nestedMatrixGenerator, nil
}
// ToMatrixGenerator converts a NestedMatrixGenerator to a MatrixGenerator. This conversion is for convenience, allowing
// a NestedMatrixGenerator to be used where a MatrixGenerator is expected (of course, the converted generator will have
// no override template).
func (g NestedMatrixGenerator) ToMatrixGenerator() *MatrixGenerator {
return &MatrixGenerator{
Generators: g.Generators.toApplicationSetNestedGenerators(),
}
}
// MergeGenerator merges the output of two or more generators. Where the values for all specified merge keys are equal
// between two sets of generated parameters, the parameter sets will be merged with the parameters from the latter
// generator taking precedence. Parameter sets with merge keys not present in the base generator's params will be
// ignored.
// For example, if the first generator produced [{a: '1', b: '2'}, {c: '1', d: '1'}] and the second generator produced
// [{'a': 'override'}], the united parameters for merge keys = ['a'] would be
// [{a: 'override', b: '1'}, {c: '1', d: '1'}].
//
// MergeGenerator supports template overriding. If a MergeGenerator is one of multiple top-level generators, its
// template will be merged with the top-level generator before the parameters are applied.
type MergeGenerator struct {
Generators []ApplicationSetNestedGenerator `json:"generators" protobuf:"bytes,1,name=generators"`
MergeKeys []string `json:"mergeKeys" protobuf:"bytes,2,name=mergeKeys"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,3,name=template"`
}
// NestedMergeGenerator is a MergeGenerator nested under another combination-type generator (MatrixGenerator or
// MergeGenerator). NestedMergeGenerator does not have an override template, because template overriding has no meaning
// within the constituent generators of combination-type generators.
//
// NOTE: Nested merge generator is not included directly in the CRD struct, instead it is included
// as a generic 'apiextensionsv1.JSON' object, and then marshalled into a NestedMergeGenerator
// when processed.
type NestedMergeGenerator struct {
Generators ApplicationSetTerminalGenerators `json:"generators" protobuf:"bytes,1,name=generators"`
MergeKeys []string `json:"mergeKeys" protobuf:"bytes,2,name=mergeKeys"`
}
// ToNestedMergeGenerator converts a JSON struct (from the K8s resource) to corresponding
// NestedMergeGenerator object.
func ToNestedMergeGenerator(j *apiextensionsv1.JSON) (*NestedMergeGenerator, error) {
if j == nil {
return nil, nil
}
nestedMergeGenerator := NestedMergeGenerator{}
err := json.Unmarshal(j.Raw, &nestedMergeGenerator)
if err != nil {
return nil, err
}
return &nestedMergeGenerator, nil
}
// ToMergeGenerator converts a NestedMergeGenerator to a MergeGenerator. This conversion is for convenience, allowing
// a NestedMergeGenerator to be used where a MergeGenerator is expected (of course, the converted generator will have
// no override template).
func (g NestedMergeGenerator) ToMergeGenerator() *MergeGenerator {
return &MergeGenerator{
Generators: g.Generators.toApplicationSetNestedGenerators(),
MergeKeys: g.MergeKeys,
}
}
// ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
type ClusterGenerator struct {
// Selector defines a label selector to match against all clusters registered with ArgoCD.
// Clusters today are stored as Kubernetes Secrets, thus the Secret labels will be used
// for matching the selector.
Selector metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,1,name=selector"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,2,name=template"`
// Values contains key/value pairs which are passed directly as parameters to the template
Values map[string]string `json:"values,omitempty" protobuf:"bytes,3,name=values"`
}
// DuckType defines a generator to match against clusters registered with ArgoCD.
type DuckTypeGenerator struct {
// ConfigMapRef is a ConfigMap with the duck type definitions needed to retrieve the data
// this includes apiVersion(group/version), kind, matchKey and validation settings
// Name is the resource name of the kind, group and version, defined in the ConfigMapRef
// RequeueAfterSeconds is how long before the duckType will be rechecked for a change
ConfigMapRef string `json:"configMapRef" protobuf:"bytes,1,name=configMapRef"`
Name string `json:"name,omitempty" protobuf:"bytes,2,name=name"`
RequeueAfterSeconds *int64 `json:"requeueAfterSeconds,omitempty" protobuf:"bytes,3,name=requeueAfterSeconds"`
LabelSelector metav1.LabelSelector `json:"labelSelector,omitempty" protobuf:"bytes,4,name=labelSelector"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,5,name=template"`
// Values contains key/value pairs which are passed directly as parameters to the template
Values map[string]string `json:"values,omitempty" protobuf:"bytes,6,name=values"`
}
type GitGenerator struct {
RepoURL string `json:"repoURL" protobuf:"bytes,1,name=repoURL"`
Directories []GitDirectoryGeneratorItem `json:"directories,omitempty" protobuf:"bytes,2,name=directories"`
Files []GitFileGeneratorItem `json:"files,omitempty" protobuf:"bytes,3,name=files"`
Revision string `json:"revision" protobuf:"bytes,4,name=revision"`
RequeueAfterSeconds *int64 `json:"requeueAfterSeconds,omitempty" protobuf:"bytes,5,name=requeueAfterSeconds"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,6,name=template"`
PathParamPrefix string `json:"pathParamPrefix,omitempty" protobuf:"bytes,7,name=pathParamPrefix"`
// Values contains key/value pairs which are passed directly as parameters to the template
Values map[string]string `json:"values,omitempty" protobuf:"bytes,8,name=values"`
}
type GitDirectoryGeneratorItem struct {
Path string `json:"path" protobuf:"bytes,1,name=path"`
Exclude bool `json:"exclude,omitempty" protobuf:"bytes,2,name=exclude"`
}
type GitFileGeneratorItem struct {
Path string `json:"path" protobuf:"bytes,1,name=path"`
}
// SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.
type SCMProviderGenerator struct {
// Which provider to use and config for it.
Github *SCMProviderGeneratorGithub `json:"github,omitempty" protobuf:"bytes,1,opt,name=github"`
Gitlab *SCMProviderGeneratorGitlab `json:"gitlab,omitempty" protobuf:"bytes,2,opt,name=gitlab"`
Bitbucket *SCMProviderGeneratorBitbucket `json:"bitbucket,omitempty" protobuf:"bytes,3,opt,name=bitbucket"`
BitbucketServer *SCMProviderGeneratorBitbucketServer `json:"bitbucketServer,omitempty" protobuf:"bytes,4,opt,name=bitbucketServer"`
Gitea *SCMProviderGeneratorGitea `json:"gitea,omitempty" protobuf:"bytes,5,opt,name=gitea"`
AzureDevOps *SCMProviderGeneratorAzureDevOps `json:"azureDevOps,omitempty" protobuf:"bytes,6,opt,name=azureDevOps"`
// Filters for which repos should be considered.
Filters []SCMProviderGeneratorFilter `json:"filters,omitempty" protobuf:"bytes,7,rep,name=filters"`
// Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers
// necessarily support all protocols.
CloneProtocol string `json:"cloneProtocol,omitempty" protobuf:"bytes,8,opt,name=cloneProtocol"`
// Standard parameters.
RequeueAfterSeconds *int64 `json:"requeueAfterSeconds,omitempty" protobuf:"varint,9,opt,name=requeueAfterSeconds"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,10,opt,name=template"`
// Values contains key/value pairs which are passed directly as parameters to the template
Values map[string]string `json:"values,omitempty" protobuf:"bytes,11,name=values"`
AWSCodeCommit *SCMProviderGeneratorAWSCodeCommit `json:"awsCodeCommit,omitempty" protobuf:"bytes,12,opt,name=awsCodeCommit"`
// If you add a new SCM provider, update CustomApiUrl below.
}
func (g *SCMProviderGenerator) CustomApiUrl() string {
if g.Github != nil {
return g.Github.API
} else if g.Gitlab != nil {
return g.Gitlab.API
} else if g.Gitea != nil {
return g.Gitea.API
} else if g.BitbucketServer != nil {
return g.BitbucketServer.API
} else if g.AzureDevOps != nil {
return g.AzureDevOps.API
}
return ""
}
// SCMProviderGeneratorGitea defines a connection info specific to Gitea.
type SCMProviderGeneratorGitea struct {
// Gitea organization or user to scan. Required.
Owner string `json:"owner" protobuf:"bytes,1,opt,name=owner"`
// The Gitea URL to talk to. For example https://gitea.mydomain.com/.
API string `json:"api" protobuf:"bytes,2,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,3,opt,name=tokenRef"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,4,opt,name=allBranches"`
// Allow self-signed TLS / Certificates; default: false
Insecure bool `json:"insecure,omitempty" protobuf:"varint,5,opt,name=insecure"`
}
// SCMProviderGeneratorGithub defines connection info specific to GitHub.
type SCMProviderGeneratorGithub struct {
// GitHub org to scan. Required.
Organization string `json:"organization" protobuf:"bytes,1,opt,name=organization"`
// The GitHub API URL to talk to. If blank, use https://api.github.com/.
API string `json:"api,omitempty" protobuf:"bytes,2,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,3,opt,name=tokenRef"`
// AppSecretName is a reference to a GitHub App repo-creds secret.
AppSecretName string `json:"appSecretName,omitempty" protobuf:"bytes,4,opt,name=appSecretName"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,5,opt,name=allBranches"`
}
// SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
type SCMProviderGeneratorGitlab struct {
// Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Group string `json:"group" protobuf:"bytes,1,opt,name=group"`
// Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
IncludeSubgroups bool `json:"includeSubgroups,omitempty" protobuf:"varint,2,opt,name=includeSubgroups"`
// The Gitlab API URL to talk to.
API string `json:"api,omitempty" protobuf:"bytes,3,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,4,opt,name=tokenRef"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,5,opt,name=allBranches"`
// Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Insecure bool `json:"insecure,omitempty" protobuf:"varint,6,opt,name=insecure"`
// When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
IncludeSharedProjects *bool `json:"includeSharedProjects,omitempty" protobuf:"varint,7,opt,name=includeSharedProjects"`
// Filter repos list based on Gitlab Topic.
Topic string `json:"topic,omitempty" protobuf:"bytes,8,opt,name=topic"`
}
func (s *SCMProviderGeneratorGitlab) WillIncludeSharedProjects() bool {
return s.IncludeSharedProjects == nil || *s.IncludeSharedProjects
}
// SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
type SCMProviderGeneratorBitbucket struct {
// Bitbucket workspace to scan. Required.
Owner string `json:"owner" protobuf:"bytes,1,opt,name=owner"`
// Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
User string `json:"user" protobuf:"bytes,2,opt,name=user"`
// The app password to use for the user. Required. See: https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/
AppPasswordRef *SecretRef `json:"appPasswordRef" protobuf:"bytes,3,opt,name=appPasswordRef"`
// Scan all branches instead of just the main branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,4,opt,name=allBranches"`
}
// SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
type SCMProviderGeneratorBitbucketServer struct {
// Project to scan. Required.
Project string `json:"project" protobuf:"bytes,1,opt,name=project"`
// The Bitbucket Server REST API URL to talk to. Required.
API string `json:"api" protobuf:"bytes,2,opt,name=api"`
// Credentials for Basic auth
BasicAuth *BasicAuthBitbucketServer `json:"basicAuth,omitempty" protobuf:"bytes,3,opt,name=basicAuth"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,4,opt,name=allBranches"`
}
// SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
type SCMProviderGeneratorAzureDevOps struct {
// Azure Devops organization. Required. E.g. "my-organization".
Organization string `json:"organization" protobuf:"bytes,5,opt,name=organization"`
// The URL to Azure DevOps. If blank, use https://dev.azure.com.
API string `json:"api,omitempty" protobuf:"bytes,6,opt,name=api"`
// Azure Devops team project. Required. E.g. "my-team".
TeamProject string `json:"teamProject" protobuf:"bytes,7,opt,name=teamProject"`
// The Personal Access Token (PAT) to use when connecting. Required.
AccessTokenRef *SecretRef `json:"accessTokenRef" protobuf:"bytes,8,opt,name=accessTokenRef"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,9,opt,name=allBranches"`
}
type TagFilter struct {
Key string `json:"key" protobuf:"bytes,1,opt,name=key"`
Value string `json:"value,omitempty" protobuf:"bytes,2,opt,name=value"`
}
// SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
type SCMProviderGeneratorAWSCodeCommit struct {
// TagFilters provides the tag filter(s) for repo discovery
TagFilters []*TagFilter `json:"tagFilters,omitempty" protobuf:"bytes,1,opt,name=tagFilters"`
// Role provides the AWS IAM role to assume, for cross-account repo discovery
// if not provided, AppSet controller will use its pod/node identity to discover.
Role string `json:"role,omitempty" protobuf:"bytes,2,opt,name=role"`
// Region provides the AWS region to discover repos.
// if not provided, AppSet controller will infer the current region from environment.
Region string `json:"region,omitempty" protobuf:"bytes,3,opt,name=region"`
// Scan all branches instead of just the default branch.
AllBranches bool `json:"allBranches,omitempty" protobuf:"varint,4,opt,name=allBranches"`
}
// SCMProviderGeneratorFilter is a single repository filter.
// If multiple filter types are set on a single struct, they will be AND'd together. All filters must
// pass for a repo to be included.
type SCMProviderGeneratorFilter struct {
// A regex for repo names.
RepositoryMatch *string `json:"repositoryMatch,omitempty" protobuf:"bytes,1,opt,name=repositoryMatch"`
// An array of paths, all of which must exist.
PathsExist []string `json:"pathsExist,omitempty" protobuf:"bytes,2,rep,name=pathsExist"`
// An array of paths, all of which must not exist.
PathsDoNotExist []string `json:"pathsDoNotExist,omitempty" protobuf:"bytes,3,rep,name=pathsDoNotExist"`
// A regex which must match at least one label.
LabelMatch *string `json:"labelMatch,omitempty" protobuf:"bytes,4,opt,name=labelMatch"`
// A regex which must match the branch name.
BranchMatch *string `json:"branchMatch,omitempty" protobuf:"bytes,5,opt,name=branchMatch"`
}
// PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.
type PullRequestGenerator struct {
// Which provider to use and config for it.
Github *PullRequestGeneratorGithub `json:"github,omitempty" protobuf:"bytes,1,opt,name=github"`
GitLab *PullRequestGeneratorGitLab `json:"gitlab,omitempty" protobuf:"bytes,2,opt,name=gitlab"`
Gitea *PullRequestGeneratorGitea `json:"gitea,omitempty" protobuf:"bytes,3,opt,name=gitea"`
BitbucketServer *PullRequestGeneratorBitbucketServer `json:"bitbucketServer,omitempty" protobuf:"bytes,4,opt,name=bitbucketServer"`
// Filters for which pull requests should be considered.
Filters []PullRequestGeneratorFilter `json:"filters,omitempty" protobuf:"bytes,5,rep,name=filters"`
// Standard parameters.
RequeueAfterSeconds *int64 `json:"requeueAfterSeconds,omitempty" protobuf:"varint,6,opt,name=requeueAfterSeconds"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,7,opt,name=template"`
Bitbucket *PullRequestGeneratorBitbucket `json:"bitbucket,omitempty" protobuf:"bytes,8,opt,name=bitbucket"`
// Additional provider to use and config for it.
AzureDevOps *PullRequestGeneratorAzureDevOps `json:"azuredevops,omitempty" protobuf:"bytes,9,opt,name=azuredevops"`
// If you add a new SCM provider, update CustomApiUrl below.
}
func (p *PullRequestGenerator) CustomApiUrl() string {
if p.Github != nil {
return p.Github.API
}
if p.GitLab != nil {
return p.GitLab.API
}
if p.Gitea != nil {
return p.Gitea.API
}
if p.BitbucketServer != nil {
return p.BitbucketServer.API
}
if p.Bitbucket != nil {
return p.Bitbucket.API
}
if p.AzureDevOps != nil {
return p.AzureDevOps.API
}
return ""
}
// PullRequestGeneratorGitea defines connection info specific to Gitea.
type PullRequestGeneratorGitea struct {
// Gitea org or user to scan. Required.
Owner string `json:"owner" protobuf:"bytes,1,opt,name=owner"`
// Gitea repo name to scan. Required.
Repo string `json:"repo" protobuf:"bytes,2,opt,name=repo"`
// The Gitea API URL to talk to. Required
API string `json:"api" protobuf:"bytes,3,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,4,opt,name=tokenRef"`
// Allow insecure tls, for self-signed certificates; default: false.
Insecure bool `json:"insecure,omitempty" protobuf:"varint,5,opt,name=insecure"`
}
// PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
type PullRequestGeneratorAzureDevOps struct {
// Azure DevOps org to scan. Required.
Organization string `json:"organization" protobuf:"bytes,1,opt,name=organization"`
// Azure DevOps project name to scan. Required.
Project string `json:"project" protobuf:"bytes,2,opt,name=project"`
// Azure DevOps repo name to scan. Required.
Repo string `json:"repo" protobuf:"bytes,3,opt,name=repo"`
// The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
API string `json:"api,omitempty" protobuf:"bytes,4,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,5,opt,name=tokenRef"`
// Labels is used to filter the PRs that you want to target
Labels []string `json:"labels,omitempty" protobuf:"bytes,6,rep,name=labels"`
}
// PullRequestGenerator defines connection info specific to GitHub.
type PullRequestGeneratorGithub struct {
// GitHub org or user to scan. Required.
Owner string `json:"owner" protobuf:"bytes,1,opt,name=owner"`
// GitHub repo name to scan. Required.
Repo string `json:"repo" protobuf:"bytes,2,opt,name=repo"`
// The GitHub API URL to talk to. If blank, use https://api.github.com/.
API string `json:"api,omitempty" protobuf:"bytes,3,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,4,opt,name=tokenRef"`
// AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
AppSecretName string `json:"appSecretName,omitempty" protobuf:"bytes,5,opt,name=appSecretName"`
// Labels is used to filter the PRs that you want to target
Labels []string `json:"labels,omitempty" protobuf:"bytes,6,rep,name=labels"`
}
// PullRequestGeneratorGitLab defines connection info specific to GitLab.
type PullRequestGeneratorGitLab struct {
// GitLab project to scan. Required.
Project string `json:"project" protobuf:"bytes,1,opt,name=project"`
// The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
API string `json:"api,omitempty" protobuf:"bytes,2,opt,name=api"`
// Authentication token reference.
TokenRef *SecretRef `json:"tokenRef,omitempty" protobuf:"bytes,3,opt,name=tokenRef"`
// Labels is used to filter the MRs that you want to target
Labels []string `json:"labels,omitempty" protobuf:"bytes,4,rep,name=labels"`
// PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
PullRequestState string `json:"pullRequestState,omitempty" protobuf:"bytes,5,rep,name=pullRequestState"`
// Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Insecure bool `json:"insecure,omitempty" protobuf:"varint,6,opt,name=insecure"`
}
// PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
type PullRequestGeneratorBitbucketServer struct {
// Project to scan. Required.
Project string `json:"project" protobuf:"bytes,1,opt,name=project"`
// Repo name to scan. Required.
Repo string `json:"repo" protobuf:"bytes,2,opt,name=repo"`
// The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
API string `json:"api" protobuf:"bytes,3,opt,name=api"`
// Credentials for Basic auth
BasicAuth *BasicAuthBitbucketServer `json:"basicAuth,omitempty" protobuf:"bytes,4,opt,name=basicAuth"`
}
// PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
type PullRequestGeneratorBitbucket struct {
// Workspace to scan. Required.
Owner string `json:"owner" protobuf:"bytes,1,opt,name=owner"`
// Repo name to scan. Required.
Repo string `json:"repo" protobuf:"bytes,2,opt,name=repo"`
// The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
API string `json:"api,omitempty" protobuf:"bytes,3,opt,name=api"`
// Credentials for Basic auth
BasicAuth *BasicAuthBitbucketServer `json:"basicAuth,omitempty" protobuf:"bytes,4,opt,name=basicAuth"`
// Credentials for AppToken (Bearer auth)
BearerToken *BearerTokenBitbucketCloud `json:"bearerToken,omitempty" protobuf:"bytes,5,opt,name=bearerToken"`
}
// BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.
type BearerTokenBitbucketCloud struct {
// Password (or personal access token) reference.
TokenRef *SecretRef `json:"tokenRef" protobuf:"bytes,1,opt,name=tokenRef"`
}
// BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
type BasicAuthBitbucketServer struct {
// Username for Basic auth
Username string `json:"username" protobuf:"bytes,1,opt,name=username"`
// Password (or personal access token) reference.
PasswordRef *SecretRef `json:"passwordRef" protobuf:"bytes,2,opt,name=passwordRef"`
}
// PullRequestGeneratorFilter is a single pull request filter.
// If multiple filter types are set on a single struct, they will be AND'd together. All filters must
// pass for a pull request to be included.
type PullRequestGeneratorFilter struct {
BranchMatch *string `json:"branchMatch,omitempty" protobuf:"bytes,1,opt,name=branchMatch"`
TargetBranchMatch *string `json:"targetBranchMatch,omitempty" protobuf:"bytes,2,opt,name=targetBranchMatch"`
}
type PluginConfigMapRef struct {
// Name of the ConfigMap
Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
}
type PluginParameters map[string]apiextensionsv1.JSON
type PluginInput struct {
// Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the
// values can be any type.
Parameters PluginParameters `json:"parameters,omitempty" protobuf:"bytes,1,name=parameters"`
}
// PluginGenerator defines connection info specific to Plugin.
type PluginGenerator struct {
ConfigMapRef PluginConfigMapRef `json:"configMapRef" protobuf:"bytes,1,name=configMapRef"`
Input PluginInput `json:"input,omitempty" protobuf:"bytes,2,name=input"`
// RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
RequeueAfterSeconds *int64 `json:"requeueAfterSeconds,omitempty" protobuf:"varint,3,opt,name=requeueAfterSeconds"`
Template ApplicationSetTemplate `json:"template,omitempty" protobuf:"bytes,4,name=template"`
// Values contains key/value pairs which are passed directly as parameters to the template. These values will not be
// sent as parameters to the plugin.
Values map[string]string `json:"values,omitempty" protobuf:"bytes,5,name=values"`
}
// ApplicationSetStatus defines the observed state of ApplicationSet
type ApplicationSetStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
Conditions []ApplicationSetCondition `json:"conditions,omitempty" protobuf:"bytes,1,name=conditions"`
ApplicationStatus []ApplicationSetApplicationStatus `json:"applicationStatus,omitempty" protobuf:"bytes,2,name=applicationStatus"`
}
// ApplicationSetCondition contains details about an applicationset condition, which is usally an error or warning
type ApplicationSetCondition struct {
// Type is an applicationset condition type
Type ApplicationSetConditionType `json:"type" protobuf:"bytes,1,opt,name=type"`
// Message contains human-readable message indicating details about condition
Message string `json:"message" protobuf:"bytes,2,opt,name=message"`
// LastTransitionTime is the time the condition was last observed
LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"`
// True/False/Unknown
Status ApplicationSetConditionStatus `json:"status" protobuf:"bytes,4,opt,name=status"`
//Single word camelcase representing the reason for the status eg ErrorOccurred
Reason string `json:"reason" protobuf:"bytes,5,opt,name=reason"`
}
// SyncStatusCode is a type which represents possible comparison results
type ApplicationSetConditionStatus string
// Application Condition Status
const (
// ApplicationSetConditionStatusTrue indicates that a application has been successfully established
ApplicationSetConditionStatusTrue ApplicationSetConditionStatus = "True"
// ApplicationSetConditionStatusFalse indicates that a application attempt has failed
ApplicationSetConditionStatusFalse ApplicationSetConditionStatus = "False"
// ApplicationSetConditionStatusUnknown indicates that the application condition status could not be reliably determined
ApplicationSetConditionStatusUnknown ApplicationSetConditionStatus = "Unknown"
)
// ApplicationSetConditionType represents type of application condition. Type name has following convention:
// prefix "Error" means error condition
// prefix "Warning" means warning condition
// prefix "Info" means informational condition
type ApplicationSetConditionType string
// ErrorOccurred / ParametersGenerated / TemplateRendered / ResourcesUpToDate
const (
ApplicationSetConditionErrorOccurred ApplicationSetConditionType = "ErrorOccurred"
ApplicationSetConditionParametersGenerated ApplicationSetConditionType = "ParametersGenerated"
ApplicationSetConditionResourcesUpToDate ApplicationSetConditionType = "ResourcesUpToDate"
ApplicationSetConditionRolloutProgressing ApplicationSetConditionType = "RolloutProgressing"
)
type ApplicationSetReasonType string
const (
ApplicationSetReasonErrorOccurred = "ErrorOccurred"
ApplicationSetReasonApplicationSetUpToDate = "ApplicationSetUpToDate"
ApplicationSetReasonParametersGenerated = "ParametersGenerated"
ApplicationSetReasonApplicationGenerated = "ApplicationGeneratedSuccessfully"
ApplicationSetReasonUpdateApplicationError = "UpdateApplicationError"
ApplicationSetReasonApplicationParamsGenerationError = "ApplicationGenerationFromParamsError"
ApplicationSetReasonRenderTemplateParamsError = "RenderTemplateParamsError"
ApplicationSetReasonCreateApplicationError = "CreateApplicationError"
ApplicationSetReasonDeleteApplicationError = "DeleteApplicationError"
ApplicationSetReasonRefreshApplicationError = "RefreshApplicationError"
ApplicationSetReasonApplicationValidationError = "ApplicationValidationError"
ApplicationSetReasonApplicationSetModified = "ApplicationSetModified"
ApplicationSetReasonApplicationSetRolloutComplete = "ApplicationSetRolloutComplete"
ApplicationSetReasonSyncApplicationError = "SyncApplicationError"
)
// ApplicationSetApplicationStatus contains details about each Application managed by the ApplicationSet
type ApplicationSetApplicationStatus struct {
// Application contains the name of the Application resource
Application string `json:"application" protobuf:"bytes,1,opt,name=application"`
// LastTransitionTime is the time the status was last updated
LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,2,opt,name=lastTransitionTime"`
// Message contains human-readable message indicating details about the status
Message string `json:"message" protobuf:"bytes,3,opt,name=message"`
// Status contains the AppSet's perceived status of the managed Application resource: (Waiting, Pending, Progressing, Healthy)
Status string `json:"status" protobuf:"bytes,4,opt,name=status"`
// Step tracks which step this Application should be updated in
Step string `json:"step" protobuf:"bytes,5,opt,name=step"`
}
// ApplicationSetList contains a list of ApplicationSet
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:object:root=true
type ApplicationSetList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
Items []ApplicationSet `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// func init() {
// SchemeBuilder.Register(&ApplicationSet{}, &ApplicationSetList{})
// }
// RefreshRequired checks if the ApplicationSet needs to be refreshed
func (a *ApplicationSet) RefreshRequired() bool {
_, found := a.Annotations[common.AnnotationApplicationSetRefresh]
return found
}
// SetConditions updates the applicationset status conditions for a subset of evaluated types.
// If the applicationset has a pre-existing condition of a type that is not in the evaluated list,
// it will be preserved. If the applicationset has a pre-existing condition of a type, status, reason that
// is in the evaluated list, but not in the incoming conditions list, it will be removed.
func (status *ApplicationSetStatus) SetConditions(conditions []ApplicationSetCondition, evaluatedTypes map[ApplicationSetConditionType]bool) {
applicationSetConditions := make([]ApplicationSetCondition, 0)
now := metav1.Now()
for i := range conditions {
condition := conditions[i]
if condition.LastTransitionTime == nil {
condition.LastTransitionTime = &now
}
eci := findConditionIndex(status.Conditions, condition.Type)
if eci >= 0 && status.Conditions[eci].Message == condition.Message && status.Conditions[eci].Reason == condition.Reason && status.Conditions[eci].Status == condition.Status {
// If we already have a condition of this type, status and reason, only update the timestamp if something
// has changed.
applicationSetConditions = append(applicationSetConditions, status.Conditions[eci])
} else {
// Otherwise we use the new incoming condition with an updated timestamp:
applicationSetConditions = append(applicationSetConditions, condition)
}
}
sort.Slice(applicationSetConditions, func(i, j int) bool {
left := applicationSetConditions[i]
right := applicationSetConditions[j]
return fmt.Sprintf("%s/%s/%s/%s/%v", left.Type, left.Message, left.Status, left.Reason, left.LastTransitionTime) < fmt.Sprintf("%s/%s/%s/%s/%v", right.Type, right.Message, right.Status, right.Reason, right.LastTransitionTime)
})
status.Conditions = applicationSetConditions
}
func findConditionIndex(conditions []ApplicationSetCondition, t ApplicationSetConditionType) int {
for i := range conditions {
if conditions[i].Type == t {
return i
}
}
return -1
}
func (status *ApplicationSetStatus) SetApplicationStatus(newStatus ApplicationSetApplicationStatus) {
for i := range status.ApplicationStatus {
appStatus := status.ApplicationStatus[i]
if appStatus.Application == newStatus.Application {
status.ApplicationStatus[i] = newStatus
return
}
}
status.ApplicationStatus = append(status.ApplicationStatus, newStatus)
}
// QualifiedName returns the full qualified name of the applicationset, including
// the name of the namespace it is created in delimited by a forward slash,
// i.e. <namespace>/<appname>
func (a *ApplicationSet) QualifiedName() string {
if a.Namespace == "" {
return a.Name
} else {
return a.Namespace + "/" + a.Name
}
}