Skip to content

feature: incorporate nginx-agent.conf 3.0 changes to Get started guide #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 19, 2025
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
22 changes: 22 additions & 0 deletions content/includes/nginx-one/conf/nginx-agent-conf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
docs: DOCS-000
files:
- content/nginx-one/getting-started.md
- content/nginx-one/agent/containers/run-agent-container.md
---

```yaml
command:
server:
host: "<NGINX-One-Console-URL>" # Command server host
port: 443 # Command server port
auth:
token: "<your-data-plane-key-here>" # Authentication token for the command server
tls:
skip_verify: false
```

Replace the placeholder values:

- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance, typically https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ .
- `<your-data-plane-key-here>`: Your Data Plane key.
15 changes: 1 addition & 14 deletions content/nginx-one/agent/containers/run-agent-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,8 @@ Ensure you are using the correct image version. Replace `latest` with the desire
Create a configuration file named `nginx-agent.conf` in your current directory
and populate the file with the following structure:

```yaml
command:
server:
host: "<NGINX-One-Console-URL>" # Command server host
port: 443 # Command server port
auth:
token: "<your-data-plane-key-here>" # Authentication token for the command server
tls:
skip_verify: false
```

Replace the placeholder values:

- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance.
- `<your-data-plane-key-here>`: Your Data Plane access token.
{{< include "/nginx-one/conf/nginx-agent-conf.md" >}}


## Run the container
Expand Down
6 changes: 3 additions & 3 deletions content/nginx-one/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ To install NGINX Agent on an NGINX instance:
- Replace `YOUR_DATA_PLANE_KEY` with your actual data plane key.
- The `-y` option automatically confirms any prompts during installation.

The `install` script writes an `nginx-agent.conf` file to the `/etc/nginx-agent/` directory, with the [data plane key](#generate-data-plane-key) that you generated. You can find the key, host address, TLS status, and other information in the `nginx-agent.conf` file.
The `install` script writes an `nginx-agent.conf` file to the `/etc/nginx-agent/` directory, with the [data plane key](#generate-data-plane-key) that you generated. You can find this information in the `nginx-agent.conf` file:

If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agent/installation-upgrade/) guides for installing NGINX Agent, you may need to add this information manually to `nginx-agent.conf`.
{{< include "/nginx-one/conf/nginx-agent-conf.md" >}}

<span style="display: inline-block; margin-top: 20px;" >

Expand Down Expand Up @@ -138,7 +138,7 @@ The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Sou

{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}

---
---

## View instance metrics with the NGINX One dashboard

Expand Down
Loading