Skip to content

Commit bbef6bb

Browse files
committed
add a sample markdown doc for CRD types
1 parent 9825799 commit bbef6bb

File tree

3 files changed

+22511
-0
lines changed

3 files changed

+22511
-0
lines changed

Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,13 @@ bundle: manifests
132132
bundle-build:
133133
docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
134134

135+
generate-crd-docs:
136+
# Generate yamls with full desciption values
137+
$(CONTROLLER_GEN) "crd" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
138+
docker run -u $(id -u):$(id -g) --rm -v ${PWD}:/workdir ghcr.io/fybrik/crdoc:latest --resources /workdir/config/crd/bases --output /workdir/docs/crd-generated.md --template /workdir/docs/crd.tmpl
139+
# Restore yamls to the original state
140+
$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
141+
135142
# ===============================================================
136143
# This section is only about the HELM deployment of the operator
137144
# ===============================================================

config/crd/bases/k6.io_privateloadzones.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ spec:
6161
type: array
6262
type: object
6363
image:
64+
default: grafana/k6:latest
6465
type: string
6566
imagePullSecrets:
6667
items:

0 commit comments

Comments
 (0)