Skip to content

Commit 44ae987

Browse files
committed
feature: add agent v3 info to get started
1 parent 75b3007 commit 44ae987

File tree

3 files changed

+35
-15
lines changed

3 files changed

+35
-15
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
docs: DOCS-000
3+
files:
4+
- content/nginx-one/getting-started.md
5+
- content/nginx-one/agent/containers/run-agent-container.md
6+
---
7+
8+
```yaml
9+
command:
10+
server:
11+
host: "<NGINX-One-Console-URL>" # Command server host
12+
port: 443 # Command server port
13+
auth:
14+
token: "<your-data-plane-key-here>" # Authentication token for the command server
15+
tls:
16+
skip_verify: false
17+
```

content/nginx-one/agent/containers/run-agent-container.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,13 @@ Ensure you are using the correct image version. Replace `latest` with the desire
4545
Create a configuration file named `nginx-agent.conf` in your current directory
4646
and populate the file with the following structure:
4747

48-
```yaml
49-
command:
50-
server:
51-
host: "<NGINX-One-Console-URL>" # Command server host
52-
port: 443 # Command server port
53-
auth:
54-
token: "<your-data-plane-key-here>" # Authentication token for the command server
55-
tls:
56-
skip_verify: false
57-
```
5848

59-
Replace the placeholder values:
49+
{{< include "/nginx-one/conf/nginx-agent.conf.md" >}}
6050

61-
- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance.
62-
- `<your-data-plane-key-here>`: Your Data Plane access token.
51+
Replace the placeholder values:
6352

53+
- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance, typically https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ .
54+
- `<your-data-plane-key-here>`: Your Data Plane key.
6455

6556
## Run the container
6657

content/nginx-one/getting-started.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,19 @@ To install NGINX Agent on an NGINX instance:
9393
- Replace `YOUR_DATA_PLANE_KEY` with your actual data plane key.
9494
- The `-y` option automatically confirms any prompts during installation.
9595
96-
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.
96+
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:
97+
98+
{{< include "/nginx-one/conf/nginx-agent.conf.md" >}}
99+
```yaml
100+
server:
101+
token: "<YOUR_DATA_PLANE_KEY>"
102+
host: agent.connect.nginx.com
103+
grpcPort: 443
104+
105+
tls:
106+
enable: True
107+
skip_verify: False
108+
```
97109
98110
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`.
99111
@@ -138,7 +150,7 @@ The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Sou
138150
139151
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
140152
141-
---
153+
---
142154
143155
## View instance metrics with the NGINX One dashboard
144156

0 commit comments

Comments
 (0)