Skip to content

Commit 671b267

Browse files
mjangmjang
committed
reorg May 28, part 1
1 parent 458f66c commit 671b267

30 files changed

+336
-35
lines changed

‎content/nginx-one/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ You can:
8484

8585
For more information, including warnings about risks, see our documentation on how you can:
8686
- [Add a file]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
87-
- [Manage certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}})
87+
- [Manage certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}})
8888

8989
### Revert a configuration
9090

@@ -108,15 +108,15 @@ From the NGINX One Console you can now:
108108
- Ensure that your certificates are current and correct.
109109
- Manage your certificates from a central location. This can help you simplify operations and remotely update, rotate, and deploy those certificates.
110110

111-
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}}).
111+
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
112112

113113
## August 22, 2024
114114

115115
### Config Sync Groups
116116

117117
Config Sync Groups are now available in the F5 NGINX One Console. This feature allows you to manage and synchronize NGINX configurations across multiple instances as a single entity, ensuring consistency and simplifying the management of your NGINX environment.
118118

119-
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups.md" >}}).
119+
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}).
120120

121121
## August 8, 2024
122122

‎content/nginx-one/connect-instances/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Connect your instances to the console
4+
weight: 700
5+
url: /nginx-one/connect-instances/
6+
---

‎content/nginx-one/connect-instances/containers/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Containers
4+
weight: 300
5+
url: /nginx-one/how-to/containers
6+
---

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

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
description: ''
3+
docs: null
4+
title: Connect NGINX Plus container images to NGINX One
5+
toc: true
6+
weight: 400
7+
type:
8+
- how-to
9+
---
10+
11+
## Overview
12+
13+
This guide explains how to set up an F5 NGINX Plus Docker container with NGINX Agent and connect it to the NGINX One Console.
14+
15+
---
16+
17+
## Before you start
18+
19+
Before you start, make sure you have:
20+
21+
- A valid JSON Web Token (JWT) for your NGINX subscription.
22+
- [A data plane key from NGINX One]({{< ref "/nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md" >}}).
23+
- Docker installed and running on your system.
24+
25+
#### Download your JWT license from MyF5
26+
27+
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
28+
29+
---
30+
31+
## Process for private registry
32+
33+
### Log in to the NGINX private registry
34+
35+
Use your JWT to log in to the NGINX private registry. Replace `YOUR_JWT_HERE` with your JWT.
36+
37+
```sh
38+
sudo docker login private-registry.nginx.com --username=YOUR_JWT_HERE --password=none
39+
```
40+
41+
{{< include "security/jwt-password-note.md" >}}
42+
43+
### Pull the NGINX Plus image
44+
45+
Pull the NGINX Plus image from the private registry. Replace `VERSION_TAG` with the desired version, such as `alpine`, `debian`, or `ubi`.
46+
47+
```sh
48+
sudo docker pull private-registry.nginx.com/nginx-plus/agent:VERSION_TAG
49+
```
50+
51+
You must specify a version tag. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pulling-the-image" >}}) guide.
52+
53+
<br>
54+
55+
{{<call-out "" "Example:" "" >}}
56+
To pull the `debian` image:
57+
58+
```sh
59+
sudo docker pull private-registry.nginx.com/nginx-plus/agent:debian
60+
```
61+
{{</call-out>}}
62+
63+
### Start the NGINX Plus container
64+
65+
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `VERSION_TAG` with the version tag you pulled.
66+
67+
**For NGINX Plus R33 or later**:
68+
69+
- Use the `NGINX_LICENSE_JWT` variable to pass your JWT license. Replace `YOUR_JWT_HERE` with your JWT.
70+
71+
For more details, see [About subscription licenses]({{< ref "solutions/about-subscription-licenses.md" >}}).
72+
73+
```sh
74+
sudo docker run \
75+
--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 \
80+
--restart=always \
81+
--runtime=runc \
82+
-d private-registry.nginx.com/nginx-plus/agent:<VERSION_TAG>
83+
```
84+
85+
<br>
86+
87+
{{<call-out "" "Example:" "" >}}
88+
To start the container with the `debian` image:
89+
90+
```sh
91+
sudo docker run \
92+
--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 \
97+
--restart=always \
98+
--runtime=runc \
99+
-d private-registry.nginx.com/nginx-plus/agent:debian
100+
```
101+
102+
{{</call-out>}}
103+
104+
---
105+
106+
## References
107+
108+
For more details, see:
109+
110+
- [Deploying NGINX and NGINX Plus on Docker](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/)
111+
- [Full List of Agent Environment Variables](https://docs.nginx.com/nginx-agent/configuration/configuration-overview/#nginx-agent-environment-variables)
112+
- [NGINX One Data Plane Keys](https://docs.nginx.com/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys/)
113+
- [My F5 Knowledge Article](https://my.f5.com/manage/s/article/K000090257)

‎content/nginx-one/connect-instances/data-plane-keys/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Data plane keys
4+
weight: 100
5+
url: /nginx-one/how-to/data-plane-keys
6+
---

‎content/nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
description: ''
3+
docs: DOCS-1395
4+
title: Create and manage data plane keys
5+
toc: true
6+
weight: 100
7+
type:
8+
- how-to
9+
---
10+
11+
<style>
12+
h2 {
13+
margin-top: 20px;
14+
padding-top: 20px;
15+
}
16+
</style>
17+
18+
## About data plane keys
19+
20+
Data plane keys are required for registering NGINX instances with the F5 NGINX One Console. These keys serve as secure tokens, ensuring that only authorized NGINX instances can connect to and communicate with NGINX One. You have the flexibility to reuse a key with multiple instances, or to create a unique key for each instance.
21+
22+
{{<call-out "note" "Data plane key considerations" "fas fa-key" >}}
23+
Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely.
24+
25+
Data plane keys expire after one year. You can change this expiration date later by editing the key.
26+
27+
Revoking a data plane key disconnects all instances that were registered with that key.
28+
{{</call-out>}}
29+
30+
## Create a new data plane key
31+
32+
To create a new key for connecting your NGINX instances to NGINX One, follow these steps:
33+
34+
1. On the left menu, select **Data Plane Keys**.
35+
2. Select **Add Data Plane Key**.
36+
3. Enter a name for your new key. Optionally, you can set an expiration date for the key. If you don't set a date, the key will automatically expire one year from today. The longest duration for a key is one year. You can change this expiration date later by editing the key.
37+
4. Select **Generate**.
38+
5. A confirmation screen will show your new data plane key. Be sure to copy and store this key securely. It is displayed *only once* and cannot be retrieved later.
39+
6. Select **Close** to complete the process.
40+
41+
## Change the expiration date {#change-expiration-date}
42+
43+
To change the expiration date of a data plane key, follow these steps before the key expires. You cannot update the expiration date after the key has expired.
44+
45+
1. On the left menu, select **Data Plane Keys**.
46+
2. Find the key you want to edit in the list.
47+
3. Next to the key name, in the **Actions** column, select the ellipsis (three dots) and then select **Edit Key**.
48+
4. Set a new expiration date for the key. The longest duration for a key is one year.
49+
5. Select **Save**.
50+
51+
## Revoke a data plane key {#revoke-data-plane-key}
52+
53+
If you need to deactivate a data plane key before its expiration date, follow these steps. Once revoked, the key will no longer connect any NGINX instances to NGINX One. The key will still be visible in the console until you delete it.
54+
55+
1. On the left menu, select **Data Plane Keys**.
56+
2. Find the key you want to revoke in the list.
57+
3. Next to the key name, in the **Actions** column, select the ellipsis (three dots) and then select **Revoke**.
58+
4. A confirmation dialog will appear. Select **Revoke** to confirm.
59+
60+
61+
## Delete a data plane key
62+
63+
Before you can delete a key, it must be expired or revoked. You can revoke a key either through the NGINX One Console, as explained above, or by using the REST API. Once deleted, all information about the data plane key is permanently removed.
64+
65+
1. On the left menu, select **Data Plane Keys**.
66+
2. Find the key you want to revoke in the list of expired or revoked keys.
67+
3. Next to the key name, select the check box. You can select multiple keys at the same time.
68+
4. Select **Delete selected**.

‎content/nginx-one/connect-instances/settings/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
description:
3+
title: Settings
4+
weight: 500
5+
url: /nginx-one/how-to/settings
6+
draft: true
7+
---

‎content/nginx-one/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ To generate a data plane key:
4343
{{<call-out "caution" "Data plane key guidelines" "fas fa-key" >}}
4444
Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely.
4545

46-
Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md#change-expiration-date" >}}).
46+
Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md#change-expiration-date" >}}).
4747

48-
[Revoking a data plane key]({{< ref "nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key.
48+
[Revoking a data plane key]({{< ref "nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key.
4949
{{</call-out>}}
5050

5151

‎content/nginx-one/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This glossary defines terms used in the F5 NGINX One Console and F5 Distributed
1414
{{<bootstrap-table "table table-striped table-bordered">}}
1515
| Term | Definition |
1616
|-------------|-------------|
17-
| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
17+
| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
1818
| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
1919
| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. |
2020
| **Namespace** | In F5 Distributed Cloud, a namespace groups a tenant’s configuration objects, similar to administrative domains. Every object in a namespace must have a unique name, and each namespace must be unique to its tenant. This setup ensures isolation, preventing cross-referencing of objects between namespaces. You'll see the namespace in the NGINX One Console URL as `/namespaces/<namespace name>/` |

‎content/nginx-one/nginx-configs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description:
3-
title: Add and manage your NGINX instances
3+
title: Manage your NGINX instances
44
weight: 300
55
url: /nginx-one/nginx-configs
66
---

0 commit comments

Comments
 (0)