Skip to content

Commit b0b8e2d

Browse files
committed
Update Helm doc with helm repo setup
1 parent 4565ae4 commit b0b8e2d

File tree

2 files changed

+31
-8
lines changed

2 files changed

+31
-8
lines changed

deployments/helm-chart/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version: 0.2.0
33
appVersion: 1.4.3
44
description: NGINX Ingress Controller
55
sources:
6-
- https://github.com/nginxinc/kubernetes-ingress/tree/master/deployment/helm-chart
6+
- https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.3/deployments/helm-chart
77
keywords:
88
- ingress
99
- nginx

deployments/helm-chart/README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,36 @@ This chart deploys the NGINX Ingress controller in your Kubernetes cluster.
88

99
- Kubernetes 1.6+.
1010
- Helm 2.8.x+.
11-
- Git.
11+
- Git (for installation using the chart source files).
1212
- If you’d like to use NGINX Plus:
13-
- Build an Ingress controller image with NGINX Plus and push it to your private registry by following the instructions from [here](../../build/README.md).
14-
- Update the `controller.image.repository` field of the `values-plus.yaml` accordingly.
13+
- Build an Ingress controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://github.com/nginxinc/kubernetes-ingress/blob/v1.4.3/build/README.md).
14+
- Configure `controller.nginxplus` and `controller.image.repository` parameters accordingly using a values file or the `--set` flag of the `helm install` command.
1515

1616
## Installing the Chart
1717

18-
1. Clone the Ingress controller repo:
18+
### Installing via Helm Repository
19+
20+
1. Add NGINX Helm repository:
21+
```
22+
$ helm repo add nginx-stable https://helm.nginx.com/stable
23+
$ helm repo update
24+
```
25+
26+
2. To install the chart with the release name my-release (my-release is the name that you choose):
27+
28+
For NGINX:
29+
```
30+
$ helm install nginx-stable/nginx-ingress --name my-release
31+
```
32+
33+
For NGINX Plus (assuming you have pushed the Ingress controller image `nginx-plus-ingress` to your private registry `myregistry.example.com`):
34+
```
35+
$ helm install nginx-stable/nginx-ingress --name my-release --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true
36+
```
37+
38+
### Installing Using Chart Sources
39+
40+
1. Clone the Ingress controller repo and check out the latest stable version:
1941
```
2042
$ git clone https://github.com/nginxinc/kubernetes-ingress/
2143
$ git checkout v1.4.3
@@ -31,14 +53,15 @@ This chart deploys the NGINX Ingress controller in your Kubernetes cluster.
3153
$ helm install --name my-release .
3254
```
3355
34-
For NGINX Plus:
56+
For NGINX Plus (assuming you have configured the `controller.nginxplus` and `controller.image.repository` parameters in the values file `values-plus.yaml`):
3557
```
3658
$ helm install --name my-release -f values-plus.yaml .
3759
```
3860
39-
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.
61+
### Notes
4062
41-
When deploying the Ingress controller, make sure to use your own TLS certificate and key for the default server rather than the default pre-generated ones. Read the [Configuration](#Configuration) section below to see how to configure a TLS certificate and key for the default server. Note that the default server returns the Not Found page with the 404 status code for all requests for domains for which there are no Ingress rules defined.
63+
* The `helm install` 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.
64+
* When deploying the Ingress controller, make sure to use your own TLS certificate and key for the default server rather than the default pre-generated ones. Read the [Configuration](#Configuration) section below to see how to configure a TLS certificate and key for the default server. Note that the default server returns the Not Found page with the 404 status code for all requests for domains for which there are no Ingress rules defined.
4265
4366
> **Tip**: List all releases using `helm list`
4467

0 commit comments

Comments
 (0)