docs: Pre-format example for named_stores_config (#14524)

pull/14525/head
Paul Rogers 1 year ago committed by GitHub
parent 963a25bf41
commit 71d1c6bcd4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 28
      docs/sources/shared/configuration.md
  2. 14
      tools/doc-generator/parse/root_blocks.go

@ -4064,12 +4064,14 @@ When a memberlist config with atleast 1 join_members is defined, kvstore of type
Configures additional object stores for a given storage provider.
Supported stores: aws, azure, bos, filesystem, gcs, swift.
Example:
storage_config:
named_stores:
aws:
store-1:
endpoint: s3://foo-bucket
region: us-west1
```yaml
storage_config:
named_stores:
aws:
store-1:
endpoint: s3://foo-bucket
region: us-west1
```
Named store from this example can be used by setting object_store to store-1 in period_config.
```yaml
@ -5555,12 +5557,14 @@ hedging:
# Configures additional object stores for a given storage provider.
# Supported stores: aws, azure, bos, filesystem, gcs, swift.
# Example:
# storage_config:
# named_stores:
# aws:
# store-1:
# endpoint: s3://foo-bucket
# region: us-west1
# ```yaml
# storage_config:
# named_stores:
# aws:
# store-1:
# endpoint: s3://foo-bucket
# region: us-west1
# ```
# Named store from this example can be used by setting object_store to store-1
# in period_config.
[named_stores: <named_stores_config>]

@ -280,12 +280,14 @@ When a memberlist config with atleast 1 join_members is defined, kvstore of type
Desc: `Configures additional object stores for a given storage provider.
Supported stores: aws, azure, bos, filesystem, gcs, swift.
Example:
storage_config:
named_stores:
aws:
store-1:
endpoint: s3://foo-bucket
region: us-west1
` + "```yaml" + `
storage_config:
named_stores:
aws:
store-1:
endpoint: s3://foo-bucket
region: us-west1
` + "```" + `
Named store from this example can be used by setting object_store to store-1 in period_config.`,
},
{

Loading…
Cancel
Save