Skip to content

Commit b0c3cd7

Browse files
committed
update the doc for crds: the files in this list should be openAPI definition
1 parent f4eef1d commit b0c3cd7

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/kustomization.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ patchesJson6902:
201201
path: add_service_annotation.yaml
202202

203203
# Each entry in this list should be a relative path to
204-
# a file for custom resource definition(CRD).
204+
# a file for custom resource definition(CRD) in openAPI definition.
205205
#
206206
# The presence of this field is to allow kustomize be
207207
# aware of CRDs and apply proper
@@ -211,9 +211,17 @@ patchesJson6902:
211211
# In kustomization, the ConfigMap object name may change by adding namePrefix, nameSuffix, or hashing
212212
# The name reference for this ConfigMap object in CRD object need to be
213213
# updated with namePrefix, nameSuffix, or hashing in the same way.
214+
#
215+
# The annotations can be put into openAPI definitions are:
216+
# "x-kubernetes-annotation": ""
217+
# "x-kubernetes-label-selector": ""
218+
# "x-kubernetes-identity": ""
219+
# "x-kubernetes-object-ref-api-version": "v1",
220+
# "x-kubernetes-object-ref-kind": "Secret",
221+
# "x-kubernetes-object-ref-name-key": "name",
214222
crds:
215-
- crds/typeA.yaml
216-
- crds/typeB.yaml
223+
- crds/typeA.json
224+
- crds/typeB.json
217225

218226
# Vars are used to capture text from one resource's field
219227
# and insert that text elsewhere.

0 commit comments

Comments
 (0)