diff --git a/Makefile b/Makefile index 223f4b6..3089151 100644 --- a/Makefile +++ b/Makefile @@ -81,20 +81,20 @@ copy-local-helm-chart: | $(HELM_CHART_DEP_ROOT) clean-helm-chart-dep-root cp -r $(HELM_CHART_PATH) $(HELM_CHART_DEP_ROOT) # Generate helm chart documentation in a reStructuredText format. -.PHONY: helm-docs -helm-docs: | $(HELM_DOCS) +.PHONY: gen-helm-docs +gen-helm-docs: | $(HELM_DOCS) $(HELM_DOCS) --output-file=../../../../docs/customizations/helm.rst \ --ignore-file=.helmdocsignore \ --template-files=./templates/helm.rst.gotmpl ${HELM_CHART_DEP_ROOT} .PHONY: ngc-helm-docs -ngc-helm-docs: download-ngc-helm-chart helm-docs +ngc-helm-docs: download-ngc-helm-chart gen-helm-docs .PHONY: helm-docs -helm-docs: download-helm-chart helm-docs +helm-docs: download-helm-chart gen-helm-docs .PHONY: local-helm-docs -local-helm-docs: copy-local-helm-chart helm-docs +local-helm-docs: copy-local-helm-chart gen-helm-docs .PHONY: download-api download-api: | $(CRD_API_DEP_ROOT) diff --git a/docs/customizations/helm.rst b/docs/customizations/helm.rst index ea1bf0a..7a84e31 100644 --- a/docs/customizations/helm.rst +++ b/docs/customizations/helm.rst @@ -67,8 +67,23 @@ General Parameters - `true` - Use cert-manager for generating self-signed certificate. * - operator.affinity.nodeAffinity - - object - - `{"preferredDuringSchedulingIgnoredDuringExecution":[{"preference":{"matchExpressions":[{"key":"node-role.kubernetes.io/master","operator":"In","values":[""]}]},"weight":1},{"preference":{"matchExpressions":[{"key":"node-role.kubernetes.io/control-plane","operator":"In","values":[""]}]},"weight":1}]}` + - yaml + - .. code-block:: yaml + + preferredDuringSchedulingIgnoredDuringExecution: + - weight: 1 + preference: + matchExpressions: + - key: "node-role.kubernetes.io/master" + operator: In + values: [""] + - weight: 1 + preference: + matchExpressions: + - key: "node-role.kubernetes.io/control-plane" + operator: In + values: [""] + - Configure node affinity settings for the operator. * - operator.cniBinDirectory - string @@ -95,12 +110,30 @@ General Parameters - `"nvcr.io/nvidia/cloud-native"` - Network Operator image repository. * - operator.resources - - object - - `{"limits":{"cpu":"500m","memory":"128Mi"},"requests":{"cpu":"5m","memory":"64Mi"}}` + - yaml + - .. code-block:: yaml + + limits: + cpu: 500m + memory: 128Mi + requests: + cpu: 5m + memory: 64Mi + - Optional `resource requests and limits `_ for the operator. * - operator.tolerations - - list - - `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Equal","value":""},{"effect":"NoSchedule","key":"node-role.kubernetes.io/control-plane","operator":"Equal","value":""}]` + - yaml + - .. code-block:: yaml + + - key: "node-role.kubernetes.io/master" + operator: "Equal" + value: "" + effect: "NoSchedule" + - key: "node-role.kubernetes.io/control-plane" + operator: "Equal" + value: "" + effect: "NoSchedule" + - Set additional tolerations for various Daemonsets deployed by the operator. * - operator.useDTK - bool @@ -181,12 +214,44 @@ Node Feature Discovery Helm chart customization options can be found `here and list of devices. * - rdmaSharedDevicePlugin.useCdi - bool diff --git a/templates/helm.rst.gotmpl b/templates/helm.rst.gotmpl index d0013b8..8444f84 100644 --- a/templates/helm.rst.gotmpl +++ b/templates/helm.rst.gotmpl @@ -50,7 +50,9 @@ General Parameters (hasPrefix "node-feature-discovery" .Key))) }} * - {{ .Key }} - {{ .Type }} - - {{ if .Default }}{{ .Default }}{{ else }}{{ "" }}{{ end }} + - {{ if eq .Type "yaml" }}.. code-block:: yaml + +{{ .Default | indent 10}}{{ else }}{{ .Default }}{{ end }} - {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} {{- end }} {{- end }} @@ -104,7 +106,9 @@ Node Feature Discovery Helm chart customization options can be found `here