Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chelseakomlo committed May 21, 2018
1 parent 72705b4 commit 606e3ba
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 5 deletions.
16 changes: 16 additions & 0 deletions website/source/docs/agent/configuration/client.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,22 @@ client {
receive work. This may be specified as an IP address or DNS, with or without
the port. If the port is omitted, the default port of `4647` is used.

- `server_join` `(map[string]string` - Specifies the list of server information
to retry joining. The fields contained are:

- `retry_join` `(array<string>: [])` - Specifies a list of server
addresses to retry joining if the first attempt fails. The list of
addresses will be tried in the order specified, until one
succeeds. After one succeeds, no further addresses will be contacted. This is
useful for cases where we know the address will become available eventually.

- `retry_interval` `(string: "30s")` - Specifies the time to wait between retry
join attempts.

- `retry_max` `(int: 0)` - Specifies the maximum number of join attempts to be
made before exiting with a return code of 1. By default, this is set to 0
which is interpreted as infinite retries.

- `state_dir` `(string: "[data_dir]/client")` - Specifies the directory to use
to store client state. By default, this is - the top-level
[data_dir](/docs/agent/configuration/index.html#data_dir) suffixed with
Expand Down
17 changes: 12 additions & 5 deletions website/source/docs/agent/configuration/server.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ server {
second is a tradeoff as it lowers failure detection time of nodes at the
tradeoff of false positives and increased load on the leader.

- `non_voting_server` `(bool: false)` - (Enterprise-only) Specifies whether
this server will act as a non-voting member of the cluster to help provide
read scalability.
- `non_voting_server` `(bool: false)` - (Enterprise-only) Specifies whether
this server will act as a non-voting member of the cluster to help provide
read scalability.

- `num_schedulers` `(int: [num-cores])` - Specifies the number of parallel
scheduler threads to run. This can be as many as one per core, or `0` to
Expand All @@ -131,8 +131,8 @@ server {
cluster again when starting. This flag allows the previous state to be used to
rejoin the cluster.

- `retry_join` `(array<string>: [])` - Specifies a list of server addresses to
retry joining if the first attempt fails. This is similar to
- `retry_join` `(array<string>: [])` - Specifies a list of server
addresses to retry joining if the first attempt fails. This is similar to
[`start_join`](#start_join), but only invokes if the initial join attempt
fails. The list of addresses will be tried in the order specified, until one
succeeds. After one succeeds, no further addresses will be contacted. This is
Expand All @@ -148,6 +148,13 @@ server {
made before exiting with a return code of 1. By default, this is set to 0
which is interpreted as infinite retries.

- `server_join` `(map[string]string` - Specifies the list of server information
to retry joining. The fields contained are [retry_join](#retry_join),
[retry_interval](#retry_interval), [retry_max](#retry_max), and
[start_join](start_join). These fields will only be able to be specified in
the `server_join` stanza after Nomad 0.10 and will are deprecated as top-level
configuration on the server stanza.

- `start_join` `(array<string>: [])` - Specifies a list of server addresses to
join on startup. If Nomad is unable to join with any of the specified
addresses, agent startup will fail. See the
Expand Down

0 comments on commit 606e3ba

Please sign in to comment.