Skip to content

Commit 4ce4300

Browse files
committed
fix: update how to delete deta plane keys
1 parent 78dac56 commit 4ce4300

File tree

4 files changed

+20
-10
lines changed

4 files changed

+20
-10
lines changed

CONTRIBUTING_DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Here are some other shortcodes:
146146
- `tab`: Create mutually exclusive tabbed window panes, useful for parallel instructions
147147
- `table`: Add scrollbars to wide tables for browsers with smaller viewports
148148
- `link`: Link to a file, prepending its path with the Hugo baseUrl
149-
- `openapi`: Loads an OpenAPI specifcation and render it as HTML using ReDoc
149+
- `openapi`: Loads an OpenAPI specification and render it as HTML using ReDoc
150150
- `include`: Include the content of a file in another file; the included file must be present in the '/content/includes/' directory
151151
- `raw-html`: Include a block of raw HTML
152152
- `readfile`: Include the content of another file in the current file, which can be in an arbitrary location.

content/nginx-one/getting-started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Data plane keys expire after one year. You can change this expiration date later
5151

5252
After entering your data plane key, you'll see a `curl` command similar to the one below. Copy and run this command on each NGINX instance to install the NGINX Agent. Once installed, the NGINX Agent typically registers with NGINX One within a few seconds.
5353

54+
{{<call-out "important" "Connecting to NGINX One" >}}
55+
The NGINX Agent must be able to establish a connection to the NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
56+
57+
- `3.135.72.139`
58+
- `3.133.232.50`
59+
- `52.14.85.249`
60+
{{</call-out>}}
61+
5462
To install the NGINX Agent on an NGINX instance:
5563

5664
1. **Check if NGINX is running and start it if it's not:**

content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ If you need to deactivate a data plane key before its expiration date, follow th
6060
4. A confirmation dialog will appear. Select **Revoke** to confirm.
6161

6262

63-
## Delete a data plane key (API only)
63+
## Delete a data plane key
6464

65-
In this release, you need to use the NGINX One REST API to delete a data plane key. However, before you can delete a key, it must be revoked. You can revoke a key either through the NGINX One console, as explained above, or by using the REST API.
65+
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.
6666

67-
To delete a data plane key using the NGINX One REST API, see these guides:
68-
69-
- [Authenticate with the NGINX One REST API]({{< relref "nginx-one/api/authentication.md" >}})
70-
- [Delete a data plane key: NGINX One API Reference]({{< relref "nginx-one/api/api-reference-guide.md#operation/deleteDataPlaneKey" >}})
67+
1. On the left menu, select **Data Plane Keys**.
68+
2. Find the key you want to revoke in the list of expired or revoked keys.
69+
3. Next to the key name, select the check box. You can select multiple keys at the same time.
70+
4. Select **Delete selected**.

content/nginx-one/how-to/nginx-configs/add-instance.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,15 @@ In either case, NGINX One Console gives you a choice for data plane keys:
3737
- Create a new key
3838
- Use an existing key
3939

40-
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the call in the **Add Instance** screen in the console. The command looks like:
40+
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
41+
42+
Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< relref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
4143

4244
```bash
43-
curl https://<tenant URL>/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
45+
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
4446
```
4547

46-
Sign in to the instance that you want to add. Run that command. If needed, the script [installs NGINX Agent]({{< relref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages. Once the process is complete, you can configure that instance in your NGINX One Console.
48+
Once the process is complete, you can configure that instance in your NGINX One Console.
4749

4850
## Managed and Unmanaged Certificates
4951

0 commit comments

Comments
 (0)