Update snapshot/agent.mdx #21942
Update snapshot/agent.mdx #21942
Conversation
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.
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
1 similar comment
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
github-actions
bot
added
the
type/docs
| 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. |
There was a problem hiding this comment.
| ~> 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. |
| 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. |
There was a problem hiding this comment.
| - `-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` - |
These parameters should be listed and documented separately.
|
|
||
| - `-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. |
There was a problem hiding this comment.
| - `-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. |
It should be reworded to something similar that clearly describes the value that is required by this field.
There was a problem hiding this comment.
Plus one to Blake's comment
There was a problem hiding this comment.
Also: was -azure-blob-tenant-id introduced in v1.20.1+ent? It's a new attribute listing like the other two, but the break in the list makes it unclear whether it's meant to be included with the other two
| 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. |
There was a problem hiding this comment.
| ~> 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. |
In addition to Blake's suggestion, the callout should be dropped. Especially because the callout with a list inside it is likely to throw rendering errors
| 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-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. |
There was a problem hiding this comment.
Plus one to Blake's comment
|
|
||
| - `-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. |
There was a problem hiding this comment.
Also: was -azure-blob-tenant-id introduced in v1.20.1+ent? It's a new attribute listing like the other two, but the break in the list makes it unclear whether it's meant to be included with the other two
boruszak
added
pr/no-changelog
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.
Description
Testing & Reproduction steps
Links
PR Checklist