Skip to content

Commit d1bb519

Browse files
authored
feat: Clarify 3.x to 4.x upgrade process for NGINX Ingress Controller (#802)
This commit renames the Upgrade to 3.x document for NGINX Ingress Controller to clarify it is for 3.x to 4.0.00 only. It adds an explicit warning call-out at the top of the page to reinforce this, and the Helm installation document has also been updated with more generic phrasing. At a certain point of maturity the note on the Helm instructions page could likely be removed, unless we anticipate someone will be still be running a 3.x instance years after the versions have moved on.
1 parent 50dbf09 commit d1bb519

File tree

2 files changed

+19
-14
lines changed

2 files changed

+19
-14
lines changed

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

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document explains how to install F5 NGINX Ingress Controller using [Helm](h
1111

1212
## Before you begin
1313

14-
{{< note >}} All documentation should only be used with the latest stable release, indicated on [the releases page]({{< ref "/nic/releases.md" >}}) of the GitHub repository. {{< /note >}}
14+
{{< call-out "note" >}} All documentation should only be used with the latest stable release, indicated on [the releases page]({{< ref "/nic/releases.md" >}}) of the GitHub repository. {{< /call-out >}}
1515

1616
- A [Kubernetes Version Supported by NGINX Ingress Controller]({{< ref "/nic/technical-specifications.md#supported-kubernetes-versions" >}})
1717
- Helm 3.0+.
@@ -30,8 +30,7 @@ If you do not use the custom resources that require those CRDs (which correspond
3030

3131
### Upgrade the CRDs
3232

33-
{{< note >}} Please make sure to read the steps outlined in [Upgrade to V4]({{< ref "/nic/installation/installing-nic/upgrade-to-v4.md#update-custom-resource-apiversion" >}}) before running the CRD upgrade and perform the steps if applicable.
34-
{{< /note >}}
33+
{{< call-out "note" >}} If you are running NGINX Ingress Controller v3.x, you should read [Upgrade from NGINX Ingress Controller v3.x to v4.0.0]({{< ref "/nic/installation/installing-nic/upgrade-to-v4.md" >}}) before continuing. {{< /call-out >}}
3534

3635
To upgrade the CRDs, pull the chart sources as described in [Pull the Chart](#pull-the-chart) and then run:
3736

@@ -47,10 +46,10 @@ kubectl apply -f https://raw.githubusercontent.com/nginx/kubernetes-ingress/v{{<
4746

4847
In the above command, `v{{< nic-version >}}` represents the version of NGINX Ingress Controller release rather than the Helm chart version.
4948

50-
{{< 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`.
49+
{{< call-out "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`.
5150

5251
Check the [release notes](https://www.github.com/nginx/kubernetes-ingress/releases) for a new release for any special upgrade procedures.
53-
{{< /note >}}
52+
{{< /call-out >}}
5453

5554
### Uninstall the CRDs
5655

@@ -60,7 +59,7 @@ To remove the CRDs, pull the chart sources as described in [Pull the Chart](#pul
6059
kubectl delete -f crds/
6160
```
6261

63-
{{< warning >}} 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 NGINX Ingress Controller instances running in the cluster. {{< /warning >}}
62+
{{< call-out "warning" >}} 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 NGINX Ingress Controller instances running in the cluster. {{< /call-out >}}
6463

6564
## Manage the chart with OCI Registry
6665

@@ -113,7 +112,7 @@ You can install the `edge` version by specifying the `--version` flag with the v
113112
helm install my-release oci://ghcr.io/nginx/charts/nginx-ingress --version 0.0.0-edge
114113
```
115114

116-
{{< warning >}} The `edge` version is not intended for production use. It is intended for testing and development purposes only. {{< /warning >}}
115+
{{< call-out "warning" >}} The `edge` version is not intended for production use. It is intended for testing and development purposes only. {{< /call-out >}}
117116

118117
## Manage the chart with Sources
119118

@@ -184,7 +183,7 @@ Although the advisory is to update all resources in accordance with new naming c
184183
185184
### Upgrade steps
186185
187-
{{< note >}} The following steps apply to both 2.x and 3.0.x releases. {{</ note >}}
186+
{{< call-out "note" >}} The following steps apply to both 2.x and 3.0.x releases. {{</ call-out >}}
188187
189188
The steps you should follow depend on the Helm release name:
190189
@@ -299,7 +298,6 @@ The [Run multiple NGINX Ingress Controllers]({{< ref "/nic/installation/run-mult
299298
300299
The following tables lists the configurable parameters of the NGINX Ingress Controller chart and their default values.
301300
302-
{{< table >}}
303301
{{<bootstrap-table "table table-striped table-bordered table-responsive">}}
304302
|Parameter | Description | Default |
305303
| --- | --- | --- |
@@ -490,4 +488,3 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
490488
|**nginxAgent.napMonitoring.processorBufferSize** | Buffer size for processor. Will contain log lines and parsed log lines. | 50000 |
491489
|**nginxAgent.customConfigMap** | The name of a custom ConfigMap to use instead of the one provided by default. | "" |
492490
{{</bootstrap-table>}}
493-
{{< /table >}}

content/nic/installation/installing-nic/upgrade-to-v4.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
---
2-
title: Upgrade to NGINX Ingress Controller 4.0.0
2+
title: Upgrade from NGINX Ingress Controller v3.x to v4.0.0
33
toc: true
44
weight: 400
5-
type: how-to
6-
product: NIC
5+
nd-content-type: how-to
6+
nd-product: NIC
77
nd-docs: DOCS-1862
88
---
99

10-
This document explains how to upgrade F5 NGINX Ingress Controller to 4.0.0.
10+
This document explains how to upgrade F5 NGINX Ingress Controller from version v3.x to v4.0.0.
1111

1212
There are two necessary steps required: updating the `apiVersion` value of custom resources and configuring structured logging.
1313

1414
For NGINX Plus users, there is a third step to create a Secret for your license.
1515

16+
{{< call-out "warning" "This upgrade path is intended for 3.x to 4.0.0 only" >}}
17+
18+
The instructions in this document are intended only for users upgrading from NGINX Ingress Controller 3.x to 4.0.0. Internal changes meant that backwards compability was not possible, requiring extra steps to upgrade.
19+
20+
From NGINX Ingress Controller v4.0.0 onwards, you can upgrade as normal, based on your installation method: [Helm]({{< ref "/nic/installation/installing-nic/installation-with-helm.md">}}) or [Manifests]({{< ref "/nic/installation/installing-nic/installation-with-manifests.md">}}).
21+
22+
{{< /call-out >}}
23+
1624
---
1725

1826
## Update custom resource apiVersion

0 commit comments

Comments
 (0)