Skip to content

Commit 90bdf1c

Browse files
committed
Add docs links to helm NOTES.txt (#4953)
* add docs links to helm NOTES.txt
1 parent 5a1807e commit 90bdf1c

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

charts/nginx-ingress/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ To upgrade the CRDs, pull the chart sources as described in [Pulling the Chart](
4848
kubectl apply -f crds/
4949
```
5050

51+
Alternatively, CRDs can be upgraded without pulling the chart by running:
52+
53+
```console
54+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml
55+
```
56+
57+
In the above command, `v3.4.2` represents the version of NGINX Ingress Controller release rather than the Helm chart version.
58+
5159
> **Note**
5260
>
5361
> The following warning is expected and can be ignored: `Warning: kubectl apply should be used on resource created by
Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
1-
The NGINX Ingress Controller has been installed.
1+
NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed.
2+
3+
For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/
4+
5+
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/
6+
7+
{{ if .Release.IsUpgrade -}}
8+
If you are upgrading from a version of the chart that uses older Custom Resource Definitions (CRD) it is necessary to manually upgrade the CRDs as this is not managed by Helm.
9+
To update to the latest version of the CRDs:
10+
$ kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml
11+
12+
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds
13+
{{- end -}}

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ To upgrade the CRDs, pull the chart sources as described in [Pulling the Chart](
4242
kubectl apply -f crds/
4343
```
4444

45+
Alternatively, CRDs can be upgraded without pulling the chart by running:
46+
47+
```console
48+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml
49+
```
50+
51+
In the above command, `v3.4.2` represents the version of NGINX Ingress Controller release rather than the Helm chart version.
52+
4553
{{<note>}}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`.
4654

4755
Make sure to check the [release notes](https://www.github.com/nginxinc/kubernetes-ingress/releases) for a new release for any special upgrade procedures.

0 commit comments

Comments
 (0)