From 606e3ba38c3393c4a5f97b1983bf044394805568 Mon Sep 17 00:00:00 2001 From: Chelsea Holland Komlo Date: Mon, 21 May 2018 13:17:35 -0400 Subject: [PATCH] add documentation --- .../docs/agent/configuration/client.html.md | 16 ++++++++++++++++ .../docs/agent/configuration/server.html.md | 17 ++++++++++++----- 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/website/source/docs/agent/configuration/client.html.md b/website/source/docs/agent/configuration/client.html.md index 2f96da892a08..f3e9ab0366c4 100644 --- a/website/source/docs/agent/configuration/client.html.md +++ b/website/source/docs/agent/configuration/client.html.md @@ -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: [])` - 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 diff --git a/website/source/docs/agent/configuration/server.html.md b/website/source/docs/agent/configuration/server.html.md index 56b5e4abcd69..92e62f4920b6 100644 --- a/website/source/docs/agent/configuration/server.html.md +++ b/website/source/docs/agent/configuration/server.html.md @@ -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 @@ -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: [])` - Specifies a list of server addresses to - retry joining if the first attempt fails. This is similar to +- `retry_join` `(array: [])` - 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 @@ -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: [])` - 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