Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Here are some other shortcodes:
- `tab`: Create mutually exclusive tabbed window panes, useful for parallel instructions
- `table`: Add scrollbars to wide tables for browsers with smaller viewports
- `link`: Link to a file, prepending its path with the Hugo baseUrl
- `openapi`: Loads an OpenAPI specifcation and render it as HTML using ReDoc
- `openapi`: Loads an OpenAPI specification and render it as HTML using ReDoc
- `include`: Include the content of a file in another file; the included file must be present in the '/content/includes/' directory
- `raw-html`: Include a block of raw HTML
- `readfile`: Include the content of another file in the current file, which can be in an arbitrary location.
Expand Down
8 changes: 8 additions & 0 deletions content/nginx-one/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ Data plane keys expire after one year. You can change this expiration date later

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.

{{<call-out "important" "Connecting to NGINX One" >}}
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:

- `3.135.72.139`
- `3.133.232.50`
- `52.14.85.249`
{{</call-out>}}

To install the NGINX Agent on an NGINX instance:

1. **Check if NGINX is running and start it if it's not:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ If you need to deactivate a data plane key before its expiration date, follow th
4. A confirmation dialog will appear. Select **Revoke** to confirm.


## Delete a data plane key (API only)
## Delete a data plane key

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

To delete a data plane key using the NGINX One REST API, see these guides:

- [Authenticate with the NGINX One REST API]({{< relref "nginx-one/api/authentication.md" >}})
- [Delete a data plane key: NGINX One API Reference]({{< relref "nginx-one/api/api-reference-guide.md#operation/deleteDataPlaneKey" >}})
1. On the left menu, select **Data Plane Keys**.
2. Find the key you want to revoke in the list of expired or revoked keys.
3. Next to the key name, select the check box. You can select multiple keys at the same time.
4. Select **Delete selected**.
8 changes: 5 additions & 3 deletions content/nginx-one/how-to/nginx-configs/add-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,15 @@ In either case, NGINX One Console gives you a choice for data plane keys:
- Create a new key
- Use an existing key

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

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.

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

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.
Once the process is complete, you can configure that instance in your NGINX One Console.

## Managed and Unmanaged Certificates

Expand Down
Loading