Skip to content

Commit 4bb0bdb

Browse files
authored
feature: incorporate nginx-agent.conf 3.0 changes to Get started guide (#685)
Convert the Agent conf 3.0 changes to an include and use it where relevant
1 parent c7a4872 commit 4bb0bdb

File tree

3 files changed

+26
-17
lines changed

3 files changed

+26
-17
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
```
18+
19+
Replace the placeholder values:
20+
21+
- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance, typically https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ .
22+
- `<your-data-plane-key-here>`: Your Data Plane key.

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,8 @@ 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-
```
58-
59-
Replace the placeholder values:
6048

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

6451

6552
## Run the container

content/nginx-one/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ 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:
9797
98-
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`.
98+
{{< include "/nginx-one/conf/nginx-agent-conf.md" >}}
9999
100100
<span style="display: inline-block; margin-top: 20px;" >
101101
@@ -138,7 +138,7 @@ The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Sou
138138
139139
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
140140
141-
---
141+
---
142142
143143
## View instance metrics with the NGINX One dashboard
144144

0 commit comments

Comments
 (0)