From d6d797065196f8c548ff2c9af136e13a142a657a Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Mon, 29 Apr 2024 18:55:10 +0300 Subject: [PATCH 1/6] Add custom annotations into GatewayClass and NginxGateway manifests --- charts/nginx-gateway-fabric/templates/gatewayclass.yaml | 6 ++++++ charts/nginx-gateway-fabric/templates/nginxgateway.yaml | 6 ++++++ charts/nginx-gateway-fabric/values.yaml | 8 ++++++++ 3 files changed, 20 insertions(+) diff --git a/charts/nginx-gateway-fabric/templates/gatewayclass.yaml b/charts/nginx-gateway-fabric/templates/gatewayclass.yaml index 9bb6a01c1..e5dbdd020 100644 --- a/charts/nginx-gateway-fabric/templates/gatewayclass.yaml +++ b/charts/nginx-gateway-fabric/templates/gatewayclass.yaml @@ -4,5 +4,11 @@ metadata: name: {{ .Values.nginxGateway.gatewayClassName }} labels: {{- include "nginx-gateway.labels" . | nindent 4 }} + {{- if .Values.nginxGateway.gatewayClassCustomAnnotations }} + annotations: + {{- range $key, $value := .Values.nginxGateway.gatewayClassCustomAnnotations }} + {{ printf "%s: %s" $key $value }} + {{- end }} + {{- end }} spec: controllerName: {{ .Values.nginxGateway.gatewayControllerName }} diff --git a/charts/nginx-gateway-fabric/templates/nginxgateway.yaml b/charts/nginx-gateway-fabric/templates/nginxgateway.yaml index 0385e44a0..5cd3a4901 100644 --- a/charts/nginx-gateway-fabric/templates/nginxgateway.yaml +++ b/charts/nginx-gateway-fabric/templates/nginxgateway.yaml @@ -5,5 +5,11 @@ metadata: namespace: {{ .Release.Namespace }} labels: {{- include "nginx-gateway.labels" . | nindent 4 }} + {{- if .Values.nginxGateway.nginxGatewayCustomAnnotations }} + annotations: + {{- range $key, $value := .Values.nginxGateway.nginxGatewayCustomAnnotations }} + {{ printf "%s: %s" $key $value }} + {{- end }} + {{- end }} spec: {{- toYaml .Values.nginxGateway.config | nindent 2 }} diff --git a/charts/nginx-gateway-fabric/values.yaml b/charts/nginx-gateway-fabric/values.yaml index c0dbe5eb6..74e19df89 100644 --- a/charts/nginx-gateway-fabric/values.yaml +++ b/charts/nginx-gateway-fabric/values.yaml @@ -1,4 +1,12 @@ nginxGateway: + ## Set of custom annotations for GatewayClass objects, e.g: + ## gatewayClassCustomAnnotations: + ## someKey: someValue + gatewayClassCustomAnnotations: {} + ## Set of custom annotations for NginxGateway objects, e.g: + ## nginxGatewayCustomAnnotations: + ## someKey: someValue + nginxGatewayCustomAnnotations: {} ## The kind of the NGINX Gateway Fabric installation - currently, only deployment is supported. kind: deployment ## gatewayClassName is the name of the GatewayClass that will be created as part of this release. Every NGINX Gateway From 84e64db25f9e3d9f98a992ee37ff76d5e0f2e069 Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Mon, 29 Apr 2024 19:39:52 +0300 Subject: [PATCH 2/6] update README.md --- charts/nginx-gateway-fabric/README.md | 92 ++++++++++++++------------- 1 file changed, 47 insertions(+), 45 deletions(-) diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md index bc6871d5e..082d78d0e 100644 --- a/charts/nginx-gateway-fabric/README.md +++ b/charts/nginx-gateway-fabric/README.md @@ -245,48 +245,50 @@ kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/downlo The following tables lists the configurable parameters of the NGINX Gateway Fabric chart and their default values. -| Parameter | Description | Default Value | -| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `nginxGateway.image.repository` | The repository for the NGINX Gateway Fabric image. | ghcr.io/nginxinc/nginx-gateway-fabric | -| `nginxGateway.image.tag` | The tag for the NGINX Gateway Fabric image. | edge | -| `nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Gateway Fabric image. | Always | -| `nginxGateway.lifecycle` | The `lifecycle` of the nginx-gateway container. | {} | -| `nginxGateway.extraVolumeMounts` | Extra `volumeMounts` for the nginxGateway container. | {} | -| `nginxGateway.gatewayClassName` | The name of the GatewayClass for the NGINX Gateway Fabric deployment. | nginx | -| `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. | gateway.nginx.org/nginx-gateway-controller | -| `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only Deployment is supported. | deployment | -| `nginxGateway.config` | The dynamic configuration for the control plane that is contained in the NginxGateway resource | [See nginxGateway.config section](values.yaml) | -| `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | true | -| `nginxGateway.readinessProbe.port` | Port in which the readiness endpoint is exposed. | 8081 | -| `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | 3 | -| `nginxGateway.replicaCount` | The number of replicas of the NGINX Gateway Fabric Deployment. | 1 | -| `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. | true | -| `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. | Autogenerated | -| `nginxGateway.securityContext.allowPrivilegeEscalation` | Some environments may need this set to true in order for the control plane to successfully reload NGINX. | false | -| `nginxGateway.productTelemetry.enable` | Enable the collection of product telemetry. | true | -| `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. | false | -| `nginx.image.repository` | The repository for the NGINX image. | ghcr.io/nginxinc/nginx-gateway-fabric/nginx | -| `nginx.image.tag` | The tag for the NGINX image. | edge | -| `nginx.image.pullPolicy` | The `imagePullPolicy` for the NGINX image. | Always | -| `nginx.plus` | Is NGINX Plus image being used | false | -| `nginx.usage.secretName` | The namespace/name of the Secret containing the credentials for NGINX Plus usage reporting. | | -| `nginx.usage.serverURL` | The base server URL of the NGINX Plus usage reporting server. | | -| `nginx.usage.clusterName` | The display name of the Kubernetes cluster in the NGINX Plus usage reporting server. | | -| `nginx.usage.insecureSkipVerify` | Disable client verification of the NGINX Plus usage reporting server certificate. | false | -| `nginx.lifecycle` | The `lifecycle` of the nginx container. | {} | -| `nginx.extraVolumeMounts` | Extra `volumeMounts` for the nginx container. | {} | -| `terminationGracePeriodSeconds` | The termination grace period of the NGINX Gateway Fabric pod. | 30 | -| `tolerations` | The `tolerations` of the NGINX Gateway Fabric pod. | [] | -| `nodeSelector` | The `nodeSelector` of the NGINX Gateway Fabric pod. | {} | -| `affinity` | The `affinity` of the NGINX Gateway Fabric pod. | {} | -| `serviceAccount.annotations` | The `annotations` for the ServiceAccount used by the NGINX Gateway Fabric deployment. | {} | -| `serviceAccount.name` | Name of the ServiceAccount used by the NGINX Gateway Fabric deployment. | Autogenerated | -| `service.create` | Creates a service to expose the NGINX Gateway Fabric pods. | true | -| `service.type` | The type of service to create for the NGINX Gateway Fabric. | Loadbalancer | -| `service.externalTrafficPolicy` | The `externalTrafficPolicy` of the service. The value `Local` preserves the client source IP. | Local | -| `service.annotations` | The `annotations` of the NGINX Gateway Fabric service. | {} | -| `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. | [ port: 80, targetPort: 80, protocol: TCP, name: http; port: 443, targetPort: 443, protocol: TCP, name: https ] | -| `metrics.disable` | Disable exposing metrics in the Prometheus format. | false | -| `metrics.port` | Set the port where the Prometheus metrics are exposed. Format: [1024 - 65535] | 9113 | -| `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. | false | -| `extraVolumes` | Extra `volumes` for the NGINX Gateway Fabric pod. | [] | +| Parameter | Description | Default Value | +|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| `nginxGatewayCustomAnnotations` | Set of custom annotations | {} | +| `nginxGateway.image.repository` | The repository for the NGINX Gateway Fabric image. | ghcr.io/nginxinc/nginx-gateway-fabric | +| `nginxGateway.image.tag` | The tag for the NGINX Gateway Fabric image. | edge | +| `nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Gateway Fabric image. | Always | +| `nginxGateway.lifecycle` | The `lifecycle` of the nginx-gateway container. | {} | +| `nginxGateway.extraVolumeMounts` | Extra `volumeMounts` for the nginxGateway container. | {} | +| `nginxGateway.gatewayClassCustomAnnotations` | Set of custom annotations for GatewayClass objects | {} | +| `nginxGateway.gatewayClassName` | The name of the GatewayClass for the NGINX Gateway Fabric deployment. | nginx | +| `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. | gateway.nginx.org/nginx-gateway-controller | +| `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only Deployment is supported. | deployment | +| `nginxGateway.config` | The dynamic configuration for the control plane that is contained in the NginxGateway resource | [See nginxGateway.config section](values.yaml) | +| `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | true | +| `nginxGateway.readinessProbe.port` | Port in which the readiness endpoint is exposed. | 8081 | +| `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | 3 | +| `nginxGateway.replicaCount` | The number of replicas of the NGINX Gateway Fabric Deployment. | 1 | +| `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. | true | +| `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. | Autogenerated | +| `nginxGateway.securityContext.allowPrivilegeEscalation` | Some environments may need this set to true in order for the control plane to successfully reload NGINX. | false | +| `nginxGateway.productTelemetry.enable` | Enable the collection of product telemetry. | true | +| `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. | false | +| `nginx.image.repository` | The repository for the NGINX image. | ghcr.io/nginxinc/nginx-gateway-fabric/nginx | +| `nginx.image.tag` | The tag for the NGINX image. | edge | +| `nginx.image.pullPolicy` | The `imagePullPolicy` for the NGINX image. | Always | +| `nginx.plus` | Is NGINX Plus image being used | false | +| `nginx.usage.secretName` | The namespace/name of the Secret containing the credentials for NGINX Plus usage reporting. | | +| `nginx.usage.serverURL` | The base server URL of the NGINX Plus usage reporting server. | | +| `nginx.usage.clusterName` | The display name of the Kubernetes cluster in the NGINX Plus usage reporting server. | | +| `nginx.usage.insecureSkipVerify` | Disable client verification of the NGINX Plus usage reporting server certificate. | false | +| `nginx.lifecycle` | The `lifecycle` of the nginx container. | {} | +| `nginx.extraVolumeMounts` | Extra `volumeMounts` for the nginx container. | {} | +| `terminationGracePeriodSeconds` | The termination grace period of the NGINX Gateway Fabric pod. | 30 | +| `tolerations` | The `tolerations` of the NGINX Gateway Fabric pod. | [] | +| `nodeSelector` | The `nodeSelector` of the NGINX Gateway Fabric pod. | {} | +| `affinity` | The `affinity` of the NGINX Gateway Fabric pod. | {} | +| `serviceAccount.annotations` | The `annotations` for the ServiceAccount used by the NGINX Gateway Fabric deployment. | {} | +| `serviceAccount.name` | Name of the ServiceAccount used by the NGINX Gateway Fabric deployment. | Autogenerated | +| `service.create` | Creates a service to expose the NGINX Gateway Fabric pods. | true | +| `service.type` | The type of service to create for the NGINX Gateway Fabric. | Loadbalancer | +| `service.externalTrafficPolicy` | The `externalTrafficPolicy` of the service. The value `Local` preserves the client source IP. | Local | +| `service.annotations` | The `annotations` of the NGINX Gateway Fabric service. | {} | +| `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. | [ port: 80, targetPort: 80, protocol: TCP, name: http; port: 443, targetPort: 443, protocol: TCP, name: https ] | +| `metrics.disable` | Disable exposing metrics in the Prometheus format. | false | +| `metrics.port` | Set the port where the Prometheus metrics are exposed. Format: [1024 - 65535] | 9113 | +| `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. | false | +| `extraVolumes` | Extra `volumes` for the NGINX Gateway Fabric pod. | [] | From b2b761cddf6823670d9867c3171be16f7b6d68e9 Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Mon, 20 May 2024 17:49:09 +0300 Subject: [PATCH 3/6] fix according to the PR comments --- charts/nginx-gateway-fabric/README.md | 4 +++- .../templates/gatewayclass.yaml | 4 ++-- .../templates/nginxgateway.yaml | 4 ++-- charts/nginx-gateway-fabric/values.yaml | 16 ++++++++-------- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md index c6714495d..ad3158e19 100644 --- a/charts/nginx-gateway-fabric/README.md +++ b/charts/nginx-gateway-fabric/README.md @@ -246,16 +246,18 @@ kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/downlo The following tables lists the configurable parameters of the NGINX Gateway Fabric chart and their default values. | Parameter | Description | Default Value | -| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| ------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | `nginxGateway.image.repository` | The repository for the NGINX Gateway Fabric image. | ghcr.io/nginxinc/nginx-gateway-fabric | | `nginxGateway.image.tag` | The tag for the NGINX Gateway Fabric image. | edge | | `nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Gateway Fabric image. | Always | | `nginxGateway.lifecycle` | The `lifecycle` of the nginx-gateway container. | {} | | `nginxGateway.extraVolumeMounts` | Extra `volumeMounts` for the nginxGateway container. | {} | | `nginxGateway.gatewayClassName` | The name of the GatewayClass for the NGINX Gateway Fabric deployment. | nginx | +| `nginxGateway.gatewayClassAnnotat` | Set of custom annotations for GatewayClass objects. | {} | | `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. | gateway.nginx.org/nginx-gateway-controller | | `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only Deployment is supported. | deployment | | `nginxGateway.config` | The dynamic configuration for the control plane that is contained in the NginxGateway resource | [See nginxGateway.config section](values.yaml) | +| `nginxGateway.Annotations` | Set of custom annotations for NginxGateway objects. | {} | | `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | true | | `nginxGateway.readinessProbe.port` | Port in which the readiness endpoint is exposed. | 8081 | | `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | 3 | diff --git a/charts/nginx-gateway-fabric/templates/gatewayclass.yaml b/charts/nginx-gateway-fabric/templates/gatewayclass.yaml index bafbebd8a..ee08e1a72 100644 --- a/charts/nginx-gateway-fabric/templates/gatewayclass.yaml +++ b/charts/nginx-gateway-fabric/templates/gatewayclass.yaml @@ -4,9 +4,9 @@ metadata: name: {{ .Values.nginxGateway.gatewayClassName }} labels: {{- include "nginx-gateway.labels" . | nindent 4 }} - {{- if .Values.nginxGateway.gatewayClassCustomAnnotations }} + {{- if .Values.nginxGateway.gatewayClassAnnotations }} annotations: - {{- range $key, $value := .Values.nginxGateway.gatewayClassCustomAnnotations }} + {{- range $key, $value := .Values.nginxGateway.gatewayClassAnnotations }} {{ printf "%s: %s" $key $value }} {{- end }} {{- end }} diff --git a/charts/nginx-gateway-fabric/templates/nginxgateway.yaml b/charts/nginx-gateway-fabric/templates/nginxgateway.yaml index 5cd3a4901..40e9412b2 100644 --- a/charts/nginx-gateway-fabric/templates/nginxgateway.yaml +++ b/charts/nginx-gateway-fabric/templates/nginxgateway.yaml @@ -5,9 +5,9 @@ metadata: namespace: {{ .Release.Namespace }} labels: {{- include "nginx-gateway.labels" . | nindent 4 }} - {{- if .Values.nginxGateway.nginxGatewayCustomAnnotations }} + {{- if .Values.nginxGateway.configAnnotations }} annotations: - {{- range $key, $value := .Values.nginxGateway.nginxGatewayCustomAnnotations }} + {{- range $key, $value := .Values.nginxGateway.configAnnotations }} {{ printf "%s: %s" $key $value }} {{- end }} {{- end }} diff --git a/charts/nginx-gateway-fabric/values.yaml b/charts/nginx-gateway-fabric/values.yaml index 9b6df4217..e7c6bb41e 100644 --- a/charts/nginx-gateway-fabric/values.yaml +++ b/charts/nginx-gateway-fabric/values.yaml @@ -1,18 +1,14 @@ nginxGateway: - ## Set of custom annotations for GatewayClass objects, e.g: - ## gatewayClassCustomAnnotations: - ## someKey: someValue - gatewayClassCustomAnnotations: {} - ## Set of custom annotations for NginxGateway objects, e.g: - ## nginxGatewayCustomAnnotations: - ## someKey: someValue - nginxGatewayCustomAnnotations: {} ## The kind of the NGINX Gateway Fabric installation - currently, only deployment is supported. kind: deployment ## gatewayClassName is 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. gatewayClassName: nginx + ## Set of custom annotations for GatewayClass objects, e.g: + ## gatewayClassAnnotations: + ## someKey: someValue + gatewayClassAnnotations: {} ## The name of the Gateway controller. The controller name must be of the form: DOMAIN/PATH. The controller's domain ## is gateway.nginx.org. gatewayControllerName: gateway.nginx.org/nginx-gateway-controller @@ -21,6 +17,10 @@ nginxGateway: logging: ## Log level. Supported values "info", "debug", "error". level: info + ## Set of custom annotations for NginxGateway objects, e.g: + ## configAnnotations: + ## someKey: someValue + configAnnotations: {} ## The number of replicas of the NGINX Gateway Fabric Deployment. replicaCount: 1 ## The configuration for leader election. From f5c12d14b02d9fec50cba4780adc933958d72bc3 Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Tue, 21 May 2024 08:05:14 +0300 Subject: [PATCH 4/6] one more fix according to the PR comment --- charts/nginx-gateway-fabric/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md index ad3158e19..559d397f4 100644 --- a/charts/nginx-gateway-fabric/README.md +++ b/charts/nginx-gateway-fabric/README.md @@ -246,14 +246,14 @@ kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/downlo The following tables lists the configurable parameters of the NGINX Gateway Fabric chart and their default values. | Parameter | Description | Default Value | -| ------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | `nginxGateway.image.repository` | The repository for the NGINX Gateway Fabric image. | ghcr.io/nginxinc/nginx-gateway-fabric | | `nginxGateway.image.tag` | The tag for the NGINX Gateway Fabric image. | edge | | `nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Gateway Fabric image. | Always | | `nginxGateway.lifecycle` | The `lifecycle` of the nginx-gateway container. | {} | | `nginxGateway.extraVolumeMounts` | Extra `volumeMounts` for the nginxGateway container. | {} | | `nginxGateway.gatewayClassName` | The name of the GatewayClass for the NGINX Gateway Fabric deployment. | nginx | -| `nginxGateway.gatewayClassAnnotat` | Set of custom annotations for GatewayClass objects. | {} | +| `nginxGateway.gatewayClassAnnotations` | Set of custom annotations for GatewayClass objects. | {} | | `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. | gateway.nginx.org/nginx-gateway-controller | | `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only Deployment is supported. | deployment | | `nginxGateway.config` | The dynamic configuration for the control plane that is contained in the NginxGateway resource | [See nginxGateway.config section](values.yaml) | From 1d28582da0349bc702dd1aab8e9d07c2557628d2 Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Tue, 21 May 2024 08:08:14 +0300 Subject: [PATCH 5/6] one more fix according to the PR comment --- charts/nginx-gateway-fabric/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md index 559d397f4..f1c433a40 100644 --- a/charts/nginx-gateway-fabric/README.md +++ b/charts/nginx-gateway-fabric/README.md @@ -257,7 +257,7 @@ The following tables lists the configurable parameters of the NGINX Gateway Fabr | `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. | gateway.nginx.org/nginx-gateway-controller | | `nginxGateway.kind` | The kind of the NGINX Gateway Fabric installation - currently, only Deployment is supported. | deployment | | `nginxGateway.config` | The dynamic configuration for the control plane that is contained in the NginxGateway resource | [See nginxGateway.config section](values.yaml) | -| `nginxGateway.Annotations` | Set of custom annotations for NginxGateway objects. | {} | +| `nginxGateway.configAnnotations` | Set of custom annotations for NginxGateway objects. | {} | | `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | true | | `nginxGateway.readinessProbe.port` | Port in which the readiness endpoint is exposed. | 8081 | | `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | 3 | From b67bd28ff3fbdc3bad445862eeb61914f4b5c7aa Mon Sep 17 00:00:00 2001 From: Sergiy Gavrylenko Date: Tue, 21 May 2024 23:20:49 +0300 Subject: [PATCH 6/6] restore original format of table in README.md --- charts/nginx-gateway-fabric/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md index f1c433a40..132eaf2f0 100644 --- a/charts/nginx-gateway-fabric/README.md +++ b/charts/nginx-gateway-fabric/README.md @@ -246,7 +246,7 @@ kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/downlo The following tables lists the configurable parameters of the NGINX Gateway Fabric chart and their default values. | Parameter | Description | Default Value | -|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | `nginxGateway.image.repository` | The repository for the NGINX Gateway Fabric image. | ghcr.io/nginxinc/nginx-gateway-fabric | | `nginxGateway.image.tag` | The tag for the NGINX Gateway Fabric image. | edge | | `nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Gateway Fabric image. | Always |