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

[docs/help] Explain what "watch" mode actually does #831

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[docs/help] Explain what "watch" mode actually does #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func init() {
flag.StringVar(&config.Separator, "separator", "", "the separator to replace '/' with when looking up keys in the backend, prefixed '/' will also be removed (only used with -backend=redis)")
flag.StringVar(&config.Username, "username", "", "the username to authenticate as (only used with vault and etcd backends)")
flag.StringVar(&config.Password, "password", "", "the password to authenticate with (only used with vault and etcd backends)")
flag.BoolVar(&config.Watch, "watch", false, "enable watch support")
flag.BoolVar(&config.Watch, "watch", false, "actively watch the backend for changes vs. checking every INTERVAL seconds (dynamodb and ssm are not supported)")
}

// initConfig initializes the confd configuration by first setting defaults,
Expand Down
2 changes: 1 addition & 1 deletion docs/command-line-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Usage of confd:
-version
print version and exit
-watch
enable watch support
actively watch the backend for changes vs. checking every INTERVAL seconds (dynamodb and ssm are not supported)
```

> The -scheme flag is only used to set the URL scheme for nodes retrieved from DNS SRV records.
2 changes: 1 addition & 1 deletion docs/configuration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Optional:
* `srv_domain` (string) - The name of the resource record.
* `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.
* `watch` (bool) - Actively watch the backend for changes vs. checking every INTERVAL seconds (dynamodb and ssm are not supported).
* `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).
Expand Down