You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ In the case of NGINX, the Ingress Controller is deployed in a pod along with the
51
51
52
52
We publish NGINX Ingress Controller releases on GitHub. See our [releases page](https://github.com/nginxinc/kubernetes-ingress/releases).
53
53
54
-
The latest stable release is [3.1.1](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.1.1). For production use, we recommend that you choose the latest stable release.
54
+
The latest stable release is [3.2.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.2.0). For production use, we recommend that you choose the latest stable release.
55
55
56
56
The edge version is useful for experimenting with new features that are not yet published in a stable release. To use it, choose the *edge* version built from the [latest commit](https://github.com/nginxinc/kubernetes-ingress/commits/main) from the main branch.
57
57
@@ -67,7 +67,7 @@ The table below summarizes the options regarding the images, Helm chart, manifes
67
67
68
68
| Version | Description | Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples |
| Latest stable release | For production use | Use the 3.1.1 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 3.1.1 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.1.1/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.1.1/deployments/helm-chart). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |
70
+
| Latest stable release | For production use | Use the 3.2.0 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 3.2.0 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.2.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.2.0/deployments/helm-chart). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |
71
71
| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content/installation/building-ingress-controller-image.md). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content/installation/building-ingress-controller-image.md). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). |
Copy file name to clipboardExpand all lines: deployments/helm-chart/README.md
+36-28
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ This chart deploys the NGINX Ingress Controller in your Kubernetes cluster.
6
6
7
7
## Prerequisites
8
8
9
-
- A [Kubernetes Version Supported by the Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#supported-kubernetes-versions)
10
-
- Helm 3.0+.
11
-
- If you’d like to use NGINX Plus:
12
-
- To pull from the F5 Container registry, configure a docker registry secret using your JWT token from the MyF5 portal by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret). Make sure to specify the secret using `controller.serviceAccount.imagePullSecretName` parameter.
13
-
- Alternatively, pull an Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image).
14
-
- Alternatively, you can build an Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image).
15
-
- Update the `controller.image.repository` field of the `values-plus.yaml` accordingly.
16
-
- If you’d like to use App Protect DoS, please install App Protect DoS Arbitrator [helm chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart). Make sure to install in the same namespace as the NGINX Ingress Controller. Note that if you install multiple NGINX Ingress Controllers in the same namespace, they will need to share the same Arbitrator because it is not possible to install more than one Arbitrator in a single namespace.
9
+
- A [Kubernetes Version Supported by the Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#supported-kubernetes-versions)
10
+
- Helm 3.0+.
11
+
- If you’d like to use NGINX Plus:
12
+
- To pull from the F5 Container registry, configure a docker registry secret using your JWT token from the MyF5 portal by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret). Make sure to specify the secret using `controller.serviceAccount.imagePullSecretName` parameter.
13
+
- Alternatively, pull an Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image).
14
+
- Alternatively, you can build an Ingress Controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image).
15
+
- Update the `controller.image.repository` field of the `values-plus.yaml` accordingly.
16
+
- If you’d like to use App Protect DoS, please install App Protect DoS Arbitrator [helm chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart). Make sure to install in the same namespace as the NGINX Ingress Controller. Note that if you install multiple NGINX Ingress Controllers in the same namespace, they will need to share the same Arbitrator because it is not possible to install more than one Arbitrator in a single namespace.
17
17
18
18
## CRDs
19
19
@@ -26,8 +26,9 @@ If you do not use the custom resources that require those CRDs (which correspond
26
26
To upgrade the CRDs, pull the chart sources as described in [Pulling the Chart](#pulling-the-chart) and then run:
27
27
28
28
```console
29
-
$ kubectl apply -f crds/
29
+
kubectl apply -f crds/
30
30
```
31
+
31
32
> **Note**
32
33
>
33
34
> The following warning is expected and can be ignored: `Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply`.
@@ -39,26 +40,29 @@ $ kubectl apply -f crds/
39
40
To remove the CRDs, pull the chart sources as described in [Pulling the Chart](#pulling-the-chart) and then run:
40
41
41
42
```console
42
-
$ kubectl delete -f crds/
43
+
kubectl delete -f crds/
43
44
```
45
+
44
46
> **Note**
45
47
>
46
48
> This command will delete all the corresponding custom resources in your cluster across all namespaces. Please ensure there are no custom resources that you want to keep and there are no other Ingress Controller releases running in the cluster.
47
49
48
-
49
50
## Managing the Chart via OCI Registry
51
+
50
52
### Installing the Chart
51
53
52
54
To install the chart with the release name my-release (my-release is the name that you choose):
This will install the latest `edge` version of the Ingress Controller from GitHub Container Registry. If you prefer to use Docker Hub, you can replace `ghcr.io/nginxinc/charts/nginx-ingress` with `registry-1.docker.io/nginxcharts/nginx-ingress`.
@@ -70,16 +74,17 @@ Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a re
> The `edge` version is not intended for production use. It is intended for testing and development purposes only.
99
104
100
-
101
105
## Managing the Chart via Sources
102
106
103
107
### Pulling the Chart
104
108
105
109
This step is required if you're installing the chart using its sources. Additionally, the step is also required for managing the custom resource definitions (CRDs), which the Ingress Controller requires by default, or for upgrading/deleting the CRDs.
2. Change your working directory to nginx-ingress:
118
+
113
119
```console
114
-
$ cd nginx-ingress
120
+
cd nginx-ingress
115
121
```
116
122
117
123
### Installing the Chart
118
124
119
125
To install the chart with the release name my-release (my-release is the name that you choose):
120
126
121
127
For NGINX:
128
+
122
129
```console
123
-
$ helm install my-release .
130
+
helm install my-release .
124
131
```
125
132
126
133
For NGINX Plus:
134
+
127
135
```console
128
-
$ helm install my-release -f values-plus.yaml .
136
+
helm install my-release -f values-plus.yaml .
129
137
```
130
138
131
139
The command deploys the Ingress Controller in your Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
@@ -137,15 +145,15 @@ Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a re
137
145
To upgrade the release `my-release`:
138
146
139
147
```console
140
-
$ helm upgrade my-release .
148
+
helm upgrade my-release .
141
149
```
142
150
143
151
### Uninstalling the Chart
144
152
145
153
To uninstall/delete the release `my-release`:
146
154
147
155
```console
148
-
$ helm uninstall my-release
156
+
helm uninstall my-release
149
157
```
150
158
151
159
The command removes all the Kubernetes components associated with the release and deletes the release.
@@ -158,7 +166,6 @@ If you are running multiple Ingress Controller releases in your cluster with ena
158
166
159
167
See [running multiple Ingress Controllers](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for more details.
160
168
161
-
162
169
## Configuration
163
170
164
171
The following tables lists the configurable parameters of the NGINX Ingress Controller chart and their default values.
@@ -174,9 +181,9 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
174
181
|`controller.dnsPolicy`| DNS policy for the Ingress Controller pods. | ClusterFirst |
175
182
|`controller.nginxDebug`| Enables debugging for NGINX. Uses the `nginx-debug` binary. Requires `error-log-level: debug` in the ConfigMap via `controller.config.entries`. | false |
176
183
|`controller.logLevel`| The log level of the Ingress Controller. | 1 |
177
-
|`controller.image.digest`| The image digest of the Ingress Controller. | None |
184
+
|`controller.image.digest`| The image digest of the Ingress Controller. | None |
178
185
|`controller.image.repository`| The image repository of the Ingress Controller. | nginx/nginx-ingress |
179
-
|`controller.image.tag`| The tag of the Ingress Controller image. | 3.1.1|
186
+
|`controller.image.tag`| The tag of the Ingress Controller image. | 3.2.0|
180
187
|`controller.image.pullPolicy`| The pull policy for the Ingress Controller image. | IfNotPresent |
181
188
|`controller.lifecycle`| The lifecycle of the Ingress Controller pods. | {} |
182
189
|`controller.customConfigMap`| The name of the custom ConfigMap used by the Ingress Controller. If set, then the default config is ignored. | "" |
@@ -293,5 +300,6 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
293
300
|`nginxServiceMesh.enableEgress`| Enable NGINX Service Mesh workloads to route egress traffic through the Ingress Controller. See the NGINX Service Mesh [docs](https://docs.nginx.com/nginx-service-mesh/tutorials/kic/deploy-with-kic/#enabling-egress) for more details. Requires `nginxServiceMesh.enable`. | false |
294
301
295
302
## Notes
296
-
* The values-icp.yaml file is used for deploying the Ingress Controller on IBM Cloud Private. See the [blog post](https://www.nginx.com/blog/nginx-ingress-controller-ibm-cloud-private/) for more details.
297
-
* The values-nsm.yaml file is used for deploying the Ingress Controller with NGINX Service Mesh. See the NGINX Service Mesh [docs](https://docs.nginx.com/nginx-service-mesh/tutorials/kic/deploy-with-kic/) for more details.
303
+
304
+
- The values-icp.yaml file is used for deploying the Ingress Controller on IBM Cloud Private. See the [blog post](https://www.nginx.com/blog/nginx-ingress-controller-ibm-cloud-private/) for more details.
305
+
- The values-nsm.yaml file is used for deploying the Ingress Controller with NGINX Service Mesh. See the NGINX Service Mesh [docs](https://docs.nginx.com/nginx-service-mesh/tutorials/kic/deploy-with-kic/) for more details.
0 commit comments