-
Notifications
You must be signed in to change notification settings - Fork 72
Expand file tree
/
Copy pathexperimental-e2e.yaml
More file actions
3002 lines (2874 loc) · 131 KB
/
experimental-e2e.yaml
File metadata and controls
3002 lines (2874 loc) · 131 KB
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
---
# Source: olmv1/templates/namespace.yml
apiVersion: v1
kind: Namespace
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: olmv1
pod-security.kubernetes.io/audit: restricted
pod-security.kubernetes.io/audit-version: latest
pod-security.kubernetes.io/enforce: restricted
pod-security.kubernetes.io/enforce-version: latest
pod-security.kubernetes.io/warn: restricted
pod-security.kubernetes.io/warn-version: latest
app.kubernetes.io/part-of: olm
name: olmv1-system
---
# Source: olmv1/templates/networkpolicy/networkpolicy-olmv1-system-catalogd-controller-manager.yml
apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: catalogd
app.kubernetes.io/part-of: olm
name: catalogd-controller-manager
namespace: olmv1-system
spec:
egress:
- {}
ingress:
- ports:
- port: 7443
protocol: TCP
- port: 8443
protocol: TCP
- port: 9443
protocol: TCP
podSelector:
matchLabels:
control-plane: catalogd-controller-manager
policyTypes:
- Ingress
- Egress
---
# Source: olmv1/templates/networkpolicy/networkpolicy-olmv1-system-default-deny-all-traffic.yml
apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: olmv1
app.kubernetes.io/part-of: olm
name: default-deny-all-traffic
namespace: olmv1-system
spec:
podSelector: {}
policyTypes:
- Ingress
- Egress
---
# Source: olmv1/templates/networkpolicy/networkpolicy-olmv1-system-operator-controller-controller-manager.yml
apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: operator-controller
app.kubernetes.io/part-of: olm
name: operator-controller-controller-manager
namespace: olmv1-system
spec:
egress:
- {}
ingress:
- ports:
- port: 8443
protocol: TCP
podSelector:
matchLabels:
control-plane: operator-controller-controller-manager
policyTypes:
- Ingress
- Egress
---
# Source: olmv1/templates/poddisruptionbudget-olmv1-system-catalogd.yml
apiVersion: policy/v1
kind: PodDisruptionBudget
metadata:
name: catalogd-controller-manager
namespace: olmv1-system
labels:
app.kubernetes.io/name: catalogd
app.kubernetes.io/part-of: olm
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
spec:
minAvailable: 1
selector:
matchLabels:
control-plane: catalogd-controller-manager
---
# Source: olmv1/templates/poddisruptionbudget-olmv1-system-operator-controller.yml
apiVersion: policy/v1
kind: PodDisruptionBudget
metadata:
name: operator-controller-controller-manager
namespace: olmv1-system
labels:
app.kubernetes.io/name: operator-controller
app.kubernetes.io/part-of: olm
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
spec:
minAvailable: 1
selector:
matchLabels:
control-plane: operator-controller-controller-manager
---
# Source: olmv1/templates/serviceaccount-olmv1-system-common-controller-manager.yml
apiVersion: v1
kind: ServiceAccount
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: catalogd
app.kubernetes.io/part-of: olm
name: catalogd-controller-manager
namespace: olmv1-system
---
# Source: olmv1/templates/serviceaccount-olmv1-system-common-controller-manager.yml
apiVersion: v1
kind: ServiceAccount
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: operator-controller
app.kubernetes.io/part-of: olm
name: operator-controller-controller-manager
namespace: olmv1-system
---
# Source: olmv1/templates/e2e/configmap-olmv1-system-e2e-registries-conf.yml
apiVersion: v1
data:
registries.conf: |
[[registry]]
prefix = "mirrored-registry.operator-controller-e2e.svc.cluster.local:5000"
location = "docker-registry.operator-controller-e2e.svc.cluster.local:5000"
[[registry]]
prefix = "dynamic-registry.operator-controller-e2e.svc.cluster.local:5000"
location = "docker-registry.operator-controller-e2e.svc.cluster.local:5000"
kind: ConfigMap
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: e2e
app.kubernetes.io/part-of: olm
name: e2e-registries-conf
namespace: olmv1-system
---
# Source: olmv1/templates/e2e/persistentvolumeclaim-olmv1-system-e2e-coverage.yml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
annotations:
olm.operatorframework.io/feature-set: experimental-e2e
labels:
app.kubernetes.io/name: e2e
app.kubernetes.io/part-of: olm
name: e2e-coverage
namespace: olmv1-system
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 64Mi
---
# Source: olmv1/templates/crds/customresourcedefinition-clustercatalogs.olm.operatorframework.io.yml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.20.1
olm.operatorframework.io/generator: experimental
name: clustercatalogs.olm.operatorframework.io
spec:
group: olm.operatorframework.io
names:
kind: ClusterCatalog
listKind: ClusterCatalogList
plural: clustercatalogs
singular: clustercatalog
scope: Cluster
versions:
- additionalPrinterColumns:
- jsonPath: .status.lastUnpacked
name: LastUnpacked
type: date
- jsonPath: .status.conditions[?(@.type=="Serving")].status
name: Serving
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1
schema:
openAPIV3Schema:
description: |-
ClusterCatalog makes File-Based Catalog (FBC) data available to your cluster.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: |-
spec is a required field that defines the desired state of the ClusterCatalog.
The controller ensures that the catalog is unpacked and served over the catalog content HTTP server.
properties:
availabilityMode:
default: Available
description: |-
availabilityMode is an optional field that defines how the ClusterCatalog is made available to clients on the cluster.
Allowed values are "Available", "Unavailable", or omitted.
When omitted, the default value is "Available".
When set to "Available", the catalog contents are unpacked and served over the catalog content HTTP server.
Clients should consider this ClusterCatalog and its contents as usable.
When set to "Unavailable", the catalog contents are no longer served over the catalog content HTTP server.
Treat this the same as if the ClusterCatalog does not exist.
Use "Unavailable" when you want to keep the ClusterCatalog but treat it as if it doesn't exist.
enum:
- Unavailable
- Available
type: string
priority:
default: 0
description: |-
priority is an optional field that defines a priority for this ClusterCatalog.
Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements.
Higher numbers mean higher priority.
Clients decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements.
Clients should prompt users for additional input to break the tie.
When omitted, the default priority is 0.
Use negative numbers to specify a priority lower than the default.
Use positive numbers to specify a priority higher than the default.
The lowest possible value is -2147483648.
The highest possible value is 2147483647.
format: int32
maximum: 2147483647
minimum: -2147483648
type: integer
source:
description: |-
source is a required field that defines the source of a catalog.
A catalog contains information on content that can be installed on a cluster.
The catalog source makes catalog contents discoverable and usable by other on-cluster components.
These components can present the content in a GUI dashboard or install content from the catalog on the cluster.
The catalog source must contain catalog metadata in the File-Based Catalog (FBC) format.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs.
Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image:
source:
type: Image
image:
ref: quay.io/operatorhubio/catalog:latest
properties:
image:
description: |-
image configures how catalog contents are sourced from an OCI image.
It is required when type is Image, and forbidden otherwise.
properties:
pollIntervalMinutes:
description: |-
pollIntervalMinutes is an optional field that sets the interval, in minutes, at which the image source is polled for new content.
You cannot specify pollIntervalMinutes when ref is a digest-based reference.
When omitted, the image is not polled for new content.
minimum: 1
type: integer
ref:
description: |-
ref is a required field that defines the reference to a container image containing catalog contents.
It cannot be more than 1000 characters.
A reference has 3 parts: the domain, name, and identifier.
The domain is typically the registry where an image is located.
It must be alphanumeric characters (lowercase and uppercase) separated by the "." character.
Hyphenation is allowed, but the domain must start and end with alphanumeric characters.
Specifying a port to use is also allowed by adding the ":" character followed by numeric values.
The port must be the last value in the domain.
Some examples of valid domain values are "registry.mydomain.io", "quay.io", "my-registry.io:8080".
The name is typically the repository in the registry where an image is located.
It must contain lowercase alphanumeric characters separated only by the ".", "_", "__", "-" characters.
Multiple names can be concatenated with the "/" character.
The domain and name are combined using the "/" character.
Some examples of valid name values are "operatorhubio/catalog", "catalog", "my-catalog.prod".
An example of the domain and name parts of a reference being combined is "quay.io/operatorhubio/catalog".
The identifier is typically the tag or digest for an image reference and is present at the end of the reference.
It starts with a separator character used to distinguish the end of the name and beginning of the identifier.
For a digest-based reference, the "@" character is the separator.
For a tag-based reference, the ":" character is the separator.
An identifier is required in the reference.
Digest-based references must contain an algorithm reference immediately after the "@" separator.
The algorithm reference must be followed by the ":" character and an encoded string.
The algorithm must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the "-", "_", "+", and "." characters.
Some examples of valid algorithm values are "sha256", "sha256+b64u", "multihash+base58".
The encoded string following the algorithm must be hex digits (a-f, A-F, 0-9) and must be a minimum of 32 characters.
Tag-based references must begin with a word character (alphanumeric + "_") followed by word characters or ".", and "-" characters.
The tag must not be longer than 127 characters.
An example of a valid digest-based image reference is "quay.io/operatorhubio/catalog@sha256:200d4ddb2a73594b91358fe6397424e975205bfbe44614f5846033cad64b3f05"
An example of a valid tag-based image reference is "quay.io/operatorhubio/catalog:latest"
maxLength: 1000
type: string
x-kubernetes-validations:
- message: must start with a valid domain. valid domains must
be alphanumeric characters (lowercase and uppercase) separated
by the "." character.
rule: self.matches('^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])((\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(:[0-9]+)?\\b')
- message: a valid name is required. valid names must contain
lowercase alphanumeric characters separated only by the
".", "_", "__", "-" characters.
rule: self.find('(\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?((\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?)+)?)')
!= ""
- message: must end with a digest or a tag
rule: self.find('(@.*:)') != "" || self.find(':.*$') !=
""
- message: tag is invalid. the tag must not be more than 127
characters
rule: 'self.find(''(@.*:)'') == "" ? (self.find('':.*$'')
!= "" ? self.find('':.*$'').substring(1).size() <= 127
: true) : true'
- message: tag is invalid. valid tags must begin with a word
character (alphanumeric + "_") followed by word characters
or ".", and "-" characters
rule: 'self.find(''(@.*:)'') == "" ? (self.find('':.*$'')
!= "" ? self.find('':.*$'').matches('':[\\w][\\w.-]*$'')
: true) : true'
- message: digest algorithm is not valid. valid algorithms
must start with an uppercase or lowercase alpha character
followed by alphanumeric characters and may contain the
"-", "_", "+", and "." characters.
rule: 'self.find(''(@.*:)'') != "" ? self.find(''(@.*:)'').matches(''(@[A-Za-z][A-Za-z0-9]*([-_+.][A-Za-z][A-Za-z0-9]*)*[:])'')
: true'
- message: digest is not valid. the encoded string must be
at least 32 characters
rule: 'self.find(''(@.*:)'') != "" ? self.find('':.*$'').substring(1).size()
>= 32 : true'
- message: digest is not valid. the encoded string must only
contain hex characters (A-F, a-f, 0-9)
rule: 'self.find(''(@.*:)'') != "" ? self.find('':.*$'').matches('':[0-9A-Fa-f]*$'')
: true'
required:
- ref
type: object
x-kubernetes-validations:
- message: cannot specify pollIntervalMinutes while using digest-based
image
rule: 'self.ref.find(''(@.*:)'') != "" ? !has(self.pollIntervalMinutes)
: true'
type:
description: |-
type is a required field that specifies the type of source for the catalog.
The only allowed value is "Image".
When set to "Image", the ClusterCatalog content is sourced from an OCI image.
When using an image source, the image field must be set and must be the only field defined for this type.
enum:
- Image
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: image is required when source type is Image, and forbidden
otherwise
rule: 'has(self.type) && self.type == ''Image'' ? has(self.image)
: !has(self.image)'
required:
- source
type: object
status:
description: |-
status contains the following information about the state of the ClusterCatalog:
- Whether the catalog contents are being served via the catalog content HTTP server
- Whether the ClusterCatalog is progressing to a new state
- A reference to the source from which the catalog contents were retrieved
properties:
conditions:
description: |-
conditions represents the current state of this ClusterCatalog.
The current condition types are Serving and Progressing.
The Serving condition represents whether the catalog contents are being served via the HTTP(S) web server:
- When status is True and reason is Available, the catalog contents are being served.
- When status is False and reason is Unavailable, the catalog contents are not being served because the contents are not yet available.
- When status is False and reason is UserSpecifiedUnavailable, the catalog contents are not being served because the catalog has been intentionally marked as unavailable.
The Progressing condition represents whether the ClusterCatalog is progressing or is ready to progress towards a new state:
- When status is True and reason is Retrying, an error occurred that may be resolved on subsequent reconciliation attempts.
- When status is True and reason is Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing.
- When status is False and reason is Blocked, an error occurred that requires manual intervention for recovery.
If the system initially fetched contents and polling identifies updates, both conditions can be active simultaneously:
- The Serving condition remains True with reason Available because the previous contents are still served via the HTTP(S) web server.
- The Progressing condition is True with reason Retrying because the system is working to serve the new version.
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
lastUnpacked:
description: |-
lastUnpacked represents the last time the catalog contents were extracted from their source format.
For example, when using an Image source, the OCI image is pulled and image layers are written to a file-system backed cache.
This extraction from the source format is called "unpacking".
format: date-time
type: string
resolvedSource:
description: resolvedSource contains information about the resolved
source based on the source type.
properties:
image:
description: |-
image contains resolution information for a catalog sourced from an image.
It must be set when type is Image, and forbidden otherwise.
properties:
ref:
description: |-
ref contains the resolved image digest-based reference.
The digest format allows you to use other tooling to fetch the exact OCI manifests
that were used to extract the catalog contents.
maxLength: 1000
type: string
x-kubernetes-validations:
- message: must start with a valid domain. valid domains must
be alphanumeric characters (lowercase and uppercase) separated
by the "." character.
rule: self.matches('^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])((\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(:[0-9]+)?\\b')
- message: a valid name is required. valid names must contain
lowercase alphanumeric characters separated only by the
".", "_", "__", "-" characters.
rule: self.find('(\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?((\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?)+)?)')
!= ""
- message: must end with a digest
rule: self.find('(@.*:)') != ""
- message: digest algorithm is not valid. valid algorithms
must start with an uppercase or lowercase alpha character
followed by alphanumeric characters and may contain the
"-", "_", "+", and "." characters.
rule: 'self.find(''(@.*:)'') != "" ? self.find(''(@.*:)'').matches(''(@[A-Za-z][A-Za-z0-9]*([-_+.][A-Za-z][A-Za-z0-9]*)*[:])'')
: true'
- message: digest is not valid. the encoded string must be
at least 32 characters
rule: 'self.find(''(@.*:)'') != "" ? self.find('':.*$'').substring(1).size()
>= 32 : true'
- message: digest is not valid. the encoded string must only
contain hex characters (A-F, a-f, 0-9)
rule: 'self.find(''(@.*:)'') != "" ? self.find('':.*$'').matches('':[0-9A-Fa-f]*$'')
: true'
required:
- ref
type: object
type:
description: |-
type is a required field that specifies the type of source for the catalog.
The only allowed value is "Image".
When set to "Image", information about the resolved image source is set in the image field.
enum:
- Image
type: string
required:
- image
- type
type: object
x-kubernetes-validations:
- message: image is required when source type is Image, and forbidden
otherwise
rule: 'has(self.type) && self.type == ''Image'' ? has(self.image)
: !has(self.image)'
urls:
description: urls contains the URLs that can be used to access the
catalog.
properties:
base:
description: |-
base is a cluster-internal URL that provides endpoints for accessing the catalog content.
Clients should append the path for the endpoint they want to access.
Currently, only a single endpoint is served and is accessible at the path /api/v1.
The endpoints served for the v1 API are:
- /all - this endpoint returns the entire catalog contents in the FBC format
New endpoints may be added as needs evolve.
maxLength: 525
type: string
x-kubernetes-validations:
- message: must be a valid URL
rule: isURL(self)
- message: scheme must be either http or https
rule: 'isURL(self) ? (url(self).getScheme() == "http" || url(self).getScheme()
== "https") : true'
required:
- base
type: object
type: object
required:
- metadata
- spec
type: object
served: true
storage: true
subresources:
status: {}
---
# Source: olmv1/templates/crds/customresourcedefinition-clusterextensionrevisions.olm.operatorframework.io.yml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.20.1
olm.operatorframework.io/generator: experimental
name: clusterextensionrevisions.olm.operatorframework.io
spec:
group: olm.operatorframework.io
names:
kind: ClusterExtensionRevision
listKind: ClusterExtensionRevisionList
plural: clusterextensionrevisions
singular: clusterextensionrevision
scope: Cluster
versions:
- additionalPrinterColumns:
- jsonPath: .status.conditions[?(@.type=='Available')].status
name: Available
type: string
- jsonPath: .status.conditions[?(@.type=='Progressing')].status
name: Progressing
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1
schema:
openAPIV3Schema:
description: |-
ClusterExtensionRevision represents an immutable snapshot of Kubernetes objects
for a specific version of a ClusterExtension. Each revision contains objects
organized into phases that roll out sequentially. The same object can only be managed by a single revision
at a time. Ownership of objects is transitioned from one revision to the next as the extension is upgraded
or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
posterity.
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: spec defines the desired state of the ClusterExtensionRevision.
properties:
collisionProtection:
description: |-
collisionProtection specifies the default collision protection strategy for all objects
in this revision. Individual phases or objects can override this value.
When set, this value is used as the default for any phase or object that does not
explicitly specify its own collisionProtection.
The resolution order is: object > phase > spec
enum:
- Prevent
- IfNoController
- None
type: string
x-kubernetes-validations:
- message: collisionProtection is immutable
rule: self == oldSelf
lifecycleState:
description: |-
lifecycleState specifies the lifecycle state of the ClusterExtensionRevision.
When set to "Active", the revision is actively managed and reconciled.
When set to "Archived", the revision is inactive and any resources not managed by a subsequent revision are deleted.
The revision is removed from the owner list of all objects previously under management.
All objects that did not transition to a succeeding revision are deleted.
Once a revision is set to "Archived", it cannot be un-archived.
It is possible for more than one revision to be "Active" simultaneously. This will occur when
moving from one revision to another. The old revision will not be set to "Archived" until the
new revision has been completely rolled out.
enum:
- Active
- Archived
type: string
x-kubernetes-validations:
- message: cannot un-archive
rule: oldSelf == 'Active' || oldSelf == 'Archived' && oldSelf ==
self
phases:
description: |-
phases is an optional, immutable list of phases that group objects to be applied together.
Objects are organized into phases based on their Group-Kind. Common phases include:
- namespaces: Namespace objects
- policies: ResourceQuota, LimitRange, NetworkPolicy objects
- rbac: ServiceAccount, Role, RoleBinding, ClusterRole, ClusterRoleBinding objects
- crds: CustomResourceDefinition objects
- storage: PersistentVolume, PersistentVolumeClaim, StorageClass objects
- deploy: Deployment, StatefulSet, DaemonSet, Service, ConfigMap, Secret objects
- publish: Ingress, APIService, Route, Webhook objects
All objects in a phase are applied in no particular order.
The revision progresses to the next phase only after all objects in the current phase pass their readiness probes.
Once set, even if empty, the phases field is immutable.
Each phase in the list must have a unique name. The maximum number of phases is 20.
items:
description: |-
ClusterExtensionRevisionPhase represents a group of objects that are applied together. The phase is considered
complete only after all objects pass their status probes.
properties:
collisionProtection:
description: |-
collisionProtection specifies the default collision protection strategy for all objects
in this phase. Individual objects can override this value.
When set, this value is used as the default for any object in this phase that does not
explicitly specify its own collisionProtection.
When omitted, we use .spec.collistionProtection as the default for any object in this phase that does not
explicitly specify its own collisionProtection.
enum:
- Prevent
- IfNoController
- None
type: string
name:
description: |-
name is a required identifier for this phase.
phase names must follow the DNS label standard as defined in [RFC 1123].
They must contain only lowercase alphanumeric characters or hyphens (-),
start and end with an alphanumeric character, and be no longer than 63 characters.
Common phase names include: namespaces, policies, rbac, crds, storage, deploy, publish.
[RFC 1123]: https://tools.ietf.org/html/rfc1123
maxLength: 63
minLength: 1
type: string
x-kubernetes-validations:
- message: the value must consist of only lowercase alphanumeric
characters and hyphens, and must start with an alphabetic
character and end with an alphanumeric character.
rule: '!format.dns1123Label().validate(self).hasValue()'
objects:
description: |-
objects is a required list of all Kubernetes objects that belong to this phase.
All objects in this list are applied to the cluster in no particular order. The maximum number of objects per phase is 50.
items:
description: |-
ClusterExtensionRevisionObject represents a Kubernetes object to be applied as part
of a phase, along with its collision protection settings.
properties:
collisionProtection:
description: |-
collisionProtection controls whether the operator can adopt and modify objects
that already exist on the cluster.
Allowed values are: "Prevent", "IfNoController", and "None".
When set to "Prevent", the operator only manages objects it created itself.
This prevents ownership collisions.
When set to "IfNoController", the operator can adopt and modify pre-existing objects
that are not owned by another controller.
This is useful for taking over management of manually-created resources.
When set to "None", the operator can adopt and modify any pre-existing object, even if
owned by another controller.
Use this setting with extreme caution as it may cause multiple controllers to fight over
the same resource, resulting in increased load on the API server and etcd.
When omitted, the value is inherited from the phase, then spec.
enum:
- Prevent
- IfNoController
- None
type: string
object:
description: |-
object is a required embedded Kubernetes object to be applied.
This object must be a valid Kubernetes resource with apiVersion, kind, and metadata fields.
type: object
x-kubernetes-embedded-resource: true
x-kubernetes-preserve-unknown-fields: true
required:
- object
type: object
maxItems: 50
type: array
required:
- name
- objects
type: object
maxItems: 20
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
x-kubernetes-validations:
- message: phases is immutable
rule: self == oldSelf || oldSelf.size() == 0
progressDeadlineMinutes:
description: |-
progressDeadlineMinutes is an optional field that defines the maximum period
of time in minutes after which an installation should be considered failed and
require manual intervention. This functionality is disabled when no value
is provided. The minimum period is 10 minutes, and the maximum is 720 minutes (12 hours).
format: int32
maximum: 720
minimum: 10
type: integer
progressionProbes:
description: |-
progressionProbes is an optional field which provides the ability to define custom readiness probes
for objects defined within spec.phases. As documented in that field, most kubernetes-native objects
within the phases already have some kind of readiness check built-in, but this field allows for checks
which are tailored to the objects being rolled out - particularly custom resources.
Probes defined within the progressionProbes list will apply to every phase in the revision. However, the probes will only
execute against phase objects which are a match for the provided selector type. For instance, a probe using a GroupKind selector
for ConfigMaps will automatically be considered to have passed for any non-ConfigMap object, but will halt any phase containing
a ConfigMap if that particular object does not pass the probe check.
The maximum number of probes is 20.
items:
description: ProgressionProbe provides a custom probe definition,
consisting of an object selection method and assertions.
properties:
assertions:
description: |-
assertions is a required list of checks which will run against the objects selected by the selector. If
one or more assertions fail then the phase within which the object lives will be not be considered
'Ready', blocking rollout of all subsequent phases.
items:
description: Assertion is a discriminated union which defines
the probe type and definition used as an assertion.
properties:
conditionEqual:
description: conditionEqual contains the expected condition
type and status.
properties:
status:
description: |-
status sets the expected condition status.
Allowed values are "True" and "False".
enum:
- "True"
- "False"
type: string
type:
description: type sets the expected condition type,
i.e. "Ready".
maxLength: 200
minLength: 1
type: string
required:
- status
- type
type: object
fieldValue:
description: fieldValue contains the expected field path
and value found within.
properties:
fieldPath:
description: |-
fieldPath sets the field path for the field to check, i.e. "status.phase". The probe will fail
if the path does not exist.
maxLength: 200
minLength: 1
type: string
x-kubernetes-validations:
- message: must contain a valid field path. valid
fields contain upper or lower-case alphanumeric
characters separated by the "." character.
rule: self.matches('^[a-zA-Z0-9]+(?:\\.[a-zA-Z0-9]+)*$')
value:
description: value sets the expected value found at
fieldPath, i.e. "Bound".
maxLength: 200
minLength: 1
type: string
required:
- fieldPath
- value
type: object
fieldsEqual:
description: fieldsEqual contains the two field paths
whose values are expected to match.
properties:
fieldA:
description: |-
fieldA sets the field path for the first field, i.e. "spec.replicas". The probe will fail
if the path does not exist.
maxLength: 200
minLength: 1
type: string
x-kubernetes-validations:
- message: must contain a valid field path. valid
fields contain upper or lower-case alphanumeric
characters separated by the "." character.
rule: self.matches('^[a-zA-Z0-9]+(?:\\.[a-zA-Z0-9]+)*$')
fieldB:
description: |-
fieldB sets the field path for the second field, i.e. "status.readyReplicas". The probe will fail
if the path does not exist.
maxLength: 200
minLength: 1
type: string
x-kubernetes-validations:
- message: must contain a valid field path. valid
fields contain upper or lower-case alphanumeric
characters separated by the "." character.
rule: self.matches('^[a-zA-Z0-9]+(?:\\.[a-zA-Z0-9]+)*$')
required:
- fieldA
- fieldB
type: object
type:
description: |-
type is a required field which specifies the type of probe to use.
The allowed probe types are "ConditionEqual", "FieldsEqual", and "FieldValue".
When set to "ConditionEqual", the probe checks objects that have reached a condition of specified type and status.
When set to "FieldsEqual", the probe checks that the values found at two provided field paths are matching.
When set to "FieldValue", the probe checks that the value found at the provided field path matches what was specified.
enum:
- ConditionEqual
- FieldsEqual
- FieldValue
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: conditionEqual is required when type is ConditionEqual,
and forbidden otherwise
rule: 'self.type == ''ConditionEqual'' ?has(self.conditionEqual)
: !has(self.conditionEqual)'
- message: fieldsEqual is required when type is FieldsEqual,
and forbidden otherwise
rule: 'self.type == ''FieldsEqual'' ?has(self.fieldsEqual)
: !has(self.fieldsEqual)'
- message: fieldValue is required when type is FieldValue,
and forbidden otherwise
rule: 'self.type == ''FieldValue'' ?has(self.fieldValue)
: !has(self.fieldValue)'
maxItems: 20
minItems: 1
type: array
x-kubernetes-list-type: atomic
selector:
description: |-
selector is a required field which defines the method by which we select objects to apply the below
assertions to. Any object which matches the defined selector will have all the associated assertions
applied against it.
If no objects within a phase are selected by the provided selector, then all assertions defined here
are considered to have succeeded.
properties:
groupKind:
description: |-
groupKind specifies the group and kind of objects to select.
Required when type is "GroupKind".
Uses the Kubernetes format specified here:
https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupKind
properties:
group:
type: string
kind:
type: string