Skip to content

Commit

Permalink
Add missing documentation entries for CLI flags
Browse files Browse the repository at this point in the history
  • Loading branch information
Dean-Coakley committed Sep 15, 2023
1 parent 556f51e commit 5b2a512
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions hugo/content/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,12 @@ Flags:
--dataplane-report-interval duration 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)
--dataplane-status-poll-interval duration The frequency the agent will check the dataplane for changes. Used as a "heartbeat" to keep the gRPC connections alive. (default 30s)
--display-name string The instance's 'name' value.
--features strings A comma-separated list of features enabled for the agent. (default [registration,nginx-config-async,nginx-ssl-config,nginx-counting,metrics,metrics-throttle,dataplane-status,process-watcher,file-watcher,activity-events,agent-api])
--features strings 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])
-h, --help help for nginx-agent
--ignore-directives strings A comma-separated list of ignoring directives which contain sensitive info.
--instance-group string The instance's 'group' value.
--log-level string 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")
--log-path string The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr. (default "/var/log/nginx-agent")
--log-path string The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr.
--metrics-bulk-size int The amount of metrics reports collected before sending the data back to the server. (default 20)
--metrics-collection-interval duration Sets the interval, in seconds, at which metrics are collected. (default 15s)
--metrics-mode string Sets the desired metrics collection mode: streaming or aggregation. (default "aggregated")
Expand All @@ -177,7 +178,7 @@ Flags:
--server-grpcport int The desired GRPC port to use for nginx-agent traffic.
--server-host string The IP address of the server host. IPv4 addresses and hostnames are supported.
--server-metrics string The name of the metrics server sent in the tls configuration.
--server-token string An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "750d0148-c4b2-499a-9011-ca5a8c752d52")
--server-token string An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "e202f883-54c6-4702-be15-3ba6e507879a")
--tags strings A comma-separated list of tags to add to the current instance or machine, to be used for inventory purposes.
--tls-ca string The path to the CA certificate file to use for TLS.
--tls-cert string The path to the certificate file to use for TLS.
Expand Down

0 comments on commit 5b2a512

Please sign in to comment.