You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: content/nic/installation/installing-nic/installation-with-helm.md
+7-10Lines changed: 7 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This document explains how to install F5 NGINX Ingress Controller using [Helm](h
11
11
12
12
## Before you begin
13
13
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 >}}
15
15
16
16
- A [Kubernetes Version Supported by NGINX Ingress Controller]({{< ref "/nic/technical-specifications.md#supported-kubernetes-versions" >}})
17
17
- Helm 3.0+.
@@ -30,8 +30,7 @@ If you do not use the custom resources that require those CRDs (which correspond
30
30
31
31
### Upgrade the CRDs
32
32
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 >}}
35
34
36
35
To upgrade the CRDs, pull the chart sources as described in [Pull the Chart](#pull-the-chart) and then run:
In the above command, `v{{< nic-version >}}` represents the version of NGINX Ingress Controller release rather than the Helm chart version.
49
48
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`.
51
50
52
51
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 >}}
54
53
55
54
### Uninstall the CRDs
56
55
@@ -60,7 +59,7 @@ To remove the CRDs, pull the chart sources as described in [Pull the Chart](#pul
60
59
kubectl delete -f crds/
61
60
```
62
61
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 >}}
64
63
65
64
## Manage the chart with OCI Registry
66
65
@@ -113,7 +112,7 @@ You can install the `edge` version by specifying the `--version` flag with the v
{{< 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>}}
117
116
118
117
## Manage the chart with Sources
119
118
@@ -184,7 +183,7 @@ Although the advisory is to update all resources in accordance with new naming c
184
183
185
184
### Upgrade steps
186
185
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 >}}
188
187
189
188
The steps you should follow depend on the Helm release name:
Copy file name to clipboardExpand all lines: content/nic/installation/installing-nic/upgrade-to-v4.md
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,26 @@
1
1
---
2
-
title: Upgrade to NGINX Ingress Controller 4.0.0
2
+
title: Upgrade from NGINX Ingress Controller v3.x to v4.0.0
3
3
toc: true
4
4
weight: 400
5
-
type: how-to
6
-
product: NIC
5
+
nd-content-type: how-to
6
+
nd-product: NIC
7
7
nd-docs: DOCS-1862
8
8
---
9
9
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.
11
11
12
12
There are two necessary steps required: updating the `apiVersion` value of custom resources and configuring structured logging.
13
13
14
14
For NGINX Plus users, there is a third step to create a Secret for your license.
15
15
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">}}).
0 commit comments