Usage: envconsul-fips [options] <command>
Watches values from Consul's K/V store and Vault secrets to set environment
variables when the values are changed. It spawns a child process populated
with the environment variables.
Options:
-config=<path>
Sets the path to a configuration file or folder on disk. This can be
specified multiple times to load multiple files or folders. If multiple
values are given, they are merged left-to-right, and CLI arguments take
the top-most precedence.
-consul-addr=<address>
Sets the address of the Consul instance
-consul-auth=<username[:password]>
Set the basic authentication username and password for communicating
with Consul.
-consul-retry
Use retry logic when communication with Consul fails
-consul-retry-attempts=<int>
The number of attempts to use when retrying failed communications
-consul-retry-backoff=<duration>
The base amount to use for the backoff duration. This number will be
increased exponentially for each retry attempt.
-consul-retry-max-backoff=<duration>
The maximum limit of the retry backoff duration. Default is one minute.
0 means infinite. The backoff will increase exponentially until given value.
-consul-ssl
Use SSL when connecting to Consul
-consul-ssl-ca-cert=<string>
Validate server certificate against this CA certificate file list
-consul-ssl-ca-path=<string>
Sets the path to the CA to use for TLS verification
-consul-ssl-cert=<string>
SSL client certificate to send to server
-consul-ssl-key=<string>
SSL/TLS private key for use in client authentication key exchange
-consul-ssl-server-name=<string>
Sets the name of the server to use when validating TLS.
-consul-ssl-verify
Verify certificates when connecting via SSL
-consul-token=<token>
Sets the Consul API token
-consul-transport-dial-keep-alive=<duration>
Sets the amount of time to use for keep-alives
-consul-transport-dial-timeout=<duration>
Sets the amount of time to wait to establish a connection
-consul-transport-disable-keep-alives
Disables keep-alives (this will impact performance)
-consul-transport-max-idle-conns-per-host=<int>
Sets the maximum number of idle connections to permit per host
-consul-transport-tls-handshake-timeout=<duration>
Sets the handshake timeout
-exec=<command>
Enable exec mode to run as a supervisor-like process - the given command
will receive all signals provided to the parent process and will receive a
signal when templates change
-exec-kill-signal=<signal>
Signal to send when gracefully killing the process
-exec-kill-timeout=<duration>
Amount of time to wait before force-killing the child
-exec-splay=<duration>
Amount of time to wait before sending signals
-kill-signal=<signal>
Signal to listen to gracefully terminate the process
-log-level=<level>
Set the logging level - values are "trace", "debug", "info", "warn",
and "error"
-max-stale=<duration>
Set the maximum staleness and allow stale queries to Consul which will
distribute work among all servers instead of just the leader
-no-prefix[=<bool>]
Tells Envconsul to not prefix the keys with their parent "folder".
-once
Do not run as a daemon. Fetch the data, run the process once and exit.
-pid-file=<path>
Path on disk to write the PID of the process
-prefix=<prefix>
Add a prefix to watch (to the right of configured prefixes), multiple
prefixes are merged from left to right, with the right-most result taking
precedence, including any values specified with -secret (secrets
overrides prefixes)
-pristine
Only use values retrieved from prefixes and secrets, do not inherit the
existing environment variables
-reload-signal=<signal>
Signal to listen to reload configuration
-sanitize
Replace invalid characters in keys to underscores
-secret=<prefix>
Add a secret path to watch in Vault (to the right of configured secrets),
multiple prefixes are merged from left to right, with the right-most
result taking precedence, including any values specified with -prefix
(secrets overrides prefixes)
-service-query=<service-name>
A query to watch in Consul service parameters
-service-format-id=<{{service}}/{{key}}>
Format key environment for service id.
-service-format-name=<{{service}}/{{key}}>
Format key environment for service name.
-service-format-address=<{{service}}/{{key}}>
Format key environment for service address.
-service-format-tag=<{{service}}/{{key}}>
Format key environment for service tag.
-service-format-port=<{{service}}/{{key}}>
Format key environment for service port.
-syslog
Send the output to syslog instead of standard error and standard out. The
syslog facility defaults to LOCAL0 and can be changed using a
configuration file
-syslog-facility=<facility>
Set the facility where syslog should log - if this attribute is supplied,
the -syslog flag must also be supplied
-upcase
Convert all environment variable keys to uppercase
-vault-addr=<address>
Sets the address of the Vault server
-vault-namespace=<namespace>
Sets the Vault namespace
-vault-renew-token
Periodically renew the provided Vault API token - this defaults to "true"
and will renew the token at half of the lease duration (unless
vault-agent-token-file is set, then it defaults to false as it is
presumed the vault-agent will take care of renewing)
-vault-retry
Use retry logic when communication with Vault fails
-vault-retry-attempts=<int>
The number of attempts to use when retrying failed communications
-vault-retry-backoff=<duration>
The base amount to use for the backoff duration. This number will be
increased exponentially for each retry attempt.
-vault-retry-max-backoff=<duration>
The maximum limit of the retry backoff duration. Default is one minute.
0 means infinite. The backoff will increase exponentially until given value.
-vault-ssl
Specifies whether communications with Vault should be done via SSL
-vault-ssl-ca-cert=<string>
Sets the path to the CA certificate to use for TLS verification
-vault-ssl-ca-path=<string>
Sets the path to the CA to use for TLS verification
-vault-ssl-cert=<string>
Sets the path to the certificate to use for TLS verification
-vault-ssl-key=<string>
Sets the path to the key to use for TLS verification
-vault-ssl-server-name=<string>
Sets the name of the server to use when validating TLS.
-vault-ssl-verify
Enable SSL verification for communications with Vault.
-vault-token=<token>
Sets the Vault API token
-vault-agent-token-file=<token-file>
File to read Vault API token from.
-vault-transport-dial-keep-alive=<duration>
Sets the amount of time to use for keep-alives
-vault-transport-dial-timeout=<duration>
Sets the amount of time to wait to establish a connection
-vault-transport-disable-keep-alives
Disables keep-alives (this will impact performance)
-vault-transport-max-idle-conns-per-host=<int>
Sets the maximum number of idle connections to permit per host
-vault-transport-tls-handshake-timeout=<duration>
Sets the handshake timeout
-vault-unwrap-token
Unwrap the provided Vault API token (see Vault documentation for more
information on this feature)
-vault-k8s-auth-role-name
Enable k8s auth method and use this role name
-vault-k8s-service-account-token
Use this service token for the k8s auth method
-vault-k8s-service-account-token-path
Use the service token from the file for the k8s auth method
-vault-k8s-service-mount-path
Use this login mount path for the k8s auth method
-wait=<duration>
Sets the 'min(:max)' amount of time to wait before writing a template (and
triggering a command)
-v, -version
Print the version of this daemon
Options (72)
| Option | Description | Source |
|---|---|---|
-config path | Sets the path to a configuration file or folder on disk. | help |
-consul-addr address | Sets the address of the Consul instance | help |
-consul-auth username[:password | Set the basic authentication username and password for communicating with Consul. | help |
-consul-retry | Use retry logic when communication with Consul fails | help |
-consul-retry-attempts int | The number of attempts to use when retrying failed communications | help |
-consul-retry-backoff duration | The base amount to use for the backoff duration. | help |
-consul-retry-max-backoff duration | The maximum limit of the retry backoff duration. | help |
-consul-ssl | Use SSL when connecting to Consul | help |
-consul-ssl-ca-cert string | Validate server certificate against this CA certificate file list | help |
-consul-ssl-ca-path string | Sets the path to the CA to use for TLS verification | help |
-consul-ssl-cert string | SSL client certificate to send to server | help |
-consul-ssl-key string | SSL/TLS private key for use in client authentication key exchange | help |
-consul-ssl-server-name string | Sets the name of the server to use when validating TLS. | help |
-consul-ssl-verify | Verify certificates when connecting via SSL | help |
-consul-token token | Sets the Consul API token | help |
-consul-transport-dial-keep-alive duration | Sets the amount of time to use for keep-alives | help |
-consul-transport-dial-timeout duration | Sets the amount of time to wait to establish a connection | help |
-consul-transport-disable-keep-alives | Disables keep-alives (this will impact performance) | help |
-consul-transport-max-idle-conns-per-host int | Sets the maximum number of idle connections to permit per host | help |
-consul-transport-tls-handshake-timeout duration | Sets the handshake timeout | help |
-exec command | Enable exec mode to run as a supervisor-like process - the given command will receive all signals provided to the parent process and will receive a signal when templates change | help |
-exec-kill-signal signal | Signal to send when gracefully killing the process | help |
-exec-kill-timeout duration | Amount of time to wait before force-killing the child | help |
-exec-splay duration | Amount of time to wait before sending signals | help |
-kill-signal signal | Signal to listen to gracefully terminate the process | help |
-log-level level | Set the logging level - values are "trace", "debug", "info", "warn", and "error" | help |
-max-stale duration | Set the maximum staleness and allow stale queries to Consul which will distribute work among all servers instead of just the leader | help |
-no-prefix bool | Tells Envconsul to not prefix the keys with their parent "folder". | help |
-once | Do not run as a daemon. | help |
-pid-file path | Path on disk to write the PID of the process | help |
-prefix prefix | Add a prefix to watch (to the right of configured prefixes), multiple prefixes are merged from left to right, with the right-most result taking precedence, including any values specified with -secret… | help |
-pristine | Only use values retrieved from prefixes and secrets, do not inherit the existing environment variables | help |
-reload-signal signal | Signal to listen to reload configuration | help |
-sanitize | Replace invalid characters in keys to underscores | help |
-secret prefix | Add a secret path to watch in Vault (to the right of configured secrets), multiple prefixes are merged from left to right, with the right-most result taking precedence, including any values specified… | help |
-service-query service-name | A query to watch in Consul service parameters | help |
-service-format-id service}}/{{key | Format key environment for service id. | help |
-service-format-name service}}/{{key | Format key environment for service name. | help |
-service-format-address service}}/{{key | Format key environment for service address. | help |
-service-format-tag service}}/{{key | Format key environment for service tag. | help |
-service-format-port service}}/{{key | Format key environment for service port. | help |
-syslog | Send the output to syslog instead of standard error and standard out. | help |
-syslog-facility facility | Set the facility where syslog should log - if this attribute is supplied, the -syslog flag must also be supplied | help |
-upcase | Convert all environment variable keys to uppercase | help |
-vault-addr address | Sets the address of the Vault server | help |
-vault-namespace namespace | Sets the Vault namespace | help |
-vault-renew-token | Periodically renew the provided Vault API token - this defaults to "true" and will renew the token at half of the lease duration (unless vault-agent-token-file is set, then it defaults to false as it… | help |
-vault-retry | Use retry logic when communication with Vault fails | help |
-vault-retry-attempts int | The number of attempts to use when retrying failed communications | help |
-vault-retry-backoff duration | The base amount to use for the backoff duration. | help |
-vault-retry-max-backoff duration | The maximum limit of the retry backoff duration. | help |
-vault-ssl | Specifies whether communications with Vault should be done via SSL | help |
-vault-ssl-ca-cert string | Sets the path to the CA certificate to use for TLS verification | help |
-vault-ssl-ca-path string | Sets the path to the CA to use for TLS verification | help |
-vault-ssl-cert string | Sets the path to the certificate to use for TLS verification | help |
-vault-ssl-key string | Sets the path to the key to use for TLS verification | help |
-vault-ssl-server-name string | Sets the name of the server to use when validating TLS. | help |
-vault-ssl-verify | Enable SSL verification for communications with Vault. | help |
-vault-token token | Sets the Vault API token | help |
-vault-agent-token-file token-file | File to read Vault API token from. | help |
-vault-transport-dial-keep-alive duration | Sets the amount of time to use for keep-alives | help |
-vault-transport-dial-timeout duration | Sets the amount of time to wait to establish a connection | help |
-vault-transport-disable-keep-alives | Disables keep-alives (this will impact performance) | help |
-vault-transport-max-idle-conns-per-host int | Sets the maximum number of idle connections to permit per host | help |
-vault-transport-tls-handshake-timeout duration | Sets the handshake timeout | help |
-vault-unwrap-token | Unwrap the provided Vault API token (see Vault documentation for more information on this feature) | help |
-vault-k8s-auth-role-name | Enable k8s auth method and use this role name | help |
-vault-k8s-service-account-token | Use this service token for the k8s auth method | help |
-vault-k8s-service-account-token-path | Use the service token from the file for the k8s auth method | help |
-vault-k8s-service-mount-path | Use this login mount path for the k8s auth method | help |
-wait duration | Sets the 'min(:max)' amount of time to wait before writing a template (and triggering a command) | help |
-v, -version | Print the version of this daemon | help |