Skip to content

Commit 27a2a49

Browse files
authored
Merge pull request #689 from nginx/map-variables-flags
This commit changes the list of NGINX Agent variables to a table showing how it maps to the CLI flags, with an exception for the variable that doesn't have a flag yet. It links to the CLI flag section so that the reader can view the descriptions for additional context.
2 parents 84082a5 + e870bc1 commit 27a2a49

File tree

2 files changed

+37
-37
lines changed

2 files changed

+37
-37
lines changed

site/content/configuration/configuration-overview.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -215,42 +215,42 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con
215215

216216
### NGINX Agent Environment Variables
217217

218-
This section displays the configurable options for NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below:
219-
220-
<details open>
221-
<summary>NGINX Agent Environment Variables</summary>
222-
223-
```text
224-
- NMS_INSTANCE_GROUP
225-
- NMS_DISPLAY_NAME
226-
- NMS_FEATURES
227-
- NMS_LOG_LEVEL
228-
- NMS_LOG_PATH
229-
- NMS_PATH
230-
- NMS_METRICS_COLLECTION_INTERVAL
231-
- NMS_METRICS_MODE
232-
- NMS_METRICS_BULK_SIZE
233-
- NMS_METRICS_REPORT_INTERVAL
234-
- NMS_NGINX_EXCLUDE_LOGS
235-
- NMS_NGINX_SOCKET
236-
- NMS_NGINX_TREAT_WARNINGS_AS_ERRORS
237-
- NMS_SERVER_GRPCPORT
238-
- NMS_SERVER_HOST
239-
- NMS_SERVER_TOKEN
240-
- NMS_SERVER_COMMAND
241-
- NMS_SERVER_METRICS
242-
- NMS_TAGS
243-
- NMS_TLS_CA
244-
- NMS_TLS_CERT
245-
- NMS_TLS_ENABLE
246-
- NMS_TLS_KEY
247-
- NMS_TLS_SKIP_VERIFY
248-
- NMS_CONFIG_DIRS
249-
- NMS_QUEUE_SIZE
250-
- NMS_DATAPLANE_REPORT_INTERVAL
251-
- NMS_DATAPLANE_STATUS_POLL_INTERVAL
252-
```
253-
</details>
218+
This section displays the configurable options for NGINX Agent that can be set with environment variables. Each environment variable maps to a CLI flag, [explained above](#nginx-agent-cli-flags-usage).
219+
220+
{{<bootstrap-table "table table-striped table-bordered">}}
221+
222+
| Environment variable | CLI flag |
223+
| ------------------------------------ | ---------------------------------------- |
224+
| *NMS_CONFIG_DIRS* | *--config-dirs* |
225+
| *NMS_DATAPLANE_REPORT_INTERVAL* | *--dataplane-report-interval* |
226+
| *NMS_DATAPLANE_STATUS_POLL_INTERVAL* | *--dataplane-status-poll-interval* |
227+
| *NMS_DISPLAY_NAME* | *--display-name* |
228+
| *NMS_FEATURES* | *--features* |
229+
| *NMS_INSTANCE_GROUP* | *--instance-group* |
230+
| *NMS_LOG_LEVEL* | *--log-level* |
231+
| *NMS_LOG_PATH* | *--log-path* |
232+
| *NMS_PATH* | N/A, defines path for `nginx-agent.conf` |
233+
| *NMS_METRICS_COLLECTION_INTERVAL* | *--metrics-collection-interval* |
234+
| *NMS_METRICS_MODE* | *--metrics-mode* |
235+
| *NMS_METRICS_BULK_SIZE* | *--metrics-bulk-size* |
236+
| *NMS_METRICS_REPORT_INTERVAL* | *--metrics-report-interval* |
237+
| *NMS_NGINX_EXCLUDE_LOGS* | *--nginx-exclude-log* |
238+
| *NMS_NGINX_SOCKET* | *--nginx-socket* |
239+
| *NMS_NGINX_TREAT_WARNINGS_AS_ERRORS* | *--nginx-treat-warnings-as-errors* |
240+
| *NMS_QUEUE_SIZE* | *--queue-size* |
241+
| *NMS_SERVER_GRPCPORT* | *--server-grpcport* |
242+
| *NMS_SERVER_HOST* | *--server-host* |
243+
| *NMS_SERVER_TOKEN* | *--server-token* |
244+
| *NMS_SERVER_COMMAND* | *--server-command* |
245+
| *NMS_SERVER_METRICS* | *--server-metrics* |
246+
| *NMS_TAGS* | *--tags* |
247+
| *NMS_TLS_CA* | *--tls-ca* |
248+
| *NMS_TLS_CERT* | *--tls-cert* |
249+
| *NMS_TLS_ENABLE* | *--tls-enable* |
250+
| *NMS_TLS_KEY* | *--tls-key* |
251+
| *NMS_TLS_SKIP_VERIFY* | *--tls-skip-verify* |
252+
253+
{{</bootstrap-table>}}
254254

255255
### NGINX Agent Log Rotation
256256

site/content/installation-upgrade/container-environments/docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ docker run --name nginx-agent -d nginx-agent
170170
To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example:
171171

172172
```yaml
173-
erver:
173+
server:
174174
host: 127.0.0.1 # mock control plane host
175175
grpcPort: 54789 # mock control plane gRPC port
176176

0 commit comments

Comments
 (0)