From d93eb3659c201be8342de149930921405590acfc Mon Sep 17 00:00:00 2001 From: James Phillips Date: Fri, 19 Jan 2018 16:30:21 -0800 Subject: [PATCH] Updates configuration docs for Azure VMSS support. --- website/source/docs/agent/options.html.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/website/source/docs/agent/options.html.md b/website/source/docs/agent/options.html.md index d60455ab13..8bc6c5d9dd 100644 --- a/website/source/docs/agent/options.html.md +++ b/website/source/docs/agent/options.html.md @@ -318,8 +318,8 @@ will exit with an error at startup. ### Microsoft Azure This returns the first private IP address of all servers in the given region - which have the given `tag_key` and `tag_value` in the tenant and - subscription. + which have the given `tag_key` and `tag_value` in the tenant and subscription, or in + the given `resource_group` of a `vm_scale_set` for Virtual Machine Scale Sets. ```sh $ consul agent -retry-join "provider=azure tag_name=... tag_value=... tenant_id=... client_id=... subscription_id=... secret_access_key=..." @@ -332,12 +332,21 @@ will exit with an error at startup. ``` - `provider` (required) - the name of the provider ("azure" in this case). - - `tag_name` (required) - the name of the tag to auto-join on. - - `tag_value` (required) - the value of the tag to auto-join on. - `tenant_id` (required) - the tenant to join machines in. - `client_id` (required) - the client to authenticate with. - `secret_access_key` (required) - the secret client key. + Use these configuration parameters when using tags: + - `tag_name` - the name of the tag to auto-join on. + - `tag_value` - the value of the tag to auto-join on. + + Use these configuration parameters when using Virtual Machine Scale Sets (Consul 1.0.3 and later): + - `resource_group` - the name of the resource group to filter on. + - `vm_scale_set` - the name of the virtual machine scale set to filter on. + + When using tags the only permission needed is the `ListAll` method for `NetworkInterfaces`. When using + Virtual Machine Scale Sets the only role action needed is `Microsoft.Compute/virtualMachineScaleSets/*/read`. + ### Google Compute Engine This returns the first private IP address of all servers in the given