Generate crd docs (vmware-tanzu#938) (vmware-tanzu#939)

Generate crd docs and improve some descriptions in crd

Signed-off-by: Yanjun Zhou <[email protected]>

.crd-ref-docs/config.yaml

@@ -0,0 +1,7 @@
+processor:
+  ignoreTypes:
+  - ".*List$"
+  ignoreFields:
+  - "TypeMeta$"
+render:
+  kubernetesVersion: 1.24

Makefile

@@ -160,6 +160,27 @@ code-generator: ## Download code-generator locally if necessary.
 generated: code-generator
 	./hack/update-codegen.sh
 
+CRD_REF_DOCS = $(shell pwd)/bin/crd-ref-docs
+.PHONY: crd-ref-docs
+crd-ref-docs: ## Install crd-ref-docs
+	$(call go-get-tool,$(CRD_REF_DOCS),github.com/elastic/[email protected])
+
+.PHONY: generate-api-docs
+generate-api-docs: crd-ref-docs
+generate-api-docs: ## Generate API documentation
+	$(CRD_REF_DOCS) \
+	  --renderer=markdown \
+	  --source-path=./pkg/apis/vpc/v1alpha1 \
+	  --config=./.crd-ref-docs/config.yaml \
+	  --output-path=./docs/ref/apis/
+	mv ./docs/ref/apis/out.md ./docs/ref/apis/vpc.md
+	$(CRD_REF_DOCS) \
+	  --renderer=markdown \
+	  --source-path=./pkg/apis/legacy/v1alpha1 \
+	  --config=./.crd-ref-docs/config.yaml \
+	  --output-path=./docs/ref/apis/
+	mv ./docs/ref/apis/out.md ./docs/ref/apis/legacy.md
+
 ENVTEST = $(shell pwd)/bin/setup-envtest
 .PHONY: envtest
 envtest: ## Download envtest-setup locally if necessary.

build/yaml/crd/vpc/crd.nsx.vmware.com_addressbindings.yaml

@@ -80,6 +80,7 @@ spec:
                   type: object
                 type: array
               ipAddress:
+                description: IP Address for port binding.
                 type: string
             required:
             - ipAddress

build/yaml/crd/vpc/crd.nsx.vmware.com_subnetports.yaml

@@ -67,9 +67,10 @@ spec:
             description: SubnetPortStatus defines the observed state of SubnetPort.
             properties:
               attachment:
-                description: Subnet port attachment state.
+                description: SubnetPort attachment state.
                 properties:
                   id:
+                    description: ID of the SubnetPort VIF attachment.
                     type: string
                 type: object
               conditions:
@@ -107,15 +108,18 @@ spec:
                     items:
                       properties:
                         gateway:
+                          description: Gateway address of the Subnet.
                           type: string
                         ipAddress:
                           description: IP address string with the prefix.
                           type: string
                       type: object
                     type: array
                   logicalSwitchUUID:
+                    description: The realization id of the SubnetPort
                     type: string
                   macAddress:
+                    description: The MAC address.
                     type: string
                 type: object
             type: object

build/yaml/crd/vpc/crd.nsx.vmware.com_subnets.yaml

@@ -114,6 +114,7 @@ spec:
             description: SubnetStatus defines the observed state of Subnet.
             properties:
               DHCPServerAddresses:
+                description: DHCP server IP address.
                 items:
                   type: string
                 type: array
@@ -146,10 +147,12 @@ spec:
                   type: object
                 type: array
               gatewayAddresses:
+                description: Gateway address of the Subnet.
                 items:
                   type: string
                 type: array
               networkAddresses:
+                description: Network address of the Subnet.
                 items:
                   type: string
                 type: array

build/yaml/crd/vpc/crd.nsx.vmware.com_subnetsets.yaml

@@ -72,7 +72,7 @@ spec:
                 - message: Value is immutable
                   rule: self == oldSelf
               subnetDHCPConfig:
-                description: DHCPConfig DHCP configuration.
+                description: Subnet DHCP configuration.
                 properties:
                   mode:
                     description: |-
@@ -135,14 +135,17 @@ spec:
                     of a SubnetSet.
                   properties:
                     DHCPServerAddresses:
+                      description: Dhcp server IP address.
                       items:
                         type: string
                       type: array
                     gatewayAddresses:
+                      description: Gateway address of the Subnet.
                       items:
                         type: string
                       type: array
                     networkAddresses:
+                      description: Network address of the Subnet.
                       items:
                         type: string
                       type: array