Skip to content

Commit ec062cc

Browse files
lucacomelucacome
committed
Use custom template
1 parent 8ce27a7 commit ec062cc

File tree

3 files changed

+84
-53
lines changed

3 files changed

+84
-53
lines changed

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ lint-helm: ## Run the helm chart linter
193193

194194
.PHONY: helm-docs
195195
helm-docs: ## Generate the Helm chart documentation
196-
docker run --pull always --rm -v $(CURDIR):/nginx-gateway-fabric -w /nginx-gateway-fabric jnorwood/helm-docs:latest --chart-search-root=charts
196+
docker run --pull always --rm -v $(CURDIR):/nginx-gateway-fabric -w /nginx-gateway-fabric jnorwood/helm-docs:latest --chart-search-root=charts --template-files _templates.gotmpl --template-files README.md.gotmpl
197197

198198
.PHONY: load-images
199199
load-images: ## Load NGF and NGINX images on configured kind cluster.

‎charts/nginx-gateway-fabric/README.md

+53-52
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# NGINX Gateway Fabric Helm Chart
23

34
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
@@ -250,58 +251,58 @@ kubectl kustomize https://github.com/nginxinc/nginx-gateway-fabric/config/crd/ga
250251

251252
## Configuration
252253

253-
The following tables lists the configurable parameters of the NGINX Gateway Fabric chart and their default values.
254-
255-
| Key | Type | Default | Description |
256-
|-----|------|---------|-------------|
257-
| affinity | object | `{}` | The affinity of the NGINX Gateway Fabric pod. |
258-
| extraVolumes | list | `[]` | extraVolumes for the NGINX Gateway Fabric pod. Use in conjunction with nginxGateway.extraVolumeMounts and nginx.extraVolumeMounts to mount additional volumes to the containers. |
259-
| metrics.enable | bool | `true` | Enable exposing metrics in the Prometheus format. |
260-
| metrics.port | int | `9113` | Set the port where the Prometheus metrics are exposed. Format: [1024 - 65535] |
261-
| metrics.secure | bool | `false` | Enable serving metrics via https. By default metrics are served via http. Please note that this endpoint will be secured with a self-signed certificate. |
262-
| nginx.config | object | `{}` | The configuration for the data plane that is contained in the NginxProxy resource. |
263-
| nginx.extraVolumeMounts | list | `[]` | extraVolumeMounts are the additional volume mounts for the nginx container. |
264-
| nginx.image.pullPolicy | string | `"Always"` | |
265-
| nginx.image.repository | string | `"ghcr.io/nginxinc/nginx-gateway-fabric/nginx"` | The NGINX image to use. |
266-
| nginx.image.tag | string | `"edge"` | |
267-
| nginx.lifecycle | object | `{}` | The lifecycle of the nginx container. |
268-
| nginx.plus | bool | `false` | Is NGINX Plus image being used |
269-
| nginx.usage.clusterName | string | `""` | The display name of the Kubernetes cluster in the NGINX Plus usage reporting server. |
270-
| nginx.usage.insecureSkipVerify | bool | `false` | Disable client verification of the NGINX Plus usage reporting server certificate. |
271-
| nginx.usage.secretName | string | `""` | The namespace/name of the Secret containing the credentials for NGINX Plus usage reporting. |
272-
| nginx.usage.serverURL | string | `""` | The base server URL of the NGINX Plus usage reporting server. |
273-
| nginxGateway.config.logging.level | string | `"info"` | Log level. Supported values "info", "debug", "error". |
274-
| nginxGateway.configAnnotations | object | `{}` | Set of custom annotations for NginxGateway objects. |
275-
| nginxGateway.extraVolumeMounts | list | `[]` | extraVolumeMounts are the additional volume mounts for the nginx-gateway container. |
276-
| nginxGateway.gatewayClassAnnotations | object | `{}` | Set of custom annotations for GatewayClass objects. |
277-
| nginxGateway.gatewayClassName | string | `"nginx"` | The name of the GatewayClass that will be created as part of this release. Every NGINX Gateway Fabric must have a unique corresponding GatewayClass resource. NGINX Gateway Fabric only processes resources that belong to its class - i.e. have the "gatewayClassName" field resource equal to the class. |
278-
| nginxGateway.gatewayControllerName | string | `"gateway.nginx.org/nginx-gateway-controller"` | The name of the Gateway controller. The controller name must be of the form: DOMAIN/PATH. The controller's domain is gateway.nginx.org. |
279-
| nginxGateway.gwAPIExperimentalFeatures.enable | bool | `false` | Enable the experimental features of Gateway API which are supported by NGINX Gateway Fabric. Requires the Gateway APIs installed from the experimental channel. |
280-
| nginxGateway.image.pullPolicy | string | `"Always"` | |
281-
| nginxGateway.image.repository | string | `"ghcr.io/nginxinc/nginx-gateway-fabric"` | The NGINX Gateway Fabric image to use |
282-
| nginxGateway.image.tag | string | `"edge"` | |
283-
| nginxGateway.kind | string | `"deployment"` | The kind of the NGINX Gateway Fabric installation - currently, only deployment is supported. |
284-
| nginxGateway.leaderElection.enable | bool | `true` | Enable leader election. Leader election is used to avoid multiple replicas of the NGINX Gateway Fabric reporting the status of the Gateway API resources. If not enabled, all replicas of NGINX Gateway Fabric will update the statuses of the Gateway API resources. |
285-
| nginxGateway.leaderElection.lockName | string | Autogenerated if not set or set to "". | The name of the leader election lock. A Lease object with this name will be created in the same Namespace as the controller. |
286-
| nginxGateway.lifecycle | object | `{}` | The lifecycle of the nginx-gateway container. |
287-
| nginxGateway.productTelemetry.enable | bool | `true` | Enable the collection of product telemetry. |
288-
| nginxGateway.readinessProbe.enable | bool | `true` | Enable the /readyz endpoint on the control plane. |
289-
| nginxGateway.readinessProbe.initialDelaySeconds | int | `3` | The number of seconds after the Pod has started before the readiness probes are initiated. |
290-
| nginxGateway.readinessProbe.port | int | `8081` | Port in which the readiness endpoint is exposed. |
291-
| nginxGateway.replicaCount | int | `1` | The number of replicas of the NGINX Gateway Fabric Deployment. |
292-
| nginxGateway.securityContext.allowPrivilegeEscalation | bool | `false` | Some environments may need this set to true in order for the control plane to successfully reload NGINX. |
293-
| nodeSelector | object | `{}` | The nodeSelector of the NGINX Gateway Fabric pod. |
294-
| service.annotations | object | `{}` | The annotations of the NGINX Gateway Fabric service. |
295-
| service.create | bool | `true` | Creates a service to expose the NGINX Gateway Fabric pods. |
296-
| service.externalTrafficPolicy | string | `"Local"` | The externalTrafficPolicy of the service. The value Local preserves the client source IP. |
297-
| service.ports | list | `[{"name":"http","port":80,"protocol":"TCP","targetPort":80},{"name":"https","port":443,"protocol":"TCP","targetPort":443}]` | A list of ports to expose through the NGINX Gateway Fabric service. Update it to match the listener ports from your Gateway resource. Follows the conventional Kubernetes yaml syntax for service ports. |
298-
| service.type | string | `"LoadBalancer"` | The type of service to create for the NGINX Gateway Fabric. |
299-
| serviceAccount.annotations | object | `{}` | |
300-
| serviceAccount.imagePullSecret | string | `""` | The name of the secret containing docker registry credentials. Secret must exist in the same namespace as the helm release. |
301-
| serviceAccount.imagePullSecrets | list | `[]` | A list of secret names containing docker registry credentials. Secrets must exist in the same namespace as the helm release. |
302-
| serviceAccount.name | string | Autogenerated if not set or set to "" | The name of the service account of the NGINX Gateway Fabric pods. Used for RBAC. |
303-
| terminationGracePeriodSeconds | int | `30` | The termination grace period of the NGINX Gateway Fabric pod. |
304-
| tolerations | list | `[]` | Tolerations for the NGINX Gateway Fabric pod. |
254+
The following table lists the configurable parameters of the NGINX Gateway Fabric chart and their default values.
255+
256+
| Key | Description | Type | Default |
257+
|-----|-------------|------|---------|
258+
| `affinity` | The affinity of the NGINX Gateway Fabric pod. | object | `{}` |
259+
| `extraVolumes` | extraVolumes for the NGINX Gateway Fabric pod. Use in conjunction with nginxGateway.extraVolumeMounts and nginx.extraVolumeMounts to mount additional volumes to the containers. | list | `[]` |
260+
| `metrics.enable` | Enable exposing metrics in the Prometheus format. | bool | `true` |
261+
| `metrics.port` | Set the port where the Prometheus metrics are exposed. Format: [1024 - 65535] | int | `9113` |
262+
| `metrics.secure` | Enable serving metrics via https. By default metrics are served via http. Please note that this endpoint will be secured with a self-signed certificate. | bool | `false` |
263+
| `nginx.config` | The configuration for the data plane that is contained in the NginxProxy resource. | object | `{}` |
264+
| `nginx.extraVolumeMounts` | extraVolumeMounts are the additional volume mounts for the nginx container. | list | `[]` |
265+
| `nginx.image.pullPolicy` | | string | `"Always"` |
266+
| `nginx.image.repository` | The NGINX image to use. | string | `"ghcr.io/nginxinc/nginx-gateway-fabric/nginx"` |
267+
| `nginx.image.tag` | | string | `"edge"` |
268+
| `nginx.lifecycle` | The lifecycle of the nginx container. | object | `{}` |
269+
| `nginx.plus` | Is NGINX Plus image being used | bool | `false` |
270+
| `nginx.usage.clusterName` | The display name of the Kubernetes cluster in the NGINX Plus usage reporting server. | string | `""` |
271+
| `nginx.usage.insecureSkipVerify` | Disable client verification of the NGINX Plus usage reporting server certificate. | bool | `false` |
272+
| `nginx.usage.secretName` | The namespace/name of the Secret containing the credentials for NGINX Plus usage reporting. | string | `""` |
273+
| `nginx.usage.serverURL` | The base server URL of the NGINX Plus usage reporting server. | string | `""` |
274+
| `nginxGateway.config.logging.level` | Log level. Supported values "info", "debug", "error". | string | `"info"` |
275+
| `nginxGateway.configAnnotations` | Set of custom annotations for NginxGateway objects. | object | `{}` |
276+
| `nginxGateway.extraVolumeMounts` | extraVolumeMounts are the additional volume mounts for the nginx-gateway container. | list | `[]` |
277+
| `nginxGateway.gatewayClassAnnotations` | Set of custom annotations for GatewayClass objects. | object | `{}` |
278+
| `nginxGateway.gatewayClassName` | The name of the GatewayClass that will be created as part of this release. Every NGINX Gateway Fabric must have a unique corresponding GatewayClass resource. NGINX Gateway Fabric only processes resources that belong to its class - i.e. have the "gatewayClassName" field resource equal to the class. | string | `"nginx"` |
279+
| `nginxGateway.gatewayControllerName` | The name of the Gateway controller. The controller name must be of the form: DOMAIN/PATH. The controller's domain is gateway.nginx.org. | string | `"gateway.nginx.org/nginx-gateway-controller"` |
280+
| `nginxGateway.gwAPIExperimentalFeatures.enable` | Enable the experimental features of Gateway API which are supported by NGINX Gateway Fabric. Requires the Gateway APIs installed from the experimental channel. | bool | `false` |
281+
| `nginxGateway.image.pullPolicy` | | string | `"Always"` |
282+
| `nginxGateway.image.repository` | The NGINX Gateway Fabric image to use | string | `"ghcr.io/nginxinc/nginx-gateway-fabric"` |
283+
| `nginxGateway.image.tag` | | string | `"edge"` |
284+
| `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only deployment is supported. | string | `"deployment"` |
285+
| `nginxGateway.leaderElection.enable` | Enable leader election. Leader election is used to avoid multiple replicas of the NGINX Gateway Fabric reporting the status of the Gateway API resources. If not enabled, all replicas of NGINX Gateway Fabric will update the statuses of the Gateway API resources. | bool | `true` |
286+
| `nginxGateway.leaderElection.lockName` | The name of the leader election lock. A Lease object with this name will be created in the same Namespace as the controller. | string | Autogenerated if not set or set to "". |
287+
| `nginxGateway.lifecycle` | The lifecycle of the nginx-gateway container. | object | `{}` |
288+
| `nginxGateway.productTelemetry.enable` | Enable the collection of product telemetry. | bool | `true` |
289+
| `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | bool | `true` |
290+
| `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | int | `3` |
291+
| `nginxGateway.readinessProbe.port` | Port in which the readiness endpoint is exposed. | int | `8081` |
292+
| `nginxGateway.replicaCount` | The number of replicas of the NGINX Gateway Fabric Deployment. | int | `1` |
293+
| `nginxGateway.securityContext.allowPrivilegeEscalation` | Some environments may need this set to true in order for the control plane to successfully reload NGINX. | bool | `false` |
294+
| `nodeSelector` | The nodeSelector of the NGINX Gateway Fabric pod. | object | `{}` |
295+
| `service.annotations` | The annotations of the NGINX Gateway Fabric service. | object | `{}` |
296+
| `service.create` | Creates a service to expose the NGINX Gateway Fabric pods. | bool | `true` |
297+
| `service.externalTrafficPolicy` | The externalTrafficPolicy of the service. The value Local preserves the client source IP. | string | `"Local"` |
298+
| `service.ports` | A list of ports to expose through the NGINX Gateway Fabric service. Update it to match the listener ports from your Gateway resource. Follows the conventional Kubernetes yaml syntax for service ports. | list | `[{"name":"http","port":80,"protocol":"TCP","targetPort":80},{"name":"https","port":443,"protocol":"TCP","targetPort":443}]` |
299+
| `service.type` | The type of service to create for the NGINX Gateway Fabric. | string | `"LoadBalancer"` |
300+
| `serviceAccount.annotations` | | object | `{}` |
301+
| `serviceAccount.imagePullSecret` | The name of the secret containing docker registry credentials. Secret must exist in the same namespace as the helm release. | string | `""` |
302+
| `serviceAccount.imagePullSecrets` | A list of secret names containing docker registry credentials. Secrets must exist in the same namespace as the helm release. | list | `[]` |
303+
| `serviceAccount.name` | The name of the service account of the NGINX Gateway Fabric pods. Used for RBAC. | string | Autogenerated if not set or set to "" |
304+
| `terminationGracePeriodSeconds` | The termination grace period of the NGINX Gateway Fabric pod. | int | `30` |
305+
| `tolerations` | Tolerations for the NGINX Gateway Fabric pod. | list | `[]` |
305306

306307
----------------------------------------------
307308
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

‎charts/nginx-gateway-fabric/_templates.gotmpl

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{{ define "chart.valuesTable" }}
2+
{{ if .Sections.Sections }}
3+
{{ range .Sections.Sections }}
4+
5+
### {{ .SectionName }}
6+
7+
| Key | Description | Type | Default |
8+
|-----|-------------|------|---------|
9+
{{- range .SectionItems }}
10+
| `{{ .Key }}` | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} |
11+
{{- end }}
12+
{{- end }}
13+
{{ if .Sections.DefaultSection.SectionItems}}
14+
15+
### {{ .Sections.DefaultSection.SectionName }}
16+
17+
| Key | Description | Type | Default |
18+
|-----|-------------|------|---------|
19+
{{- range .Sections.DefaultSection.SectionItems }}
20+
| `{{ .Key }}` | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} |
21+
{{- end }}
22+
{{ end }}
23+
{{ else }}
24+
| Key | Description | Type | Default |
25+
|-----|-------------|------|---------|
26+
{{- range .Values }}
27+
| `{{ .Key }}` | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} |
28+
{{- end }}
29+
{{ end }}
30+
{{ end }}

0 commit comments

Comments
 (0)