Skip to content

Commit 8b9a5c4

Browse files
spencerugbospencerugbo
authored
Update environment variables from NMS to NGINX_AGENT (#710)
* Update environment variables from NMS to NGINX_AGENT * added warning callout to deprecation message
1 parent 174be3d commit 8b9a5c4

File tree

2 files changed

+37
-36
lines changed

2 files changed

+37
-36
lines changed

‎site/content/configuration/configuration-overview.md

+31-30
Original file line numberDiff line numberDiff line change
@@ -160,41 +160,42 @@ nginx-agent
160160
{{<bootstrap-table "table table-responsive table-bordered">}}
161161
| CLI flag | Environment variable | Description |
162162
|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------|
163-
| `--api-cert` | `NMS_API_CERT` | Specifies the certificate used by the Agent API. |
164-
| `--api-host` | `NMS_API_HOST` | Sets the host used by the Agent API. Default: *127.0.0.1* |
165-
| `--api-key` | `NMS_API_KEY` | Specifies the key used by the Agent API. |
166-
| `--api-port` | `NMS_API_PORT` | Sets the port for exposing nginx-agent to HTTP traffic. |
167-
| `--config-dirs` | `NMS_CONFIG_DIRS` | Defines directories NGINX Agent can read/write. Default: *"/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"* |
168-
| `--dataplane-report-interval` | `NMS_DATAPLANE_REPORT_INTERVAL` | Sets the interval for dataplane reporting. Default: *24h0m0s* |
169-
| `--dataplane-status-poll-interval` | `NMS_DATAPLANE_STATUS_POLL_INTERVAL` | Sets the interval for polling dataplane status. Default: *30s* |
170-
| `--display-name` | `NMS_DISPLAY_NAME` | Sets the instance's display name. |
171-
| `--dynamic-config-path` | `NMS_DYNAMIC_CONFIG_PATH` | Specifies the path of the Agent dynamic config file. Default: *"/var/lib/nginx-agent/agent-dynamic.conf"* |
172-
| `--features` | `NMS_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* |
163+
| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. |
164+
| `--api-host` | `NGINX_AGENT_API_HOST` | Sets the host used by the Agent API. Default: *127.0.0.1* |
165+
| `--api-key` | `NGINX_AGENT_API_KEY` | Specifies the key used by the Agent API. |
166+
| `--api-port` | `NGINX_AGENT_API_PORT` | Sets the port for exposing nginx-agent to HTTP traffic. |
167+
| `--config-dirs` | `NGINX_AGENT_CONFIG_DIRS` | Defines directories NGINX Agent can read/write. Default: *"/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"* |
168+
| `--dataplane-report-interval` | `NGINX_AGENT_DATAPLANE_REPORT_INTERVAL` | Sets the interval for dataplane reporting. Default: *24h0m0s* |
169+
| `--dataplane-status-poll-interval` | `NGINX_AGENT_DATAPLANE_STATUS_POLL_INTERVAL` | Sets the interval for polling dataplane status. Default: *30s* |
170+
| `--display-name` | `NGINX_AGENT_DISPLAY_NAME` | Sets the instance's display name. |
171+
| `--dynamic-config-path` | `NGINX_AGENT_DYNAMIC_CONFIG_PATH` | Specifies the path of the Agent dynamic config file. Default: *"/var/lib/nginx-agent/agent-dynamic.conf"* |
172+
| `--features` | `NGINX_AGENT_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* |
173173
| `--ignore-directives` | | Specifies a comma-separated list of directives to ignore for sensitive info.|
174-
| `--instance-group` | `NMS_INSTANCE_GROUP` | Sets the instance's group value. |
175-
| `--log-level` | `NMS_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* |
176-
| `--log-path` | `NMS_LOG_PATH` | Specifies the path to output log messages. |
177-
| `--metrics-bulk-size` | `NMS_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* |
178-
| `--metrics-collection-interval` | `NMS_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* |
179-
| `--metrics-mode` | `NMS_METRICS_MODE` | Sets the metrics collection mode: streaming or aggregation. Default: *aggregated* |
180-
| `--metrics-report-interval` | `NMS_METRICS_REPORT_INTERVAL` | Sets the interval for reporting collected metrics. Default: *1m0s* |
174+
| `--instance-group` | `NGINX_AGENT_INSTANCE_GROUP` | Sets the instance's group value. |
175+
| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* |
176+
| `--log-path` | `NGINX_AGENT_LOG_PATH` | Specifies the path to output log messages. |
177+
| `--metrics-bulk-size` | `NGINX_AGENT_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* |
178+
| `--metrics-collection-interval` | `NGINX_AGENT_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* |
179+
| `--metrics-mode` | `NGINX_AGENT_METRICS_MODE` | Sets the metrics collection mode: streaming or aggregation. Default: *aggregated* |
180+
| `--metrics-report-interval` | `NGINX_AGENT_METRICS_REPORT_INTERVAL` | Sets the interval for reporting collected metrics. Default: *1m0s* |
181181
| `--nginx-config-reload-monitoring-period` | | Sets the duration to monitor error logs after an NGINX reload. Default: *10s* |
182-
| `--nginx-exclude-logs` | `NMS_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. |
183-
| `--nginx-socket` | `NMS_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* |
184-
| `--nginx-treat-warnings-as-errors` | `NMS_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. |
185-
| `--queue-size` | `NMS_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. |
182+
| `--nginx-exclude-logs` | `NGINX_AGENT_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. |
183+
| `--nginx-socket` | `NGINX_AGENT_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* |
184+
| `--nginx-treat-warnings-as-errors` | `NGINX_AGENT_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. |
185+
| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. |
186186
| `--server-command` | | Specifies the name of the command server sent in the TLS configuration. |
187-
| `--server-grpcport` | `NMS_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. |
188-
| `--server-host` | `NMS_SERVER_HOST` | Specifies the IP address of the server host. |
187+
| `--server-grpcport` | `NGINX_AGENT_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. |
188+
| `--server-host` | `NGINX_AGENT_SERVER_HOST` | Specifies the IP address of the server host. |
189189
| `--server-metrics` | | Specifies the name of the metrics server sent in the TLS configuration. |
190-
| `--server-token` | `NMS_SERVER_TOKEN` | Sets the authentication token for accessing the commander and metrics services. Default: *e202f883-54c6-4702-be15-3ba6e507879a* |
191-
| `--tags` | `NMS_TAGS` | Specifies a comma-separated list of tags for the instance or machine. |
192-
| `--tls-ca` | `NMS_TLS_CA` | Specifies the path to the CA certificate file for TLS. |
193-
| `--tls-cert` | `NMS_TLS_CERT` | Specifies the path to the certificate file for TLS. |
194-
| `--tls-enable` | `NMS_TLS_ENABLE` | Enables TLS for secure communications. |
195-
| `--tls-key` | `NMS_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
196-
| `--tls-skip-verify` | `NMS_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
190+
| `--server-token` | `NGINX_AGENT_SERVER_TOKEN` | Sets the authentication token for accessing the commander and metrics services. Default: *e202f883-54c6-4702-be15-3ba6e507879a* |
191+
| `--tags` | `NGINX_AGENT_TAGS` | Specifies a comma-separated list of tags for the instance or machine. |
192+
| `--tls-ca` | `NGINX_AGENT_TLS_CA` | Specifies the path to the CA certificate file for TLS. |
193+
| `--tls-cert` | `NGINX_AGENT_TLS_CERT` | Specifies the path to the certificate file for TLS. |
194+
| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. |
195+
| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
196+
| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
197197
{{</bootstrap-table>}}
198+
{{< warning >}}The environment prefix NMS has been deprecated in favour of NGINX_AGENT{{< /warning >}}
198199

199200
<br>
200201

‎site/content/configuration/encrypt-communication.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to-
5050
To enable mTLS for NGINX Agent using environment variables, run the following commands:
5151

5252
```bash
53-
NMS_TLS_CA="my-env-ca"
54-
NMS_TLS_KEY="my-env-key"
55-
NMS_TLS_CERT="my-env-cert"
56-
NMS_TLS_ENABLE=true
53+
NGINX_AGENT_TLS_CA="my-env-ca"
54+
NGINX_AGENT_TLS_KEY="my-env-key"
55+
NGINX_AGENT_TLS_CERT="my-env-cert"
56+
NGINX_AGENT_TLS_ENABLE=true
5757
```
5858

5959
<br>
@@ -87,7 +87,7 @@ nginx-agent --tls-enable
8787
To enable server-side TLS using environment variables, run the following commands:
8888

8989
```bash
90-
NMS_TLS_ENABLE=true
90+
NGINX_AGENT_TLS_ENABLE=true
9191
```
9292

9393
<br>
@@ -124,5 +124,5 @@ tls:
124124
To enable insecure mode using environment variables, run the following commands:
125125

126126
```bash
127-
NMS_TLS_ENABLE=false
127+
NGINX_AGENT_TLS_ENABLE=false
128128
```

0 commit comments

Comments
 (0)