Skip to content

Commit f28f97f

Browse files
yeya24yeya24
committed
fix doc again
Signed-off-by: Ben Ye <[email protected]>
1 parent 46c8c1b commit f28f97f

File tree

3 files changed

+62
-12
lines changed

3 files changed

+62
-12
lines changed

‎docs/blocks-storage/querier.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,13 @@ blocks_storage:
339339
# CLI flag: -blocks-storage.azure.account-key
340340
[account_key: <string> | default = ""]
341341
342+
# The values of `account-name` and `endpoint-suffix` values will not be
343+
# ignored if `connection-string` is set. Use this method over `account-key`
344+
# if you need to authenticate via a SAS token or if you use the Azurite
345+
# emulator.
346+
# CLI flag: -blocks-storage.azure.connection-string
347+
[connection_string: <string> | default = ""]
348+
342349
# Azure storage container name
343350
# CLI flag: -blocks-storage.azure.container-name
344351
[container_name: <string> | default = ""]
@@ -352,12 +359,14 @@ blocks_storage:
352359
# CLI flag: -blocks-storage.azure.max-retries
353360
[max_retries: <int> | default = 20]
354361

355-
# Azure storage MSI resource. Either this or account key must be set.
362+
# Deprecated: Azure storage MSI resource. It will be set automatically by
363+
# Azure SDK.
356364
# CLI flag: -blocks-storage.azure.msi-resource
357365
[msi_resource: <string> | default = ""]
358366

359367
# Azure storage MSI resource managed identity client Id. If not supplied
360-
# system assigned identity is used
368+
# default Azure credential will be used. Set it to empty if you need to
369+
# authenticate via Azure Workload Identity.
361370
# CLI flag: -blocks-storage.azure.user-assigned-id
362371
[user_assigned_id: <string> | default = ""]
363372

‎docs/blocks-storage/store-gateway.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,13 @@ blocks_storage:
459459
# CLI flag: -blocks-storage.azure.account-key
460460
[account_key: <string> | default = ""]
461461
462+
# The values of `account-name` and `endpoint-suffix` values will not be
463+
# ignored if `connection-string` is set. Use this method over `account-key`
464+
# if you need to authenticate via a SAS token or if you use the Azurite
465+
# emulator.
466+
# CLI flag: -blocks-storage.azure.connection-string
467+
[connection_string: <string> | default = ""]
468+
462469
# Azure storage container name
463470
# CLI flag: -blocks-storage.azure.container-name
464471
[container_name: <string> | default = ""]
@@ -472,12 +479,14 @@ blocks_storage:
472479
# CLI flag: -blocks-storage.azure.max-retries
473480
[max_retries: <int> | default = 20]
474481

475-
# Azure storage MSI resource. Either this or account key must be set.
482+
# Deprecated: Azure storage MSI resource. It will be set automatically by
483+
# Azure SDK.
476484
# CLI flag: -blocks-storage.azure.msi-resource
477485
[msi_resource: <string> | default = ""]
478486

479487
# Azure storage MSI resource managed identity client Id. If not supplied
480-
# system assigned identity is used
488+
# default Azure credential will be used. Set it to empty if you need to
489+
# authenticate via Azure Workload Identity.
481490
# CLI flag: -blocks-storage.azure.user-assigned-id
482491
[user_assigned_id: <string> | default = ""]
483492

‎docs/configuration/config-file-reference.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -621,6 +621,12 @@ azure:
621621
# CLI flag: -alertmanager-storage.azure.account-key
622622
[account_key: <string> | default = ""]
623623
624+
# The values of `account-name` and `endpoint-suffix` values will not be
625+
# ignored if `connection-string` is set. Use this method over `account-key` if
626+
# you need to authenticate via a SAS token or if you use the Azurite emulator.
627+
# CLI flag: -alertmanager-storage.azure.connection-string
628+
[connection_string: <string> | default = ""]
629+
624630
# Azure storage container name
625631
# CLI flag: -alertmanager-storage.azure.container-name
626632
[container_name: <string> | default = ""]
@@ -634,12 +640,14 @@ azure:
634640
# CLI flag: -alertmanager-storage.azure.max-retries
635641
[max_retries: <int> | default = 20]
636642

637-
# Azure storage MSI resource. Either this or account key must be set.
643+
# Deprecated: Azure storage MSI resource. It will be set automatically by
644+
# Azure SDK.
638645
# CLI flag: -alertmanager-storage.azure.msi-resource
639646
[msi_resource: <string> | default = ""]
640647

641648
# Azure storage MSI resource managed identity client Id. If not supplied
642-
# system assigned identity is used
649+
# default Azure credential will be used. Set it to empty if you need to
650+
# authenticate via Azure Workload Identity.
643651
# CLI flag: -alertmanager-storage.azure.user-assigned-id
644652
[user_assigned_id: <string> | default = ""]
645653

