Skip to content

feat: Clarify NIC install & upgrade steps #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
7035076
feat: Clarify NIC install & upgrade steps
ADubhlaoich Jul 15, 2025
2386768
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 15, 2025
1ce25d2
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 16, 2025
cab2b43
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 16, 2025
fcb0ea5
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 17, 2025
cea2a56
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 17, 2025
fe71933
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 17, 2025
5d8a199
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 18, 2025
00b5ba8
feat: Move and rename old upgrade instructions
ADubhlaoich Jul 18, 2025
b2b0195
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 18, 2025
b8d700d
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 18, 2025
c7ccbde
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 18, 2025
d011d29
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 21, 2025
7848959
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
6b14dfc
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
2f6db7c
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
a87e651
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
027cacc
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
de6344e
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
c094fc2
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
a5b72f7
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
3dc1027
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
a0f591b
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
92759bd
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
4c72e55
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
c8ba079
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
40bd224
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
ce3b5db
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
6cc93b5
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
7c098ef
Apply suggestion from @travisamartin
ADubhlaoich Jul 21, 2025
26bfffc
feat: Incorporate suggestions, rename image pages
ADubhlaoich Jul 21, 2025
a9534e8
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 21, 2025
2b3281a
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 21, 2025
a062bc4
fix: Update tech specs with new links
ADubhlaoich Jul 21, 2025
7063cf5
feat: Rename image docs, update references
ADubhlaoich Jul 22, 2025
a039bc8
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 22, 2025
cbbef0e
feat: Update Helm IA for add image to cluster
ADubhlaoich Jul 22, 2025
6c8b30b
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich Jul 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/nic/installation/build-nginx-ingress-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,5 +199,5 @@ If you prefer not to build your own NGINX Ingress Controller image, you can use

**NGINX Plus Ingress Controller**: You have two options for this:

- Download the image using your NGINX Ingress Controller subscription certificate and key. View the [Get NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/get-registry-image" >}}) topic.
- Use your NGINX Ingress Controller subscription JWT token to get the image. View the [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic.
- Download the image using your NGINX Ingress Controller subscription certificate and key. View the [Download NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/registry-download.md" >}}) topic.
- Use your NGINX Ingress Controller subscription JWT token to get the image. View the [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}) topic.
20 changes: 9 additions & 11 deletions content/nic/installation/create-license-secret.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,21 @@ The JWT is required for validating your subscription and reporting telemetry dat

### Create the Secret

The JWT needs to be configured before deploying NGINX Ingress Controller. The JWT will be stored in a Kubernetes Secret of type `nginx.com/license`, and can be created with the following command.
The JWT needs to be configured before deploying NGINX Ingress Controller.

It must be stored in a Kubernetes Secret of type `nginx.com/license` in the same namespace as your NGINX Ingress Controller pod(s).

Create the Secret with the following command:

```shell
kubectl create secret generic license-token --from-file=license.jwt=<path-to-your-jwt> --type=nginx.com/license -n <Your Namespace>
kubectl create secret generic license-token --from-file=license.jwt=<path-to-your-jwt> --type=nginx.com/license -n <your-namespace>
```
You can now delete the downloaded `.jwt` file.

{{< note >}}
The Secret needs to be in the same Namespace as the NGINX Ingress Controller Pod(s).
{{</ note >}}
Once created, you can download the `.jwt` file.

{{< include "/nic/installation/jwt-password-note.md" >}}

### Use the NGINX Plus license Secret
### Add the license Secret to your deployment

If using a name other than the default `license-token`, provide the name of this Secret when installing NGINX Ingress Controller:

Expand All @@ -50,7 +51,7 @@ If using a name other than the default `license-token`, provide the name of this

Specify the Secret name using the `controller.mgmt.licenseTokenSecretName` Helm value.

For detailed guidance on creating the Management block via Helm, refer to the [Helm configuration documentation]({{< ref "/nic/installation/installing-nic/installation-with-helm/#configuration" >}}).
For detailed guidance on creating the Management block with Helm, refer to the [Helm configuration documentation]({{< ref "/nic/installation/installing-nic/installation-with-helm/#configuration" >}}).

{{% /tab %}}

Expand Down Expand Up @@ -129,11 +130,8 @@ Specify the SSL trusted certificate Secret name in the `ssl-trusted-certificate-

{{</tabs>}}

<br>

Once these Secrets are created and configured, you can now [install NGINX Ingress Controller ]({{< ref "/nic/installation/installing-nic/" >}}).


## What’s reported and how it’s protected {#telemetry}

NGINX Plus reports the following data every hour by default:
Expand Down
10 changes: 4 additions & 6 deletions content/nic/installation/ingress-nginx.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
nd-docs: DOCS-1469
doctypes:
- tutorial
tags:
- docs
title: Migrate from Ingress-NGINX Controller to NGINX Ingress Controller
toc: true
weight: 500
weight: 700
nd-content-type: how-to
nd-product: NIC
nd-docs: DOCS-1469
---

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