Skip to content

Commit 73996fc

Browse files
njhalenjhale
authored
Merge pull request #25 from njhale/fix-csv-schema
fix(crds): add missing status subresource to schema
2 parents 3973134 + 327d19b commit 73996fc

16 files changed

+11119
-10686
lines changed

‎Makefile‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,18 @@ generate: controller-gen ## Generate code
5454
$(CONTROLLER_GEN) object:headerFile=./hack/boilerplate.go.txt paths=./...
5555

5656
manifests: controller-gen ## Generate manifests e.g. CRD, RBAC etc
57-
@# Handle >v1 APIs
58-
$(CONTROLLER_GEN) crd paths=./pkg/operators/v2alpha1... output:crd:dir=./crds
57+
@# Create CRDs for new APIs
58+
$(CONTROLLER_GEN) crd:crdVersions=v1 output:crd:dir=./crds paths=./pkg/operators/...
5959

60-
@# Handle <=v1 APIs
60+
@# Update existing CRDs from type changes
6161
$(CONTROLLER_GEN) schemapatch:manifests=./crds output:dir=./crds paths=./pkg/operators/...
6262

63-
@# Preserve unknown fields on the CSV spec (prevents install strategy from being pruned)
64-
$(YQ_INTERNAL) w --inplace ./crds/operators.coreos.com_clusterserviceversions.yaml spec.validation.openAPIV3Schema.properties.spec.properties.install.properties.spec.properties.deployments.items.properties.spec.properties.template.properties.metadata.x-kubernetes-preserve-unknown-fields true
63+
@# Add missing defaults in embedded core API schemas
64+
$(YQ_INTERNAL) w --inplace ./crds/operators.coreos.com_clusterserviceversions.yaml spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.install.properties.spec.properties.deployments.items.properties.spec.properties.template.properties.spec.properties.containers.items.properties.ports.items.properties.protocol.default TCP
65+
$(YQ_INTERNAL) w --inplace ./crds/operators.coreos.com_clusterserviceversions.yaml spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.install.properties.spec.properties.deployments.items.properties.spec.properties.template.properties.spec.properties.initContainers.items.properties.ports.items.properties.protocol.default TCP
66+
67+
@# Preserve fields for embedded metadata fields
68+
$(YQ_INTERNAL) w --inplace ./crds/operators.coreos.com_clusterserviceversions.yaml spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.install.properties.spec.properties.deployments.items.properties.spec.properties.template.properties.metadata.x-kubernetes-preserve-unknown-fields true
6569

6670
@# Update embedded CRD files.
6771
@go generate ./crds/...

‎crds/operators.coreos.com_catalogsources.yaml‎