@@ -886,6 +894,12 @@ azure:
886894
# CLI flag: -blocks-storage.azure.account-key
887895
[account_key: <string> | default = ""]
888896
897+
# The values of `account-name` and `endpoint-suffix` values will not be
898+
# ignored if `connection-string` is set. Use this method over `account-key` if
899+
# you need to authenticate via a SAS token or if you use the Azurite emulator.
900+
# CLI flag: -blocks-storage.azure.connection-string
901+
[connection_string: <string> | default = ""]
902+
889903
# Azure storage container name
890904
# CLI flag: -blocks-storage.azure.container-name
891905
[container_name: <string> | default = ""]
@@ -899,12 +913,14 @@ azure:
899913
# CLI flag: -blocks-storage.azure.max-retries
900914
[max_retries: <int> | default = 20]
901915

902-
# Azure storage MSI resource. Either this or account key must be set.
916+
# Deprecated: Azure storage MSI resource. It will be set automatically by
917+
# Azure SDK.
903918
# CLI flag: -blocks-storage.azure.msi-resource
904919
[msi_resource: <string> | default = ""]
905920

906921
# Azure storage MSI resource managed identity client Id. If not supplied
907-
# system assigned identity is used
922+
# default Azure credential will be used. Set it to empty if you need to
923+
# authenticate via Azure Workload Identity.
908924
# CLI flag: -blocks-storage.azure.user-assigned-id
909925
[user_assigned_id: <string> | default = ""]
910926

@@ -4142,6 +4158,12 @@ azure:
41424158
# CLI flag: -ruler-storage.azure.account-key
41434159
[account_key: <string> | default = ""]
41444160
4161+
# The values of `account-name` and `endpoint-suffix` values will not be
4162+
# ignored if `connection-string` is set. Use this method over `account-key` if
4163+
# you need to authenticate via a SAS token or if you use the Azurite emulator.
4164+
# CLI flag: -ruler-storage.azure.connection-string
4165+
[connection_string: <string> | default = ""]
4166+
41454167
# Azure storage container name
41464168
# CLI flag: -ruler-storage.azure.container-name
41474169
[container_name: <string> | default = ""]
@@ -4155,12 +4177,14 @@ azure:
41554177
# CLI flag: -ruler-storage.azure.max-retries
41564178
[max_retries: <int> | default = 20]
41574179

4158-
# Azure storage MSI resource. Either this or account key must be set.
4180+
# Deprecated: Azure storage MSI resource. It will be set automatically by
4181+
# Azure SDK.
41594182
# CLI flag: -ruler-storage.azure.msi-resource
41604183
[msi_resource: <string> | default = ""]
41614184

41624185
# Azure storage MSI resource managed identity client Id. If not supplied
4163-
# system assigned identity is used
4186+
# default Azure credential will be used. Set it to empty if you need to
4187+
# authenticate via Azure Workload Identity.
41644188
# CLI flag: -ruler-storage.azure.user-assigned-id
41654189
[user_assigned_id: <string> | default = ""]
41664190

@@ -4415,6 +4439,12 @@ azure:
44154439
# CLI flag: -runtime-config.azure.account-key
44164440
[account_key: <string> | default = ""]
44174441
4442+
# The values of `account-name` and `endpoint-suffix` values will not be
4443+
# ignored if `connection-string` is set. Use this method over `account-key` if
4444+
# you need to authenticate via a SAS token or if you use the Azurite emulator.
4445+
# CLI flag: -runtime-config.azure.connection-string
4446+
[connection_string: <string> | default = ""]
4447+
44184448
# Azure storage container name
44194449
# CLI flag: -runtime-config.azure.container-name
44204450
[container_name: <string> | default = ""]
@@ -4428,12 +4458,14 @@ azure:
44284458
# CLI flag: -runtime-config.azure.max-retries
44294459
[max_retries: <int> | default = 20]
44304460

4431-
# Azure storage MSI resource. Either this or account key must be set.
4461+
# Deprecated: Azure storage MSI resource. It will be set automatically by
4462+
# Azure SDK.
44324463
# CLI flag: -runtime-config.azure.msi-resource
44334464
[msi_resource: <string> | default = ""]
44344465

44354466
# Azure storage MSI resource managed identity client Id. If not supplied
4436-
# system assigned identity is used
4467+
# default Azure credential will be used. Set it to empty if you need to
4468+
# authenticate via Azure Workload Identity.
44374469
# CLI flag: -runtime-config.azure.user-assigned-id
44384470
[user_assigned_id: <string> | default = ""]
44394471

0 commit comments

Comments
 (0)