8000 Re-align configurations in helm docs (#4790) · nginx/kubernetes-ingress@dd2c994 · GitHub
[go: up one dir, main page]
Skip to content

Commit dd2c994

Browse files
shaun-nxshaun-nx
authored
Re-align configurations in helm docs (#4790)
1 parent 098ffef commit dd2c994

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

‎charts/nginx-ingress/values.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ controller:
1414
## Deploys the Ingress Controller for NGINX Plus.
1515
nginxplus: false
1616

17-
# Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start.
17+
## Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start.
1818
nginxReloadTimeout: 60000
1919

2020
## Support for App Protect WAF
@@ -235,7 +235,7 @@ controller:
235235
## The number of replicas of the Ingress Controller deployment.
236236
replicaCount: 1
237237

238-
# Configures the ingress class the Ingress Controller uses.
238+
## Configures the ingress class the Ingress Controller uses.
239239
ingressClass:
240240
## A class of the Ingress Controller.
241241

@@ -463,7 +463,7 @@ controller:
463463
## Configure root filesystem as read-only and add volumes for temporary data.
464464
readOnlyRootFilesystem: false
465465

466-
## Enable dynamic reloading of certificates for NGINX Plus
466+
## Enable dynamic reloading of certificates
467467
enableSSLDynamicReload: true
468468

469469
rbac:

‎docs/content/installation/installing-nic/installation-with-helm.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,15 +335,15 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
335335
| **controller.initContainers** | InitContainers for the Ingress Controller pods. | [] |
336336
| **controller.extraContainers** | Extra (eg. sidecar) containers for the Ingress Controller pods. | [] |
337337
| **controller.resources** | The resources of the Ingress Controller pods. | requests: cpu=100m,memory=128Mi |
338+
| **controller.initContainerResources** | The resources of the init container which is used when `controller.readOnlyRootFilesystem` is set to `true` | requests: cpu=100m,memory=128Mi |
338339
| **controller.replicaCount** | The number of replicas of the Ingress Controller deployment. | 1 |
339340
| **controller.ingressClass.name** | A class of the Ingress Controller. An IngressClass resource with the name equal to the class must be deployed. Otherwise, the Ingress Controller will fail to start. The Ingress Controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. The Ingress Controller processes all the VirtualServer/VirtualServerRoute/TransportServer resources that do not have the "ingressClassName" field for all versions of Kubernetes. | nginx |
340341
| **controller.ingressClass.create** | Creates a new IngressClass object with the name `controller.ingressClass.name`. Set to `false` to use an existing ingressClass created using `kubectl` with the same name. If you use `helm upgrade`, do not change the values from the previous release as helm will delete IngressClass objects managed by helm. If you are upgrading from a release earlier than 3.3.2, do not set the value to false. | true |
341-
| **controller.setAsDefaultIngress** | New Ingresses without an `"ingressClassName"` field specified will be assigned the class specified in `controller.ingressClass.name`. | false |
342+
| **controller.ingressClass.setAsDefaultIngress** | New Ingresses without an `"ingressClassName"` field specified will be assigned the class specified in `controller.ingressClass.name`. Requires `controller.ingressClass.create`. | false |
342343
| **controller.watchNamespace** | Comma separated list of namespaces the Ingress Controller should watch for resources. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespaceLabel`. Please note that if configuring multiple namespaces using the Helm cli `--set` option, the string needs to wrapped in double quotes and the commas escaped using a backslash - e.g. `--set controller.watchNamespace="default\,nginx-ingress"`. | "" |
343344
| **controller.watchNamespaceLabel** | Configures the Ingress Controller to watch only those namespaces with label foo=bar. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespace`. | "" |
344345
| **controller.watchSecretNamespace** | Comma separated list of namespaces the Ingress Controller should watch for resources of type Secret. If this arg is not configured, the Ingress Controller watches the same namespaces for all resources. See `controller.watchNamespace` and `controller.watchNamespaceLabel`. Please note that if configuring multiple namespaces using the Helm cli `--set` option, the string needs to wrapped in double quotes and the commas escaped using a backslash - e.g. `--set controller.watchSecretNamespace="default\,nginx-ingress"`. | "" |
345346
| **controller.enableCustomResources** | Enable the custom resources. | true |
346-
| **controller.enablePreviewPolicies** | Enable preview policies. This parameter is deprecated. To enable OIDC Policies please use `controller.enableOIDC` instead. | false |
347347
| **controller.enableOIDC** | Enable OIDC policies. | false |
348348
| **controller.enableTLSPassthrough** | Enable TLS Passthrough on default port 443. Requires `controller.enableCustomResources`. | false |
349349
| **controller.tlsPassThroughPort** | Set the port for the TLS Passthrough. Requires `controller.enableCustomResources` and `controller.enableTLSPassthrough`. | 443 |
@@ -407,6 +407,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
407407
| **controller.minReadySeconds** | Specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing, for it to be considered available. [docs](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds) | 0 |
408408
| **controller.autoscaling.enabled** | Enables HorizontalPodAutoscaling. | false |
409409
| **controller.autoscaling.annotations** | The annotations of the Ingress Controller HorizontalPodAutoscaler. | {} |
410+
| **controller.autoscaling.behavior** | Behavior configuration for the HPA. | {} |
410411
| **controller.autoscaling.minReplicas** | Minimum number of replicas for the HPA. | 1 |
411412
| **controller.autoscaling.maxReplicas** | Maximum number of replicas for the HPA. | 3 |
412413
| **controller.autoscaling.targetCPUUtilizationPercentage** | The target CPU utilization percentage. | 50 |
@@ -417,6 +418,8 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
417418
| **controller.podDisruptionBudget.maxUnavailable** | The number of Ingress Controller pods that can be unavailable. This is a mutually exclusive setting with "minAvailable". | 0 |
418419
| **controller.strategy** | Specifies the strategy used to replace old Pods with new ones. Docs for [Deployment update strategy](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy) and [Daemonset update strategy](https://kubernetes.io/docs/tasks/manage-daemon/update-daemon-set/#daemonset-update-strategy) | {} |
419420
| **controller.disableIPV6** | Disable IPV6 listeners explicitly for nodes that do not support the IPV6 stack. | false |
421+
| **controller.defaultHTTPListenerPort** | Sets the port for the HTTP `default_server` listener. | 80 |
422+
| **controller.defaultHTTPSListenerPort** | Sets the port for the HTTPS `default_server` listener. | 443 |
420423
| **controller.readOnlyRootFilesystem** | Configure root filesystem as read-only and add volumes for temporary data. | false |
421424
| **controller.enableSSLDynamicReload** | Enable lazy loading for SSL Certificates. | true |
422425
| **rbac.create** | Configures RBAC. | true |

0 commit comments

Comments
 (0)
0