Lines changed: 181 additions & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -1,190 +1,193 @@
1-
apiVersion: apiextensions.k8s.io/v1beta1
1+
apiVersion: apiextensions.k8s.io/v1
22
kind: CustomResourceDefinition
33
metadata:
4-
name: catalogsources.operators.coreos.com
54
annotations:
6-
displayName: CatalogSource
7-
description: A source configured to find packages and updates.
5+
controller-gen.kubebuilder.io/version: v0.2.8
6+
creationTimestamp: null
7+
name: catalogsources.operators.coreos.com
88
spec:
99
group: operators.coreos.com
10-
version: v1alpha1
11-
versions:
12-
- name: v1alpha1
13-
served: true
14-
storage: true
15-
preserveUnknownFields: false
16-
scope: Namespaced
1710
names:
18-
plural: catalogsources
19-
singular: catalogsource
11+
categories:
12+
- olm
2013
kind: CatalogSource
2114
listKind: CatalogSourceList
15+
plural: catalogsources
2216
shortNames:
2317
- catsrc
24-
categories:
25-
- olm
26-
additionalPrinterColumns:
27-
- name: Display
28-
type: string
29-
description: The pretty name of the catalog
30-
JSONPath: .spec.displayName
31-
- name: Type
32-
type: string
33-
description: The type of the catalog
34-
JSONPath: .spec.sourceType
35-
- name: Publisher
36-
type: string
37-
description: The publisher of the catalog
38-
JSONPath: .spec.publisher
39-
- name: Age
40-
type: date
41-
JSONPath: .metadata.creationTimestamp
42-
subresources:
43-
# status enables the status subresource.
44-
status: {}
45-
validation:
46-
openAPIV3Schema:
47-
description: CatalogSource is a repository of CSVs, CRDs, and operator packages.
48-
type: object
49-
required:
50-
- metadata
51-
- spec
52-
properties:
53-
apiVersion:
54-
description: 'APIVersion defines the versioned schema of this representation
55-
of an object. Servers should convert recognized schemas to the latest
56-
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
57-
type: string
58-
kind:
59-
description: 'Kind is a string value representing the REST resource this
60-
object represents. Servers may infer this from the endpoint the client
61-
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
62-
type: string
63-
metadata:
64-
type: object
65-
spec:
66-
type: object
67-
required:
68-
- sourceType
69-
properties:
70-
address:
71-
description: 'Address is a host that OLM can use to connect to a pre-existing
72-
registry. Format: <registry-host or ip>:<port> Only used when SourceType
73-
= SourceTypeGrpc. Ignored when the Image field is set.'
74-
type: string
75-
configMap:
76-
description: ConfigMap is the name of the ConfigMap to be used to back
77-
a configmap-server registry. Only used when SourceType = SourceTypeConfigmap
78-
or SourceTypeInternal.
79-
type: string
80-
description:
81-
type: string
82-
displayName:
83-
description: Metadata
84-
type: string
85-
icon:
86-
type: object
87-
required:
88-
- base64data
89-
- mediatype
90-
properties:
91-
base64data:
92-
type: string
93-
mediatype:
94-
type: string
95-
image:
96-
description: Image is an operator-registry container image to instantiate
97-
a registry-server with. Only used when SourceType = SourceTypeGrpc.
98-
If present, the address field is ignored.
99-
type: string
100-
publisher:
101-
type: string
102-
secrets:
103-
description: Secrets represent set of secrets that can be used to access
104-
the contents of the catalog. It is best to keep this list small, since
105-
each will need to be tried for every catalog entry.
106-
type: array
107-
items:
18+
singular: catalogsource
19+
scope: Namespaced
20+
versions:
21+
- additionalPrinterColumns:
22+
- description: The pretty name of the catalog
23+
jsonPath: .spec.displayName
24+
name: Display
25+
type: string
26+
- description: The type of the catalog
27+
jsonPath: .spec.sourceType
28+
name: Type
29+
type: string
30+
- description: The publisher of the catalog
31+
jsonPath: .spec.publisher
32+
name: Publisher
33+
type: string
34+
- jsonPath: .metadata.creationTimestamp
35+
name: Age
36+
type: date
37+
name: v1alpha1
38+
schema:
39+
openAPIV3Schema:
40+
description: CatalogSource is a repository of CSVs, CRDs, and operator packages.
41+
type: object
42+
required:
43+
- metadata
44+
- spec
45+
properties:
46+
apiVersion:
47+
description: 'APIVersion defines the versioned schema of this representation
48+
of an object. Servers should convert recognized schemas to the latest
49+
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
50+
type: string
51+
kind:
52+
description: 'Kind is a string value representing the REST resource this
53+
object represents. Servers may infer this from the endpoint the client
54+
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
55+
type: string
56+
metadata:
57+
type: object
58+
spec:
59+
type: object
60+
required:
61+
- sourceType
62+
properties:
63+
address:
64+
description: 'Address is a host that OLM can use to connect to a pre-existing
65+
registry. Format: <registry-host or ip>:<port> Only used when SourceType
66+
= SourceTypeGrpc. Ignored when the Image field is set.'
10867
type: string
109-
sourceType:
110-
description: SourceType is the type of source
111-
type: string
112-
updateStrategy:
113-
description: UpdateStrategy defines how updated catalog source images
114-
can be discovered Consists of an interval that defines polling duration
115-
and an embedded strategy type
116-
type: object
117-
properties:
118-
registryPoll:
119-
type: object
120-
properties:
121-
interval:
122-
description: Interval is used to determine the time interval
123-
between checks of the latest catalog source version. The catalog
124-
operator polls to see if a new version of the catalog source
125-
is available. If available, the latest image is pulled and
126-
gRPC traffic is directed to the latest catalog source.
127-
type: string
128-
status:
129-
type: object
130-
properties:
131-
configMapReference:
132-
type: object
133-
required:
134-
- name
135-
- namespace
136-
properties:
137-
lastUpdateTime:
138-
type: string
139-
format: date-time
140-
name:
141-
type: string
142-
namespace:
143-
type: string
144-
resourceVersion:
145-
type: string
146-
uid:
147-
description: UID is a type that holds unique ID values, including
148-
UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being
149-
a type captures intent and helps make sure that UIDs and names
150-
do not get conflated.
151-
type: string
152-
connectionState:
153-
type: object
154-
required:
155-
- lastObservedState
156-
properties:
157-
address:
158-
type: string
159-
lastConnect:
160-
type: string
161-
format: date-time
162-
lastObservedState:
163-
type: string
164-
latestImageRegistryPoll:
165-
description: The last time the CatalogSource image registry has been
166-
polled to ensure the image is up-to-date
167-
type: string
168-
format: date-time
169-
message:
170-
description: A human readable message indicating details about why the
171-
CatalogSource is in this condition.
172-
type: string
173-
reason:
174-
description: Reason is the reason the CatalogSource was transitioned
175-
to its current state.
176-
type: string
177-
registryService:
178-
type: object
179-
properties:
180-
createdAt:
181-
type: string
182-
format: date-time
183-
port:
184-
type: string
185-
protocol:
186-
type: string
187-
serviceName:
188-
type: string
189-
serviceNamespace:
68+
configMap:
69+
description: ConfigMap is the name of the ConfigMap to be used to
70+
back a configmap-server registry. Only used when SourceType = SourceTypeConfigmap
71+
or SourceTypeInternal.
72+
type: string
73+
description:
74+
type: string
75+
displayName:
76+
description: Metadata
77+
type: string
78+
icon:
79+
type: object
80+
required:
81+
- base64data
82+
- mediatype
83+
properties:
84+
base64data:
85+
type: string
86+
mediatype:
87+
type: string
88+
image:
89+
description: Image is an operator-registry container image to instantiate
90+
a registry-server with. Only used when SourceType = SourceTypeGrpc.
91+
If present, the address field is ignored.
92+
type: string
93+
publisher:
94+
type: string
95+
secrets:
96+
description: Secrets represent set of secrets that can be used to
97+
access the contents of the catalog. It is best to keep this list
98+
small, since each will need to be tried for every catalog entry.
99+
type: array
100+
items:
190101
type: string
102+
sourceType:
103+
description: SourceType is the type of source
104+
type: string
105+
updateStrategy:
106+
description: UpdateStrategy defines how updated catalog source images
107+
can be discovered Consists of an interval that defines polling duration
108+
and an embedded strategy type
109+
type: object
110+
properties:
111+
registryPoll:
112+
type: object
113+
properties:
114+
interval:
115+
description: Interval is used to determine the time interval
116+
between checks of the latest catalog source version. The
117+
catalog operator polls to see if a new version of the catalog
118+
source is available. If available, the latest image is pulled
119+
and gRPC traffic is directed to the latest catalog source.
120+
type: string
121+
status:
122+
type: object
123+
properties:
124+
configMapReference:
125+
type: object
126+
required:
127+
- name
128+
- namespace
129+
properties:
130+
lastUpdateTime:
131+
type: string
132+
format: date-time
133+
name:
134+
type: string
135+
namespace:
136+
type: string
137+
resourceVersion:
138+
type: string
139+
uid:
140+
description: UID is a type that holds unique ID values, including
141+
UUIDs. Because we don't ONLY use UUIDs, this is an alias to
142+
string. Being a type captures intent and helps make sure that
143+
UIDs and names do not get conflated.
144+
type: string
145+
connectionState:
146+
type: object
147+
required:
148+
- lastObservedState
149+
properties:
150+
address:
151+
type: string
152+
lastConnect:
153+
type: string
154+
format: date-time
155+
lastObservedState:
156+
type: string
157+
latestImageRegistryPoll:
158+
description: The last time the CatalogSource image registry has been
159+
polled to ensure the image is up-to-date
160+
type: string
161+
format: date-time
162+
message:
163+
description: A human readable message indicating details about why
164+
the CatalogSource is in this condition.
165+
type: string
166+
reason:
167+
description: Reason is the reason the CatalogSource was transitioned
168+
to its current state.
169+
type: string
170+
registryService:
171+
type: object
172+
properties:
173+
createdAt:
174+
type: string
175+
format: date-time
176+
port:
177+
type: string
178+
protocol:
179+
type: string
180+
serviceName:
181+
type: string
182+
serviceNamespace:
183+
type: string
184+
served: true
185+
storage: true
186+
subresources:
187+
status: {}
188+
status:
189+
acceptedNames:
190+
kind: ""
191+
plural: ""
192+
conditions: []
193+
storedVersions: []

0 commit comments

Comments
 (0)