From ca6e8662324afb33577b1266ef185e7acdf5d51f Mon Sep 17 00:00:00 2001 From: steven jacobs Date: Thu, 27 Feb 2020 06:51:21 -0500 Subject: [PATCH] docs:add documentation for Linode cloud auto-join (#6719) The go-discover library supports Linode. This adds support for discovering other Consul agents running on Linode. Consul has supported this since [66b8c20][1] was merged, so this commit just updates the documentation to match current features. [1]: https://github.com/hashicorp/consul/commit/66b8c209904d0b377f3c561c5b21b393bdeb1235 --- .../source/docs/agent/cloud-auto-join.html.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/website/source/docs/agent/cloud-auto-join.html.md b/website/source/docs/agent/cloud-auto-join.html.md index f417791ce7..997b9e5238 100644 --- a/website/source/docs/agent/cloud-auto-join.html.md +++ b/website/source/docs/agent/cloud-auto-join.html.md @@ -369,6 +369,29 @@ $ consul agent -retry-join "provider=packet auth_token=token project=uuid url=.. - `url` (optional) - a REST URL for packet - `address_type` (optional) - the type of address to check for in this provider ("private_v4", "public_v4" or "public_v6". Defaults to "private_v4") +### Linode + +This returns the first private IP address of all servers for the given `region` with the given `tag_name`. + +```sh +$ consul agent -retry-join "provider=linode region=us-east tag_name=consul-server" +``` + +```json +{ + "retry-join": ["provider=linode region=us-east tag_name=consul-server"] +} +``` + +- `provider` (required) is `linode` +- `api_token` (required) - The Linode API token to use +- `region` (optional) - The Linode region to filter on +- `tag_name` (optional) - The tag name to filter on +- `address_type` (optional) - the type of address to check for in this provider ("private_v4", "public_v4" or "public_v6". Defaults to "private_v4") + +Variables can also be provided by environment variables: + +- `LINODE_TOKEN` for `api_token` ### Kubernetes (k8s)