From 199cf2a5c27afad620598020039abeac8b654b05 Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Mon, 22 Jan 2024 10:20:40 +0000 Subject: [PATCH 1/6] add docs links to helm NOTES.txt --- charts/nginx-ingress/templates/NOTES.txt | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/charts/nginx-ingress/templates/NOTES.txt b/charts/nginx-ingress/templates/NOTES.txt index c5f4cdf40..ee5ef2bf2 100644 --- a/charts/nginx-ingress/templates/NOTES.txt +++ b/charts/nginx-ingress/templates/NOTES.txt @@ -1 +1,11 @@ -The NGINX Ingress Controller has been installed. +The NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed. + +For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/ + +Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/ + +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. +To update to the latest version of the CRDs: + $ kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml + +More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds From 3cd58866678004056a23bef57aca2847d106d29a Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Mon, 22 Jan 2024 10:26:33 +0000 Subject: [PATCH 2/6] make CRDs note conditional on upgrade --- charts/nginx-ingress/templates/NOTES.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/charts/nginx-ingress/templates/NOTES.txt b/charts/nginx-ingress/templates/NOTES.txt index ee5ef2bf2..cce0f9d30 100644 --- a/charts/nginx-ingress/templates/NOTES.txt +++ b/charts/nginx-ingress/templates/NOTES.txt @@ -4,8 +4,10 @@ For release notes for this version please see: https://docs.nginx.com/nginx-ingr Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/ +{{ if .Release.IsUpgrade -}} 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. To update to the latest version of the CRDs: $ kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds +{{- end -}} From 37d6ffe5d586dc7a81849a92ab0d2a6348dca2ac Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Mon, 22 Jan 2024 10:35:08 +0000 Subject: [PATCH 3/6] add alternative CRD upgrade command examples --- charts/nginx-ingress/README.md | 8 ++++++++ .../installation/installing-nic/installation-with-helm.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/charts/nginx-ingress/README.md b/charts/nginx-ingress/README.md index ace471ba1..052a72a84 100644 --- a/charts/nginx-ingress/README.md +++ b/charts/nginx-ingress/README.md @@ -48,6 +48,14 @@ To upgrade the CRDs, pull the chart sources as described in [Pulling the Chart]( kubectl apply -f crds/ ``` +Alternatively, CRDs can be upgraded without pulling the chart by running: + +```console +kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml +``` + +In the above command, `v3.4.2` represents the version of the Ingress Controller release rather than the Helm chart version. + > **Note** > > The following warning is expected and can be ignored: `Warning: kubectl apply should be used on resource created by diff --git a/docs/content/installation/installing-nic/installation-with-helm.md b/docs/content/installation/installing-nic/installation-with-helm.md index 6dc870279..987d6b909 100644 --- a/docs/content/installation/installing-nic/installation-with-helm.md +++ b/docs/content/installation/installing-nic/installation-with-helm.md @@ -42,6 +42,14 @@ To upgrade the CRDs, pull the chart sources as described in [Pulling the Chart]( kubectl apply -f crds/ ``` +Alternatively, CRDs can be upgraded without pulling the chart by running: + +```console +kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml +``` + +In the above command, `v3.4.2` represents the version of the Ingress Controller release rather than the Helm chart version. + {{}}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`. Make sure to check the [release notes](https://www.github.com/nginxinc/kubernetes-ingress/releases) for a new release for any special upgrade procedures. From aa77ccb90feb9b261070bbf479f3e1af932ae1cd Mon Sep 17 00:00:00 2001 From: oseoin Date: Mon, 22 Jan 2024 10:40:07 +0000 Subject: [PATCH 4/6] Update charts/nginx-ingress/README.md Co-authored-by: Alan Dooley Signed-off-by: oseoin --- charts/nginx-ingress/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/nginx-ingress/README.md b/charts/nginx-ingress/README.md index 052a72a84..dc58f11ca 100644 --- a/charts/nginx-ingress/README.md +++ b/charts/nginx-ingress/README.md @@ -54,7 +54,7 @@ Alternatively, CRDs can be upgraded without pulling the chart by running: kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml ``` -In the above command, `v3.4.2` represents the version of the Ingress Controller release rather than the Helm chart version. +In the above command, `v3.4.2` represents the version of NGINX Ingress Controller release rather than the Helm chart version. > **Note** > From c0166a17fcc2db22727158df15d5b4b775cef766 Mon Sep 17 00:00:00 2001 From: oseoin Date: Mon, 22 Jan 2024 10:40:15 +0000 Subject: [PATCH 5/6] Update docs/content/installation/installing-nic/installation-with-helm.md Co-authored-by: Alan Dooley Signed-off-by: oseoin --- .../installation/installing-nic/installation-with-helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/installation/installing-nic/installation-with-helm.md b/docs/content/installation/installing-nic/installation-with-helm.md index 987d6b909..ab5e65d50 100644 --- a/docs/content/installation/installing-nic/installation-with-helm.md +++ b/docs/content/installation/installing-nic/installation-with-helm.md @@ -48,7 +48,7 @@ Alternatively, CRDs can be upgraded without pulling the chart by running: kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.2/deploy/crds.yaml ``` -In the above command, `v3.4.2` represents the version of the Ingress Controller release rather than the Helm chart version. +In the above command, `v3.4.2` represents the version of NGINX Ingress Controller release rather than the Helm chart version. {{}}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`. From 354db3c4b13787de63b01ca26ac80037409ffc29 Mon Sep 17 00:00:00 2001 From: oseoin Date: Mon, 22 Jan 2024 10:42:22 +0000 Subject: [PATCH 6/6] Update charts/nginx-ingress/templates/NOTES.txt Co-authored-by: Alan Dooley Signed-off-by: oseoin --- charts/nginx-ingress/templates/NOTES.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/nginx-ingress/templates/NOTES.txt b/charts/nginx-ingress/templates/NOTES.txt index cce0f9d30..c9a273977 100644 --- a/charts/nginx-ingress/templates/NOTES.txt +++ b/charts/nginx-ingress/templates/NOTES.txt @@ -1,4 +1,4 @@ -The NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed. +NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed. For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/