Skip to content

Commit 7063cf5

Browse files
committed
feat: Rename image docs, update references
1 parent a062bc4 commit 7063cf5

File tree

10 files changed

+42
-94
lines changed

10 files changed

+42
-94
lines changed

content/nic/installation/build-nginx-ingress-controller.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,5 +199,5 @@ If you prefer not to build your own NGINX Ingress Controller image, you can use
199199
200200
**NGINX Plus Ingress Controller**: You have two options for this:
201201
202-
- 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.
203-
- 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.
202+
- 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.
203+
- 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.

content/nic/installation/create-license-secret.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,21 @@ The JWT is required for validating your subscription and reporting telemetry dat
2727

2828
### Create the Secret
2929

30-
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.
30+
The JWT needs to be configured before deploying NGINX Ingress Controller.
31+
32+
It must be stored in a Kubernetes Secret of type `nginx.com/license` in the same namespace as your NGINX Ingress Controller pod(s).
33+
34+
Create the Secret with the following command:
3135

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

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

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

43-
### Use the NGINX Plus license Secret
44+
### Add the license Secret to your deployment
4445

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

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

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

53-
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" >}}).
54+
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" >}}).
5455

5556
{{% /tab %}}
5657

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

130131
{{</tabs>}}
131132

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

136-
137135
## What’s reported and how it’s protected {#telemetry}
138136

139137
NGINX Plus reports the following data every hour by default:

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ nd-docs: DOCS-603
99

1010
This guide explains how to use Manifests to install F5 NGINX Ingress Controller, then create both common and custom resources and set up role-based access control.
1111

12-
## Before you start
12+
## Before you begin
1313

1414
If you are using NGINX Plus, get the NGINX Ingress Controller JWT and [create a license secret]({{< ref "/nic/installation/create-license-secret.md" >}}).
1515

1616
### Get the NGINX Controller Image
1717

18-
{{< note >}} Always use the latest stable release listed on the [releases page]({{< ref "/nic/releases.md" >}}). {{< /note >}}
18+
{{< call-out "note" >}} Always use the latest stable release listed on the [releases page]({{< ref "/nic/releases.md" >}}). {{< /call-out >}}
1919

2020
Choose one of the following methods to get the NGINX Ingress Controller image:
2121

2222
- **NGINX Ingress Controller**: Download the image `nginx/nginx-ingress` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress).
2323
- **NGINX Plus Ingress Controller**: You have two options for this, both requiring an NGINX Ingress Controller subscription.
24-
- 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.md" >}}) topic.
25-
- The [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
24+
- - [Download NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/registry-download.md" >}}) topic.
25+
- - [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}})
2626
- **Build your own image**: To build your own image, follow the [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}}) topic.
2727

2828
### Clone the repository

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ nd-docs: DOCS-604
99

1010
This document explains how to install F5 NGINX Ingress Controller using NGINX Ingress Operator.
1111

12-
## Before you start
12+
## Before you begin
1313

1414
If you're using NGINX Plus, get the NGINX Ingress Controller JWT and [create a license secret]({{< ref "/nic/installation/create-license-secret.md" >}}).
1515

1616
{{< note >}} We recommend the most recent stable version of NGINX Ingress Controller, available on the GitHub repository's [releases page]({{< ref "/nic/releases.md" >}}). {{< /note >}}
1717

