Skip to content

Commit

Permalink
Update docs with the new config options
Browse files Browse the repository at this point in the history
  • Loading branch information
okushchenko committed May 3, 2018
1 parent c9535ae commit 42006c8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/command-line-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Usage of confd:
-confdir string
confd conf directory (default "/etc/confd")
-config-file string
the confd config file
-file string
list of files/directories with data represented in YAML to watch for changes
the confd config file (default "/etc/confd/confd.toml")
-file value
the YAML file to watch for changes (only used with -backend=file)
-filter string
regex for files and dirs filtering
files filter (only used with -backend=file) (default "*")
-interval int
backend polling interval (default 600)
-keep-stage-file
Expand All @@ -49,13 +49,15 @@ Usage of confd:
-prefix string
key path prefix
-role-id string
Vault role-id to use with the AppRole, Kubernetes backend (only used with -backend=vault and either auth-type=app-role or auth-type=kubernetes)
Vault role-id to use with the AppRole, Kubernetes backends (only used with -backend=vault and either auth-type=app-role or auth-type=kubernetes)
-scheme string
the backend URI scheme for nodes retrieved from DNS SRV records (http or https) (default "http")
-secret-id string
Vault secret-id to use with the AppRole backend (only used with -backend=vault and auth-type=app-role)
-secret-keyring string
path to armored PGP secret keyring (for use with crypt functions)
-separator string
the separator to replace '/' with when looking up keys in the backend, prefixed '/' will also be removed (only used with -backend=redis)
-srv-domain string
the name of the resource record
-srv-record string
Expand All @@ -64,12 +66,12 @@ Usage of confd:
sync without check_cmd and reload_cmd
-table string
the name of the DynamoDB table (only used with -backend=dynamodb)
-separator string
the separator to replace '/' with when looking up keys in the backend, prefixed "/" will also be removed (only used with -backend=redis, default "/")
-user-id string
Vault user-id to use with the app-id backend (only used with -backend=value and auth-type=app-id)
-username string
the username to authenticate as (only used with vault and etcd backends)
-vault-path string
Vault mount path of the auth method (only used with -backend=vault)
-version
print version and exit
-watch
Expand Down
14 changes: 14 additions & 0 deletions docs/configuration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ Optional:
* `srv_record` (string) - The SRV record to search for backends nodes.
* `sync-only` (bool) - sync without check_cmd and reload_cmd.
* `watch` (bool) - Enable watch support.
* `auth_token` (string) - Auth bearer token to use.
* `auth_type` (string) - Vault auth backend type to use.
* `basic_auth` (bool) - Use Basic Auth to authenticate (only used with -backend=consul and -backend=etcd).
* `table` (string) - The name of the DynamoDB table (only used with -backend=dynamodb).
* `separator` (string) - The separator to replace '/' with when looking up keys in the backend, prefixed '/' will also be removed (only used with -backend=redis)
* `username` (string) - The username to authenticate as (only used with vault and etcd backends).
* `password` (string) - The password to authenticate with (only used with vault and etcd backends).
* `app_id` (string) - Vault app-id to use with the app-id backend (only used with -backend=vault and auth-type=app-id).
* `user_id` (string) - Vault user-id to use with the app-id backend (only used with -backend=value and auth-type=app-id).
* `role_id` (string) - Vault role-id to use with the AppRole, Kubernetes backends (only used with -backend=vault and either auth-type=app-role or auth-type=kubernetes).
* `secret_id` (string) - Vault secret-id to use with the AppRole backend (only used with -backend=vault and auth-type=app-role).
* `file` (array of strings) - The YAML file to watch for changes (only used with -backend=file).
* `filter` (string) - Files filter (only used with -backend=file) (default "*").
* `vault_path` (string) - Vault mount path of the auth method (only used with -backend=vault).

Example:

Expand Down

0 comments on commit 42006c8

Please sign in to comment.