Skip to content
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.

Sign up for GitHub

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

Update environment var table to have descriptions instead of pairs #692

Closed
wants to merge 3 commits into from
Closed

Update environment var table to have descriptions instead of pairs #692

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcfcbda
Update environment var table to have descriptions instead of pairs
ADubhlaoich May 28, 2024
94f1d68
Merge branch 'main' into map-variables-flags
ADubhlaoich May 28, 2024
0707367
Add missing Agent API fields
ADubhlaoich May 28, 2024
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
43 changes: 3 additions & 40 deletions site/content/configuration/configuration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,46 +215,9 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con

### NGINX Agent Environment Variables

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).

{{<bootstrap-table "table table-striped table-bordered">}}

| Environment variable | CLI flag |
| ------------------------------------ | ---------------------------------------- |
| *NMS_CONFIG_DIRS* | *--config-dirs* |
| *NMS_DATAPLANE_REPORT_INTERVAL* | *--dataplane-report-interval* |
| *NMS_DATAPLANE_STATUS_POLL_INTERVAL* | *--dataplane-status-poll-interval* |
| *NMS_DISPLAY_NAME* | *--display-name* |
| *NMS_FEATURES* | *--features* |
| *NMS_INSTANCE_GROUP* | *--instance-group* |
| *NMS_LOG_LEVEL* | *--log-level* |
| *NMS_LOG_PATH* | *--log-path* |
| *NMS_PATH* | N/A, defines path for `nginx-agent.conf` |
| *NMS_METRICS_COLLECTION_INTERVAL* | *--metrics-collection-interval* |
| *NMS_METRICS_MODE* | *--metrics-mode* |
| *NMS_METRICS_BULK_SIZE* | *--metrics-bulk-size* |
| *NMS_METRICS_REPORT_INTERVAL* | *--metrics-report-interval* |
| *NMS_NGINX_EXCLUDE_LOGS* | *--nginx-exclude-log* |
| *NMS_NGINX_SOCKET* | *--nginx-socket* |
| *NMS_NGINX_TREAT_WARNINGS_AS_ERRORS* | *--nginx-treat-warnings-as-errors* |
| *NMS_QUEUE_SIZE* | *--queue-size* |
| *NMS_SERVER_GRPCPORT* | *--server-grpcport* |
| *NMS_SERVER_HOST* | *--server-host* |
| *NMS_SERVER_TOKEN* | *--server-token* |
| *NMS_SERVER_COMMAND* | *--server-command* |
| *NMS_SERVER_METRICS* | *--server-metrics* |
| *NMS_TAGS* | *--tags* |
| *NMS_TLS_CA* | *--tls-ca* |
| *NMS_TLS_CERT* | *--tls-cert* |
| *NMS_TLS_ENABLE* | *--tls-enable* |
| *NMS_TLS_KEY* | *--tls-key* |
| *NMS_TLS_SKIP_VERIFY* | *--tls-skip-verify* |
| *NMS_API_HOST* | *--api-host* |
| *NMS_API_PORT* | *--api-port* |
| *NMS_API_KEY* | *--api-key* |
| *NMS_API_CERT* | *--api-cert* |

{{</bootstrap-table>}}
This section displays the configurable options for NGINX Agent that can be set with environment variables.

{{< include "configuration/agent-env-var-table.md" >}}

### NGINX Agent Log Rotation

Expand Down
38 changes: 38 additions & 0 deletions site/content/includes/configuration/agent-env-var-table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
docs:
---

{{<bootstrap-table "table table-striped table-bordered table-responsive">}}

| Environment variable | Description |
| ------------------------------------ | ---------------------------------------- |
| *NMS_CONFIG_DIRS* | Defines the paths that you want to grant nginx-agent read/write access to. This key is formatted as a string and follows Unix PATH format. (default "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms") |
| *NMS_DATAPLANE_REPORT_INTERVAL* | The amount of time the agent will report on the dataplane. After this period of time it will send a snapshot of the dataplane information. (default 24h0m0s) |
| *NMS_DATAPLANE_STATUS_POLL_INTERVAL* | The frequency the agent will check the dataplane for changes. Used as a "heartbeat" to keep the gRPC connections alive. (default 30s) |
| *NMS_DISPLAY_NAME* | The instance's 'name' value. |
| *NMS_FEATURES* | 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]) |
| *NMS_INSTANCE_GROUP* | The instance's 'group' value. |
| *NMS_LOG_LEVEL* | The desired verbosity level for logging messages from nginx-agent. Available options, in order of severity from highest to lowest, are: panic, fatal, error, info, debug, and trace. (default "info") |
| *NMS_LOG_PATH* | The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr. |
| *NMS_PATH* | The path for `nginx-agent.conf` |
| *NMS_METRICS_BULK_SIZE* | The amount of metrics reports collected before sending the data back to the server. (default 20) |
| *NMS_METRICS_COLLECTION_INTERVAL* | Sets the interval, in seconds, at which metrics are collected. (default 15s) |
| *NMS_METRICS_MODE* | Sets the desired metrics collection mode: streaming or aggregation. (default "aggregated") |
| *NMS_METRICS_REPORT_INTERVAL* | The polling period specified for a single set of metrics being collected. (default 1m0s) |
| *NMS_NGINX_EXCLUDE_LOGS* | One or more NGINX access log paths that you want to exclude from metrics collection. This key is formatted as a string and multiple values should be provided as a comma-separated list. |
| *NMS_NGINX_SOCKET* | The NGINX Plus counting unix socket location. (default "unix:/var/run/nginx-agent/nginx.sock") |
| *NMS_NGINX_TREAT_WARNINGS_AS_ERRORS* | On nginx -t, treat warnings as failures on configuration application. |
| *NMS_QUEUE_SIZE* | The size of the NGINX Agent internal queue |
| *NMS_SERVER_COMMAND* | The name of the command server sent in the tls configuration. |
| *NMS_SERVER_GRPCPORT* | The desired GRPC port to use for nginx-agent traffic. |
| *NMS_SERVER_HOST* | The IP address of the server host. IPv4 addresses and hostnames are supported. |
| *NMS_SERVER_METRICS* | The name of the metrics server sent in the tls configuration. |
| *NMS_SERVER_TOKEN* | An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "e202f883-54c6-4702-be15-3ba6e507879a") |
| *NMS_TAGS* | A comma-separated list of tags to add to the current instance or machine, to be used for inventory purposes. |
| *NMS_TLS_CA* | The path to the CA certificate file to use for TLS. |
| *NMS_TLS_CERT* | The path to the certificate file to use for TLS. |
| *NMS_TLS_ENABLE* | Enables TLS for secure communications. |
| *NMS_TLS_KEY* | The path to the certificate key file to use for TLS. |
| *NMS_TLS_SKIP_VERIFY* | Only intended for demonstration, sets InsecureSkipVerify for gRPC TLS credentials |
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved

{{</bootstrap-table>}}
3 changes: 3 additions & 0 deletions site/content/includes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
headless: true
---
Loading