Skip to content

Commit 890b455

Browse files
vvnginxvvnginx
authored
Merge branch 'main' into patch-2
2 parents 293ec62 + 7db8c28 commit 890b455

30 files changed

+858
-809
lines changed

‎content/includes/licensing-and-reporting/download-certificates-from-myf5.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
files:
3+
- content/includes/use-cases/credential-download-instructions.md
4+
---
5+
6+
1. Log in to [MyF5](https://my.f5.com/manage/s/).
7+
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions.
8+
1. Find your NGINX subscription, and select the **Subscription ID** for details.
9+
1. Download the **SSL Certificate** and **Private Key** files from the subscription page.

‎content/includes/licensing-and-reporting/download-jwt-from-myf5.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
---
22
docs:
3+
files:
4+
- content/includes/nim/docker/docker-registry-login.md
5+
- content/includes/use-cases/credential-download-instructions.md
6+
- content/nap-waf/v5/admin-guide/install.md
7+
- content/nginx/admin-guide/installing-nginx/installing-nginx-plus.md
8+
- content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md
9+
- content/nim/admin-guide/add-license.md
10+
- content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md
11+
- content/nim/disconnected/add-license-disconnected-deployment.md
12+
- content/solutions/about-subscription-licenses.md
13+
- content/solutions/r33-pre-release-guidance-for-automatic-upgrades.md
314
---
415

516
1. Log in to [MyF5](https://my.f5.com/manage/s/).
6-
2. Go to **My Products & Plans > Subscriptions** to see your active subscriptions.
7-
3. Find your NGINX products or services subscription, and select the **Subscription ID** for details.
8-
4. Download the **JSON Web Token** from the subscription page.
17+
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions.
18+
1. Find your NGINX subscription, and select the **Subscription ID** for details.
19+
1. Download the **JSON Web Token** file from the subscription page.

‎content/includes/use-cases/credential-download-instructions.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
files:
3+
- content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md
4+
- content/nic/installation/nic-images/registry-download.md
5+
---
6+
7+
In order to obtain a container image, you will need the JSON Web Token file or SSL certificate and private key files provided with your NGINX Plus subscription.
8+
9+
These files grant access to the package repository from which the script will download the NGINX Plus package:
10+
11+
{{< tabs name="product_keys" >}}
12+
13+
{{% tab name="JSON Web Token" %}}
14+
15+
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
16+
17+
{{% /tab %}}
18+
19+
{{% tab name="SSL" %}}
20+
21+
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
22+
23+
{{% /tab %}}
24+
25+
{{< /tabs >}}

‎content/includes/use-cases/docker-registry-instructions.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
files:
3+
- content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md
4+
- content/nic/installation/nic-images/registry-download.md
5+
---
6+
7+
This step describes how to use Docker to communicate with the F5 Container Registry located at `private-registry.nginx.com`.
8+
9+
{{< call-out "note" >}}
10+
11+
The steps provided are for Linux. For Mac or Windows, see the [Docker for Mac](https://docs.docker.com/docker-for-mac/#add-client-certificates) or [Docker for Windows](https://docs.docker.com/docker-for-windows/#how-do-i-add-client-certificates) documentation.
12+
13+
For more details on Docker Engine security, you can refer to the [Docker Engine Security documentation](https://docs.docker.com/engine/security/).
14+
15+
{{< /call-out >}}
16+
17+
{{< tabs name="docker_login" >}}
18+
19+
{{% tab name="JSON Web Token"%}}
20+
21+
Open the JSON Web Token file previously downloaded from [MyF5](https://my.f5.com) customer portal (for example, `nginx-repo-12345abc.jwt`) and copy its contents.
22+
23+
Log in to the Docker registry using the contents of the JSON Web Token file:
24+
25+
```shell
26+
docker login private-registry.nginx.com --username=<output_of_jwt_token> --password=none
27+
```
28+
29+
{{% /tab %}}
30+
31+
{{% tab name="SSL" %}}
32+
33+
Create a directory and copy your certificate and key to this directory:
34+
35+
```shell
36+
mkdir -p /etc/docker/certs.d/private-registry.nginx.com
37+
cp <path-to-your-nginx-repo.crt> /etc/docker/certs.d/private-registry.nginx.com/client.cert
38+
cp <path-to-your-nginx-repo.key> /etc/docker/certs.d/private-registry.nginx.com/client.key
39+
```
40+
41+
Log in to the Docker registry:
42+
43+
```shell
44+
docker login private-registry.nginx.com
45+
```
46+
47+
{{% /tab %}}
48+
49+
{{< /tabs >}}

‎content/includes/use-cases/monitoring/n1c-dashboard-overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Navigating the dashboard:
2323
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
2424
| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | |
2525
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
26-
| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. |
26+
| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **High**: Indicates a high-severity threat that needs immediate attention. NGINX CVSS score = 7.0-10.0 <br> - **Medium**: Implies a moderate threat level. NGINX CVSS score = 4.0-6.9 <br> - **Low**: Represent less critical issues that still require monitoring. NGINX CVSS score = 0.1-3.9. <br> - **None**: NGINX CVSS score = 0.0|
2727
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
2828
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
2929
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |

‎content/nginx-one/agent/configure-instance-reporting/configuration-overview.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ sudo docker run \
4949
--env=NGINX_AGENT_LOG_LEVEL=debug \
5050
-d agent
5151
```
52-
<details>
53-
<summary>NGINX Agent configuration options</summary>
52+
53+
### NGINX Agent configuration options
5454

5555
{{< bootstrap-table "table table-striped table-bordered" >}}
5656
| **Environment Variable** | **Command-Line Option** | **Description** | **Default Value** |
@@ -83,5 +83,4 @@ sudo docker run \
8383
| NGINX_AGENT_COLLECTOR_EXTENSIONS_TLS_CERT | --collector-extensions-health-tls-cert | TLS Certificate file path for communication with OTel health server. | N/A |
8484
| NGINX_AGENT_COLLECTOR_EXTENSIONS_TLS_KEY | --collector-extensions-health-tls-key | File path for TLS key used when connecting with OTel health server. | N/A |
8585
| NGINX_AGENT_COLLECTOR_PROCESSORS_BATCH_SEND_BATCH_TIMEOUT | --collector-processors-batch-send-batch-timeout | Maximum time duration for sending batch data metrics regardless of size. | 200ms
86-
{{< /bootstrap-table >}} |%
87-
</details>
86+
{{< /bootstrap-table >}}

‎content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ For more details, see [About subscription licenses]({{< ref "solutions/about-sub
7373
```sh
7474
sudo docker run \
7575
--env=NGINX_LICENSE_JWT="YOUR_JWT_HERE" \
76-
--env=NGINX_AGENT_SERVER_GRPCPORT=443 \
77-
--env=NGINX_AGENT_SERVER_HOST=agent.connect.nginx.com \
78-
--env=NGINX_AGENT_SERVER_TOKEN="YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE" \
79-
--env=NGINX_AGENT_TLS_ENABLE=true \
76+
--env=NGINX_AGENT_COMMAND_SERVER_PORT=443 \
77+
--env=NGINX_AGENT_COMMAND_SERVER_HOST=agent.connect.nginx.com \
78+
--env=NGINX_AGENT_COMMAND_AUTH_TOKEN="DPK" \
79+
--env=NGINX_AGENT_COMMAND_TLS_SKIP_VERIFY=false \
8080
--restart=always \
8181
--runtime=runc \
82-
-d private-registry.nginx.com/nginx-plus/agent:<version-tag>
82+
-d private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
8383
```
8484

8585
<br>
@@ -90,13 +90,13 @@ To start the container with the `debian` image:
9090
```sh
9191
sudo docker run \
9292
--env=NGINX_LICENSE_JWT="YOUR_JWT_HERE" \
93-
--env=NGINX_AGENT_SERVER_GRPCPORT=443 \
94-
--env=NGINX_AGENT_SERVER_HOST=agent.connect.nginx.com \
95-
--env=NGINX_AGENT_SERVER_TOKEN="YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE" \
96-
--env=NGINX_AGENT_TLS_ENABLE=true \
93+
--env=NGINX_AGENT_COMMAND_SERVER_PORT=443 \
94+
--env=NGINX_AGENT_COMMAND_SERVER_HOST=agent.connect.nginx.com \
95+
--env=NGINX_AGENT_COMMAND_AUTH_TOKEN="DPK" \
96+
--env=NGINX_AGENT_COMMAND_TLS_SKIP_VERIFY=false \
9797
--restart=always \
9898
--runtime=runc \
99-
-d private-registry.nginx.com/nginx-plus/agent:debian
99+
-d private-registry.nginx.com/nginx-plus/agentv3:debian
100100
```
101101

102102
{{</call-out>}}

‎content/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ You can add existing NGINX instances that are already registered with NGINX One
114114

115115
``` text
116116
labels:
117-
config_sync_group: <config_sync_group>
117+
config-sync-group: <config_sync_group>
118118
```
119119

120120
4. Restart NGINX Agent:

‎content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md‎

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -88,61 +88,13 @@ where:
8888

8989
- the `jq` command is used to format the JSON output for easier reading and requires the [jq](https://jqlang.github.io/jq/) JSON processor to be installed.
9090

91+
### Download your subscription credential files
9192

93+
{{< include "use-cases/credential-download-instructions.md" >}}
9294

93-
### Download the JSON Web Token or NGINX Plus certificate and key {#myf5-download}
95+
### Set up Docker for the F5 Container Registry
9496

95-
Before you get a container image, you should provide the JSON Web Token file or SSL certificate and private key files provided with your NGINX Plus subscription. These files grant access to the package repository from which the script will download the NGINX Plus package:
96-
97-
{{<tabs name="product_keys">}}
98-
99-
{{%tab name="JSON Web Token"%}}
100-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
101-
{{% /tab %}}
102-
103-
{{%tab name="SSL"%}}
104-
1. Log in to the [MyF5](https://my.f5.com) customer portal.
105-
2. Go to **My Products and Plans** > **Subscriptions**.
106-
3. Select the product subscription.
107-
4. Download the **SSL Certificate** and **Private Key** files.
108-
{{% /tab %}}
109-
110-
{{% /tabs %}}
111-
112-
### Set up Docker for NGINX Plus container registry
113-
114-
Set up Docker to communicate with the NGINX Container Registry located at `private-registry.nginx.com`.
115-
116-
{{<tabs name="docker_login">}}
117-
118-
{{%tab name="JSON Web Token"%}}
119-
Open the JSON Web Token file previously downloaded from [MyF5](https://my.f5.com) customer portal (for example, `nginx-repo-12345abc.jwt`) and copy its contents.
120-
121-
Log in to the docker registry using the contents of the JSON Web Token file:
122-
123-
```shell
124-
docker login private-registry.nginx.com --username=<output_of_jwt_token> --password=none
125-
```
126-
{{% /tab %}}
127-
128-
{{%tab name="SSL"%}}
129-
Create a directory and copy your certificate and key to this directory:
130-
131-
```shell
132-
mkdir -p /etc/docker/certs.d/private-registry.nginx.com
133-
cp <path-to-your-nginx-repo.crt> /etc/docker/certs.d/private-registry.nginx.com/client.cert
134-
cp <path-to-your-nginx-repo.key> /etc/docker/certs.d/private-registry.nginx.com/client.key
135-
```
136-
The steps provided are for Linux. For Mac or Windows, see the [Docker for Mac](https://docs.docker.com/docker-for-mac/#add-client-certificates) or [Docker for Windows](https://docs.docker.com/docker-for-windows/#how-do-i-add-client-certificates) documentation. For more details on Docker Engine security, you can refer to the [Docker Engine Security documentation](https://docs.docker.com/engine/security/).
137-
138-
Log in to the docker registry:
139-
140-
```shell
141-
docker login private-registry.nginx.com
142-
```
143-
{{% /tab %}}
144-
145-
{{% /tabs %}}
97+
{{< include "use-cases/docker-registry-instructions.md" >}}
14698

14799
### Pull the image
148100

@@ -192,7 +144,6 @@ For NGINX modules, run:<!-- Is this enough info?-->
192144
docker pull private-registry.nginx.com/nginx-plus/modules:<version-tag>
193145
```
194146

195-
196147
{{< include "security/jwt-password-note.md" >}}
197148

198149
### Push the image to your private registry

‎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.

0 commit comments

Comments
 (0)