From d9f0a731caf4fe1d1ac7d3c794bbacf338927eea Mon Sep 17 00:00:00 2001 From: SuyashHashiCorp <92308220+SuyashHashiCorp@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:45:41 +0530 Subject: [PATCH 1/5] Update agent.mdx Starting from Consul v1.20.1+ent, Consul supports using Azure Blob Storage for the snapshot agent via Azure Service Principal ID and Secret authentication. I've successfully tested this configuration in my lab environment and have added the relevant parameters to this documentation for completeness. --- website/content/commands/snapshot/agent.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index e86c62809e48..7998391df884 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -396,9 +396,15 @@ These options cannot be used when using `backup_destinations` in a config file. - `-azure-blob-container-name` - Container to use. Required for Azure blob storage, and setting this disables local storage. -* `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments +- `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments are AZURECHINACLOUD, AZUREGERMANCLOUD and AZUREUSGOVERNMENTCLOUD. Introduced in Consul 1.7.3. +~> These below options `azure-blob-service-principal-id`, `azure-blob-service-principal-secret`, and `azure-blob-tenant-id` are introduced in v1.20.1+ent. + +- `-azure-blob-service-principal-id` and `-azure-blob-service-principal-secret` - Use these parameters to authenticate using Service Principal (SPN) ID + Secret together. + +- `-azure-blob-tenant-id` - Required when using Service Principal ID and Secret. + #### Google Cloud Storage options ~> This option is deprecated when used with a top-level `google_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> google_storage[0]` in a config file instead. From ea6cc6306eed6c10d6a9d16910ea0c062277f022 Mon Sep 17 00:00:00 2001 From: SuyashHashiCorp <92308220+SuyashHashiCorp@users.noreply.github.com> Date: Tue, 14 Jan 2025 17:47:44 +0530 Subject: [PATCH 2/5] Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias --- website/content/commands/snapshot/agent.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 7998391df884..31caa670c78b 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -399,7 +399,7 @@ These options cannot be used when using `backup_destinations` in a config file. - `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments are AZURECHINACLOUD, AZUREGERMANCLOUD and AZUREUSGOVERNMENTCLOUD. Introduced in Consul 1.7.3. -~> These below options `azure-blob-service-principal-id`, `azure-blob-service-principal-secret`, and `azure-blob-tenant-id` are introduced in v1.20.1+ent. +~> The following options were introduced in v1.20.1+ent. - `-azure-blob-service-principal-id` and `-azure-blob-service-principal-secret` - Use these parameters to authenticate using Service Principal (SPN) ID + Secret together. From 87e770687afdbaa220ba9806eadd2b59c879e1a7 Mon Sep 17 00:00:00 2001 From: SuyashHashiCorp <92308220+SuyashHashiCorp@users.noreply.github.com> Date: Tue, 14 Jan 2025 17:48:40 +0530 Subject: [PATCH 3/5] Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias --- website/content/commands/snapshot/agent.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 31caa670c78b..2d4996b9cd29 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -401,7 +401,8 @@ These options cannot be used when using `backup_destinations` in a config file. ~> The following options were introduced in v1.20.1+ent. -- `-azure-blob-service-principal-id` and `-azure-blob-service-principal-secret` - Use these parameters to authenticate using Service Principal (SPN) ID + Secret together. +- `-azure-blob-service-principal-id` - +- `-azure-blob-service-principal-secret` - - `-azure-blob-tenant-id` - Required when using Service Principal ID and Secret. From 7f9006a297cc9c57d1aff3c1e98e284355efc136 Mon Sep 17 00:00:00 2001 From: SuyashHashiCorp <92308220+SuyashHashiCorp@users.noreply.github.com> Date: Tue, 14 Jan 2025 17:48:48 +0530 Subject: [PATCH 4/5] Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias --- website/content/commands/snapshot/agent.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 2d4996b9cd29..878071231a46 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -404,7 +404,7 @@ These options cannot be used when using `backup_destinations` in a config file. - `-azure-blob-service-principal-id` - - `-azure-blob-service-principal-secret` - -- `-azure-blob-tenant-id` - Required when using Service Principal ID and Secret. +- `-azure-blob-tenant-id` - The ID of the tenant that owns the Azure blob. #### Google Cloud Storage options From 2f409252a117955171df03570e9079c0148842c3 Mon Sep 17 00:00:00 2001 From: SuyashHashiCorp <92308220+SuyashHashiCorp@users.noreply.github.com> Date: Wed, 15 Jan 2025 09:36:08 +0530 Subject: [PATCH 5/5] Update website/content/commands/snapshot/agent.mdx Co-authored-by: Blake Covarrubias --- website/content/commands/snapshot/agent.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 878071231a46..607eb8556da3 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -401,8 +401,8 @@ These options cannot be used when using `backup_destinations` in a config file. ~> The following options were introduced in v1.20.1+ent. -- `-azure-blob-service-principal-id` - -- `-azure-blob-service-principal-secret` - +- `-azure-blob-service-principal-id` - The ID of the service principal that owns the blob object. +- `-azure-blob-service-principal-secret` - The secret of the service principal that owns the blob object. - `-azure-blob-tenant-id` - The ID of the tenant that owns the Azure blob.