Add docs links to helm NOTES.txt

[oseoin]

Proposed changes

Add links to installation and upgrade documentation to Helm NOTES.txt, along with a note on CRD upgrades.

Before:

helm upgrade --install my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.1.2

Pulled: ghcr.io/nginxinc/charts/nginx-ingress:1.1.2
Digest: sha256:f060eae0404bac9ab40c33c65f7eca21e27d1832fee6067492c71ac3b797736a
Release "my-release" has been upgraded. Happy Helming!
NAME: my-release
LAST DEPLOYED: Mon Jan 22 10:03:09 2024
NAMESPACE: default
STATUS: deployed
REVISION: 2
TEST SUITE: None
NOTES:
The NGINX Ingress Controller has been installed.

After - Install:

helm upgrade --install my-release charts/nginx-ingress/

Release "my-release" does not exist. Installing it now.
walk.go:74: found symbolic link in path: /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/charts/nginx-ingress/crds resolves to /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/config/crd/bases. Contents of linked file included and used
NAME: my-release
LAST DEPLOYED: Mon Jan 22 10:23:55 2024
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
The NGINX Ingress Controller 3.4.0 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/

After - Upgrade:

helm upgrade --install my-release charts/nginx-ingress/

walk.go:74: found symbolic link in path: /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/charts/nginx-ingress/crds resolves to /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/config/crd/bases. Contents of linked file included and used
Release "my-release" has been upgraded. Happy Helming!
NAME: my-release
LAST DEPLOYED: Mon Jan 22 10:24:13 2024
NAMESPACE: default
STATUS: deployed
REVISION: 2
TEST SUITE: None
NOTES:
The NGINX Ingress Controller 3.4.0 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/v3.4.0/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

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have checked that all unit tests pass after adding my changes
• I have updated necessary documentation
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

[vepatel]

@oseoin is it possible to add these instructions while running helm install --dry-run?

[ADubhlaoich]

LGTM: made a few edit suggestions around noun use for NGINX Ingress Controller.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4590ce5) 52.31% compared to head (37d6ffe) 52.28%.
Report is 2 commits behind head on main.

❗ Current head 37d6ffe differs from pull request most recent head 53f56b0. Consider uploading reports for the commit 53f56b0 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4953      +/-   ##
==========================================
- Coverage   52.31%   52.28%   -0.03%     
==========================================
  Files          60       60              
  Lines       17501    17501              
==========================================
- Hits         9155     9151       -4     
- Misses       8018     8020       +2     
- Partials      328      330       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[oseoin]

@oseoin is it possible to add these instructions while running helm install --dry-run?

@vepatel can confirm it works with --dry-run install and upgrade :)

helm upgrade  my-release charts/nginx-ingress --dry-run
walk.go:74: found symbolic link in path: /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/charts/nginx-ingress/crds resolves to /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/config/crd/bases. Contents of linked file included and used
Release "my-release" has been upgraded. Happy Helming!
NAME: my-release
LAST DEPLOYED: Mon Jan 22 10:38:57 2024
NAMESPACE: default
STATUS: pending-upgrade
REVISION: 3
TEST SUITE: None
HOOKS:
MANIFEST:
---
# Source: nginx-ingress/templates/controller-serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: my-release-nginx-ingress
  namespace: default
...

NOTES:
The NGINX Ingress Controller 3.4.0 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/v3.4.0/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