Skip to content

Commit 7035076

Browse files
committed
feat: Clarify NIC install & upgrade steps
This commit makes a number of changes to clarify what the precise steps are to install, upgrade and uninstall NGINX Ingress Controller - The Install document clarifies necessary steps - Uninstall steps have been moved to the bottom of the document - Upgrade instructions have been moved into their own document The changes made focused on clarifying the critical path for one single user story, as lots of unnecessary contextual information was being provided, which was causing confusion. With this commit, the general reading and execution flow for these deployment steps become more coherent. Similar changes may be made for Manifests documentation, if common steps are identified.
1 parent 854ea90 commit 7035076

File tree

8 files changed

+399
-381
lines changed

8 files changed

+399
-381
lines changed

content/nic/installation/ingress-nginx.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
nd-docs: DOCS-1469
3-
doctypes:
4-
- tutorial
5-
tags:
6-
- docs
72
title: Migrate from Ingress-NGINX Controller to NGINX Ingress Controller
83
toc: true
9-
weight: 500
4+
weight: 700
5+
nd-content-type: how-to
6+
nd-product: NIC
7+
nd-docs: DOCS-1469
108
---
119

1210
This document describes how to migrate from the community-maintained Ingress-NGINX Controller to F5 NGINX Ingress Controller.

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

Lines changed: 74 additions & 222 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Installation with Manifests
33
toc: true
44
weight: 200
5-
type: how-to
6-
product: NIC
5+
nd-content-type: how-to
6+
nd-product: NIC
77
nd-docs: DOCS-603
88
---
99

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

Lines changed: 0 additions & 137 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Integrations
33
description:
4-
weight: 600
4+
weight: 800
55
url: /nginx-ingress-controller/installation/integrations
66
---

content/nic/installation/run-multiple-ingress-controllers.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
nd-docs: DOCS-606
3-
doctypes:
4-
- ''
52
title: Run multiple NGINX Ingress Controllers
63
toc: true
7-
weight: 400
4+
weight: 600
5+
nd-content-type: how-to
6+
nd-product: NIC
7+
nd-docs: DOCS-606
88
---
99

1010
This document describes how to run multiple F5 NGINX Ingress Controller instances.
@@ -17,8 +17,6 @@ It explains the following topics:
1717

1818
{{< note >}} This document refers to [Ingress]({{< ref "/nic/configuration/ingress-resources/basic-configuration.md" >}}), [VirtualServer]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources.md#virtualserver-specification" >}}), [VirtualServerRoute]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources.md#virtualserverroute-specification" >}}), and [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resources as "configuration resources".{{< /note >}}
1919

20-
---
21-
2220
## Ingress class
2321

2422
The [IngressClass](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) resource allows for multiple Ingress Controller to operate in the same cluster. It also allow developers to select which Ingress Controller implementation to use for their Ingress resource.
@@ -35,16 +33,12 @@ The default Ingress class of NGINX Ingress Controller is `nginx`, which means th
3533
{{< note >}}- If the class of an Ingress resource is not set, Kubernetes will set it to the class of the default Ingress Controller. To make the Ingress Controller the default one, the `ingressclass.kubernetes.io/is-default-class` property must be set on the IngressClass resource. To learn more, see Step 3 *Create an IngressClass resource* of the [Create Common Resources]({{< ref "/nic/installation/installing-nic/installation-with-manifests.md#create-common-resources" >}}) section.
3634
- For VirtualServer, VirtualServerRoute, Policy and TransportServer resources, NGINX Ingress Controller will always handle resources with an empty class.{{< /note >}}
3735

38-
---
39-
4036
## Run NGINX Ingress Controller and another Ingress Controller
4137

4238
It is possible to run NGINX Ingress Controller and an Ingress Controller for another load balancer in the same cluster. This is often the case if you create your cluster through a cloud provider's managed Kubernetes service that by default might include the Ingress Controller for the HTTP load balancer of the cloud provider, and you want to use NGINX Ingress Controller.
4339

4440
To make sure that NGINX Ingress Controller handles specific configuration resources, update those resources with the class set to the value that is configured in NGINX Ingress Controller. By default, this is `nginx`.
4541

46-
---
47-
4842
## Run multiple NGINX Ingress Controllers
4943

5044
When running NGINX Ingress Controller, you have the following options with regards to which configuration resources it handles:

0 commit comments

Comments
 (0)