1818
1. Make sure you have access to the NGINX Ingress Controller image:
19-
- For NGINX Ingress Controller, use the image `nginx/nginx-ingress` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress).
20-
- For NGINX Plus Ingress Controller, view the [Get the F5 Registry NGINX Ingress Controller image]({{< ref "/nic/installation/nic-images/get-registry-image.md" >}}) topic for details on how to pull the image from the F5 Docker registry.
21-
- The [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
22-
- The [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}}) topic explains how to push an image to a private Docker registry.
19+
- - For NGINX Ingress Controller, use the image `nginx/nginx-ingress` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress).
20+
- - For NGINX Plus Ingress Controller, view the [Download NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/registry-download" >}}) topic for details on how to pull the image from the F5 Docker registry.
21+
- - The [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}) topic describes how to use your subscription JWT token to get the image.
22+
- - The [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}}) topic explains how to push an image to a private Docker registry.
2323
1. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginx/nginx-ingress-helm-operator/blob/main/docs/installation.md).
2424
1. Create the SecurityContextConstraint as outlined in the ["Getting Started" instructions](https://github.com/nginx/nginx-ingress-helm-operator/blob/main/README.md#getting-started).
2525

content/nic/installation/integrations/app-protect-dos/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,5 +226,5 @@ For more information, see the [Configuration guide]({{< ref "/nic/installation/i
226226

227227
If you prefer not to build your own NGINX Ingress Controller image, you can use pre-built images. Here are your options:
228228

229-
- 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.md" >}}) topic.
230-
- The [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
229+
- 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.
230+
- The [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}) topic describes how to use your subscription JWT token to get the image.

content/nic/installation/integrations/app-protect-waf-v5/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,5 +501,5 @@ For more information, see the [Configuration guide]({{< ref "/nic/installation/i
501501
502502
If you prefer not to build your own NGINX Ingress Controller image, you can use pre-built images. Here are your options:
503503
504-
- 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.md" >}}) topic.
505-
- The [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
504+
- 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.
505+
- The [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}) topic describes how to use your subscription JWT token to get the image.

content/nic/installation/integrations/app-protect-waf/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,5 +217,5 @@ For more information, see the [Configuration guide]({{< ref "/nic/installation/i
217217

218218
If you prefer not to build your own NGINX Ingress Controller image, you can use pre-built images. Here are your options:
219219

220-
- 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.md" >}}) topic.
221-
- The [Get the NGINX Ingress Controller image with JWT]({{< ref "/nic/installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
220+
- 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.
221+
- The [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}) topic describes how to use your subscription JWT token to get the image.

content/nic/installation/nic-images/add-image-to-cluster.md

Lines changed: 6 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -9,67 +9,17 @@ nd-docs: DOCS-1454
99

1010
This document describes how to add an F5 NGINX Plus Ingress Controller image from the F5 Docker registry into your Kubernetes cluster using a JWT token.
1111

12-
## Overview
13-
14-
{{< important >}}
15-
16-
An NGINX Plus subscription certificate and key will not work with the F5 Docker registry.
17-
18-
For NGINX Ingress Controller, you must have an NGINX Ingress Controller subscription -- download the NGINX Plus Ingress Controller (per instance) JWT access token from [MyF5](https://my.f5.com).
19-
20-
To list the available image tags using the Docker registry API, you will also need to download the NGINX Plus Ingress Controller (per instance) certificate (`nginx-repo.crt`) and the key (`nginx-repo.key`) from [MyF5](https://my.f5.com).
21-
22-
{{< /important >}}
23-
24-
{{< note >}}
25-
26-
You can also get an image using these methods:
27-
28-
- [Download NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/registry-download.md" >}}) topic.
29-
- [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}}) topic.
30-
31-
If you would like to use an NGINX Ingress Controller image with NGINX open source, we provide the image through [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/).
32-
33-
{{< /note >}}
34-
3512
## Before you begin
3613

37-
To follow these steps, you will need the following pre-requisites:
38-
39-
- A JWT Access Token (per instance) for NGINX Ingress Controller from an active NGINX Ingress Controller subscription.
40-
- The certificate (`nginx-repo.crt`) and key (`nginx-repo.key`) for each NGINX Ingress Controller instance, used to list the available image tags from the Docker registry API.
41-
42-
## Prepare NGINX Ingress Controller
14+
To follow these steps, you will need the following pre-requisite:
4315

44-
1. Choose your desired [NGINX Ingress Controller Image]({{< ref "/nic/technical-specifications.md#images-with-nginx-plus" >}}).
45-
1. Log into the [MyF5 Portal](https://my.f5.com/), navigate to your subscription details, and download the relevant .cert, .key and .JWT files.
46-
1. Create a Kubernetes secret using the JWT token. You should use `cat` to view the contents of the JWT token and store the output for use in later steps.
47-
1. Ensure there are no additional characters or extra whitespace that might have been accidentally added. This will break authorization and prevent the NGINX Ingress Controller image from being downloaded.
48-
1. Modify your deployment (manifest or Helm) to use the Kubernetes secret created in step 3.
49-
1. Deploy NGINX Ingress Controller into your Kubernetes cluster and verify that the installation has been successful.
16+
- [Create a license Secret]({{< ref "/nic/installation/create-license-secret.md" >}})
5017

51-
## Using the JWT token in a Docker Config Secret
52-
53-
1. Create a Kubernetes `docker-registry` secret type on the cluster, using the JWT token as the username and `none` for password (as the password is not used). The name of the docker server is `private-registry.nginx.com`.
54-
55-
```shell
56-
kubectl create secret docker-registry regcred --docker-server=private-registry.nginx.com --docker-username=<JWT Token> --docker-password=none [-n nginx-ingress]
57-
```
58-
59-
It is important that the `--docker-username=<JWT Token>` contains the contents of the token and is not pointing to the token itself. Ensure that when you copy the contents of the JWT token, there are no additional characters or extra whitespaces. This can invalidate the token and cause 401 errors when trying to authenticate to the registry.
60-
61-
1. Confirm the details of the created secret by running:
62-
63-
```shell
64-
kubectl get secret regcred --output=yaml
65-
```
66-
67-
1. You can now use the newly created Kubernetes secret in Helm and manifest deployments.
68-
69-
{{< include "/nic/installation/jwt-password-note.md" >}}
70-
71-
---
18+
You can also get the NGINX Ingress Controller image using the following alternate methods:
7219

20+
- [Download NGINX Ingress Controller from the F5 Registry]({{< ref "/nic/installation/nic-images/registry-download.md" >}})
21+
- [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}})
22+
- For NGINX Open Source, you can pull the [nginx/nginx-ingress image](https://hub.docker.com/r/nginx/nginx-ingress/) from DockerHub
7323

7424
## Helm Deployment
7525

content/nic/installation/nic-images/registry-download.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,22 @@ nd-product: NIC
77
nd-docs: DOCS-605
88
---
99

10-
This page describes how to download an F5 NGINX Plus Ingress Controller image from the official F5 Docker registr.
10+
This page describes how to download an F5 NGINX Plus Ingress Controller image from the official F5 Docker registry.
1111

1212
The F5 Registry images include versions with NGINX App Protect WAF and NGINX App Protect DoS.
1313

14-
This guide covers the prerequisites, how to images, upload images to your private registry, and troubleshooting steps.
15-
1614
## Before you begin
1715

1816
To follow these steps, you will need the following pre-requisites:
1917

20-
- [Create a license Secret]({{< ref "/nic/installation/create-license-secret.md" >}}).
21-
- [Docker v18.09 or higher](https://docs.docker.com/engine/release-notes/18.09/).
18+
- [Create a license Secret]({{< ref "/nic/installation/create-license-secret.md" >}})
19+
- [Docker v18.09 or higher](https://docs.docker.com/engine/release-notes/18.09/)
2220

2321
You can also get the NGINX Ingress Controller image using the following alternate methods:
2422

25-
- [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}}).
23+
- [Add an NGINX Ingress Controller image to your cluster]({{< ref "/nic/installation/nic-images/add-image-to-cluster.md" >}})
2624
- [Build NGINX Ingress Controller]({{< ref "/nic/installation/build-nginx-ingress-controller.md" >}})
27-
- For NGINX Open Source, you can pull the [nginx/nginx-ingress image](https://hub.docker.com/r/nginx/nginx-ingress/) from DockerHub.
25+
- For NGINX Open Source, you can pull [an image from DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/)
2826

2927
## Set up Docker for F5 Container Registry
3028

@@ -40,9 +38,11 @@ The steps provided are for Linux. For Mac or Windows, consult the [Docker for Ma
4038

4139
## Pull the image
4240

43-
Next, pull the image you need from `private-registry.nginx.com`. To find the correct image, consult the [Technical specifications]({{< ref "/nic/technical-specifications.md#images-with-nginx-plus" >}}).
41+
Identify which image you need using the [Technical specifications]({{< ref "/nic/technical-specifications.md#images-with-nginx-plus" >}}) topic.
42+
43+
Next, pull the image from `private-registry.nginx.com`.
4444

45-
To pull an image, follow these steps. Replace `<version-tag>` with the specific version you need, for example, `{{< nic-version >}}`.
45+
Replace `<version-tag>` with the specific version you need, for example, `{{< nic-version >}}`.
4646

4747
- For NGINX Plus Ingress Controller, run:
4848

content/nic/releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1689,7 +1689,7 @@ We will provide technical support for NGINX Ingress Controller on any Kubernetes
16891689
### <i class="fa-solid fa-download"></i> Upgrade
16901690

16911691
- For NGINX, use the 1.12.1 image from our DockerHub: `nginx/nginx-ingress:1.12.1`, `nginx/nginx-ingress:1.12.1-alpine` or `nginx/nginx-ingress:1.12.1-ubi`
1692-
- For NGINX Plus, use the 1.12.1 image from the F5 Container Registry - see [the documentation here]({{< ref "/nic/installation/nic-images/get-registry-image.md">}})
1692+
- For NGINX Plus, use the 1.12.1 image from the F5 Container Registry - see [the documentation here]({{< ref "/nic/installation/nic-images/registry-download.md">}})
16931693
- Alternatively, you can also build your own image using the 1.12.1 source code.
16941694
- For Helm, use version 0.10.1 of the chart.
16951695

0 commit comments

Comments
 (0)