added more information about etcd TLS options
Scott Anderson
parent
e48ea4717f
commit
af54981fe9
content/chronograf/v1.8
administration
tools/chronograf-cli
|
|
@ -258,6 +258,18 @@ The default is 1s.
|
|||
|
||||
Environment variable: `$ETCD_REQUEST_TIMEOUT`
|
||||
|
||||
#### `--etcd-cert=`
|
||||
|
||||
Path to etcd PEM-encoded TLS public key certificate.
|
||||
|
||||
Environment variable: `$ETCD_CERTIFICATE`
|
||||
|
||||
#### `--etcd-key=`
|
||||
|
||||
Path to private key associated with specified etcd certificate.
|
||||
|
||||
Environment variable: `$ETCD_PRIVATE_KEY`
|
||||
|
||||
### Other service options
|
||||
|
||||
#### `--custom-link <display_name>:<link_address>`
|
||||
|
|
|
|||
|
|
@ -58,4 +58,15 @@ export ETCD_ENDPOINTS=localhost:2379,192.168.1.61:2379,192.192.168.1.100:2379
|
|||
chronograf
|
||||
```
|
||||
|
||||
##### Define etcd endpoints with TLS enabled
|
||||
Use the `--etcd-cert` flag to specify the path to the etcd PEM-encoded public
|
||||
certificate file and the `--etcd-key` flag to specify the path to the private key
|
||||
associated with the etcd certificate.
|
||||
|
||||
```sh
|
||||
chronograf --etcd-endpoints=localhost:2379 \
|
||||
--etcd-cert=path/to/etcd-certificate.pem \
|
||||
--etcd-key=path/to/etcd-private-key.key
|
||||
```
|
||||
|
||||
For more information, see [Chronograf etcd configuration options](/chronograf/v1.8/administration/config-options#etcd-options).
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ chronograf [flags]
|
|||
## Chronograf service flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
|
||||
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
|
||||
| `--host` | IP the Chronograf service listens on. By default, `0.0.0.0` | `$HOST` |
|
||||
| `--port` | Port the Chronograf service listens on for insecure connections. By default, `8888` | `$PORT` |
|
||||
| `-b`,`--bolt-path` | File path to the BoltDB file. By default, `./chronograf-v1.db` | `$BOLT_PATH` |
|
||||
|
|
@ -60,8 +60,8 @@ chronograf [flags]
|
|||
## Other service option flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:---------------------------------------------|:------------------------------------------------------------------------|:----------------------|
|
||||
| `--custom-link` <display_name>:<link_address>| Custom link added to Chronograf user menu options. Useful for providing links to internal company resources for your Chronograf users. Can be used when any OAuth 2.0 authentication is enabled. To add another custom link, repeat the custom link option. | |
|
||||
|:---------------------------- |:------------------------------------------------------------------------ |:----------------------|
|
||||
| `--custom-link` | Add a custom link to Chronograf user menu options using `<display_name>:<link_address>` syntax. For multiple custom links, include multiple flags. | |
|
||||
| `-r`, `--reporting-disabled` | Disables reporting of usage statistics. Usage statistics reported once every 24 hours include: `OS`, `arch`, `version`, `cluster_id`, and `uptime`. | `$REPORTING_DISABLED` |
|
||||
| `-l`, `--log-level` | Sets the logging level. Valid values include `info` (default), `debug`, and `error`. | `$LOG_LEVEL` |
|
||||
| `-d`, `--develop` | Runs the Chronograf service in developer mode | |
|
||||
|
|
@ -128,11 +128,11 @@ chronograf [flags]
|
|||
### etcd flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:--------------------------|:-------------------------------------------------------------------------------------------------------------|:------------------------|
|
||||
| `-e`, `--etcd-endpoints=` | List of etcd endpoints. | `$ETCD_ENDPOINTS` |
|
||||
| `--etcd-username=` | Username to log into etcd. | `$ETCD_USERNAME` |
|
||||
| `--etcd-password=` | Password to log into etcd. | `$ETCD_PASSWORD` |
|
||||
| `--etcd-dial-timeout=` | Total time to wait before timing out while connecting to etcd endpoints. 0 means no timeout. (default: -1s) | `$ETCD_DIAL_TIMEOUT` |
|
||||
| `--etcd-request-timeout=` | Total time to wait before timing out the etcd view or update. 0 means no timeout. (default: -1s) | `$ETCD_REQUEST_TIMEOUT` |
|
||||
| `--etcd-cert=` | Path to PEM encoded TLS public key certificate for use with TLS. | `$ETCD_CERTIFICATE` |
|
||||
| `--etcd-key=` | Path to private key associated with given certificate for use with TLS. | `$ETCD_PRIVATE_KEY` |
|
||||
|:--------------------------|:-----------------------------------------------------------------------------------------------------------|:------------------------|
|
||||
| `-e`, `--etcd-endpoints` | etcd endpoint URL (include multiple flags for multiple endpoints) | `$ETCD_ENDPOINTS` |
|
||||
| `--etcd-username` | etcd username | `$ETCD_USERNAME` |
|
||||
| `--etcd-password` | etcd password | `$ETCD_PASSWORD` |
|
||||
| `--etcd-dial-timeout` | Total time to wait before timing out while connecting to etcd endpoints (0 means no timeout, default: -1s) | `$ETCD_DIAL_TIMEOUT` |
|
||||
| `--etcd-request-timeout` | Total time to wait before timing out the etcd view or update (0 means no timeout, default: -1s) | `$ETCD_REQUEST_TIMEOUT` |
|
||||
| `--etcd-cert` | Path to PEM encoded TLS public key certificate for use with TLS | `$ETCD_CERTIFICATE` |
|
||||
| `--etcd-key` | Path to private key associated with given certificate for use with TLS | `$ETCD_PRIVATE_KEY` |
|
||||
|
|
|
|||
Loading…
Reference in New Issue