fix doc links and other improvements
This commit is contained in:
Chelsea Holland Komlo
Alex Dadgar
parent
0a4459f625
commit
49c44eb453
|
|
@ -90,7 +90,7 @@ 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` [ServerJoin][server_join] - Specifies
|
||||
- `server_join` <code>([server_join](#server-join): nil)</code> - Specifies
|
||||
configuration which is specific to retry joining Nomad servers.
|
||||
|
||||
- `state_dir` `(string: "[data_dir]/client")` - Specifies the directory to use
|
||||
|
|
@ -310,7 +310,11 @@ cluster.
|
|||
```hcl
|
||||
client {
|
||||
enabled = true
|
||||
servers = ["1.2.3.4:4647", "5.6.7.8:4647"]
|
||||
server_join {
|
||||
retry_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
retry_max = 3
|
||||
retry_interval = "15s"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -349,4 +353,4 @@ client {
|
|||
}
|
||||
}
|
||||
```
|
||||
[server_join]: /docs/agent/configuration/server_join.html.md "Server Join"
|
||||
[server-join]: /docs/agent/configuration/server_join.html "Server Join"
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ layout: "docs"
|
|||
page_title: "Cloud Auto-join"
|
||||
sidebar_current: "docs-agent-cloud-auto-join"
|
||||
description: |-
|
||||
Nomad supports automatic cluster joining using cloud metadata on various providers.
|
||||
Nomad supports automatic cluster joining using cloud metadata from various cloud providers
|
||||
---
|
||||
|
||||
# Cloud Auto-joining
|
||||
|
|
@ -32,8 +32,9 @@ In order to use discovery behind a proxy, you will need to set
|
|||
`HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables per
|
||||
[Golang `net/http` library](https://golang.org/pkg/net/http/#ProxyFromEnvironment).
|
||||
|
||||
The following sections give the options specific to each supported cloud
|
||||
provider.
|
||||
The following sections give the options specific to a subset of supported cloud
|
||||
provider. For information on all providers, see further documentation in
|
||||
[go-discover](https://github.com/hashicorp/go-discover).
|
||||
|
||||
### Amazon EC2
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,11 @@ join failures, and more.
|
|||
server {
|
||||
enabled = true
|
||||
bootstrap_expect = 3
|
||||
retry_join = ["1.2.3.4", "5.6.7.8"]
|
||||
server_join {
|
||||
retry_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
retry_max = 3
|
||||
retry_interval = "15s"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -131,8 +135,8 @@ server {
|
|||
cluster again when starting. This flag allows the previous state to be used to
|
||||
rejoin the cluster.
|
||||
|
||||
- `server_join` - Specifies the [Server Join][server_join] stanza for
|
||||
configuration which is specific to retry joining Nomad servers.
|
||||
- `server_join` <code>([server_join](#server-join): nil)</code> - Specifies
|
||||
configuration for retry joining Nomad servers if the first attempt fails.
|
||||
|
||||
- `upgrade_version` `(string: "")` - A custom version of the format X.Y.Z to use
|
||||
in place of the Nomad version when custom upgrades are enabled in Autopilot.
|
||||
|
|
@ -147,25 +151,25 @@ server {
|
|||
succeeds. After one succeeds, no further addresses will be contacted. This is
|
||||
useful for cases where we know the address will become available eventually.
|
||||
Use `retry_join` with an array as a replacement for `start_join`, **do not use
|
||||
both options**. See the [server_join](#server_join)
|
||||
both options**. See the [server_join](#server-join)
|
||||
section for more information on the format of the string. This field is
|
||||
deprecated in favor of [server_join](#server_join).
|
||||
deprecated in favor of [server_join](#server-join).
|
||||
|
||||
- `retry_interval` `(string: "30s")` - Specifies the time to wait between retry
|
||||
join attempts. This field is deprecated in favor of
|
||||
[server_join](#server_join).
|
||||
[server_join](#server-join).
|
||||
|
||||
- `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. This field is deprecated in favor
|
||||
of [server_join](#server_join).
|
||||
of [server_join](#server-join).
|
||||
|
||||
- `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
|
||||
[server address format](#server-address-format) section for more information
|
||||
on the format of the string. This field is deprecated in favor of
|
||||
[server_join](#server_join).
|
||||
[server_join](#server-join).
|
||||
|
||||
## `server` Examples
|
||||
|
||||
|
|
@ -213,4 +217,4 @@ server {
|
|||
```
|
||||
|
||||
[encryption]: /docs/agent/encryption.html "Nomad Agent Encryption"
|
||||
[server_join]: /docs/agent/configuration/server_join.html.md "Server Join"
|
||||
[server-join]: /docs/agent/configuration/server_join.html.md "Server Join"
|
||||
|
|
|
|||
|
|
@ -13,7 +13,6 @@ The server_join stanza specifies how the Nomad agent will discover and connect t
|
|||
```hcl
|
||||
server_join {
|
||||
retry_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
start_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
retry_max = 3
|
||||
retry_interval = "15s"
|
||||
}
|
||||
|
|
@ -21,7 +20,7 @@ server_join {
|
|||
|
||||
## `server_join` Parameters
|
||||
|
||||
- `retry_join` `(array<string>: [])` - Specifies a list of server
|
||||
- `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, and is available to both Nomad servers and clients, while
|
||||
|
|
@ -32,33 +31,35 @@ server_join {
|
|||
Use `retry_join` with an array as a replacement for `start_join`, **do not use
|
||||
both options**.
|
||||
|
||||
Address format includes both using IP addresses as well as an interface to the
|
||||
[go-discover](https://github.com/hashicorp/go-discover) library for doing
|
||||
automated cluster joining using cloud metadata.
|
||||
See Cloud Auto Join`<code>([CloudAutoJoin][cloud_auto_join]: nil)</code>.
|
||||
```
|
||||
server_join {
|
||||
retry_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
}
|
||||
```
|
||||
Using the `go-discover` interface, this can be defined both in a client or
|
||||
server configuration as well as provided as a command-line argument.
|
||||
```
|
||||
server_join {
|
||||
retry_join = [ "provider=aws tag_key=..." ]
|
||||
}
|
||||
```
|
||||
See the [server address format](#server-address-format) for more information
|
||||
about expected server address formats.
|
||||
Address format includes both using IP addresses as well as an interface to the
|
||||
[go-discover](https://github.com/hashicorp/go-discover) library for doing
|
||||
automated cluster joining using cloud metadata.
|
||||
See Cloud Auto Join`<code>([CloudAutoJoin][cloud_auto_join]: nil)</code>.
|
||||
|
||||
- `retry_interval` `(string: "30s")` - Specifies the time to wait between retry
|
||||
```
|
||||
server_join {
|
||||
retry_join = [ "1.1.1.1", "2.2.2.2" ]
|
||||
}
|
||||
```
|
||||
|
||||
Using the `go-discover` interface, this can be defined both in a client or
|
||||
server configuration as well as provided as a command-line argument.
|
||||
```
|
||||
server_join {
|
||||
retry_join = [ "provider=aws tag_key=..." ]
|
||||
}
|
||||
```
|
||||
See the [server address format](#server-address-format) for more information
|
||||
about expected server address formats.
|
||||
|
||||
- `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
|
||||
- `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.
|
||||
|
||||
- `start_join` `(array<string>: [])` - Specifies a list of server addresses to
|
||||
- `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
|
||||
[server address format](#server-address-format) section for more information
|
||||
|
|
|
|||
|
|
@ -31,7 +31,9 @@ server {
|
|||
bootstrap_expect = 3
|
||||
|
||||
# This is the IP address of the first server we provisioned
|
||||
retry_join = ["<known-address>:4648"]
|
||||
server_join {
|
||||
retry_join = ["<known-address>:4648"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -420,8 +420,8 @@
|
|||
<li <%= sidebar_current("docs-agent-configuration-server") %>>
|
||||
<a href="/docs/agent/configuration/server.html">server</a>
|
||||
</li>
|
||||
<li <%= sidebar_current("docs-agent-configuration-server-join") %>>
|
||||
<a href="/docs/agent/configuration/server_join.html">server join</>
|
||||
<li <%= sidebar_current("docs-agent-configuration-server_join") %>>
|
||||
<a href="/docs/agent/configuration/server_join.html">server_join</>
|
||||
</li>
|
||||
<li <%= sidebar_current("docs-agent-configuration-telemetry") %>>
|
||||
<a href="/docs/agent/configuration/telemetry.html">telemetry</a>
|
||||
|
|
|
|||
Loading…
Reference in New Issue