From eb206d6e59a5a9ccd4f9e5c33014b37e91fb7d68 Mon Sep 17 00:00:00 2001 From: Leonard Lyubich Date: Fri, 14 Oct 2022 14:08:50 +0400 Subject: [PATCH] [#1883] config/example: Actualize desc of shard modes Signed-off-by: Leonard Lyubich --- config/example/node.yaml | 7 ++++++- docs/storage-node-configuration.md | 15 ++++++++------- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/config/example/node.yaml b/config/example/node.yaml index 36b77af79..6a316e835 100644 --- a/config/example/node.yaml +++ b/config/example/node.yaml @@ -147,7 +147,12 @@ storage: remover_sleep_interval: 5m # frequency of the garbage collector invocation 0: - mode: "read-only" # mode of the shard, must be one of the: "read-write" (default), "read-only" + mode: read-only # mode of the shard, must be one of the: + # read-write (default) + # read-only + # degraded + # degraded-read-only + # disabled (do not work with the shard, allows to not remove it from the config) resync_metabase: false # sync metabase with blobstor on start, expensive, leave false until complete understanding writecache: diff --git a/docs/storage-node-configuration.md b/docs/storage-node-configuration.md index 51785e981..5ac959515 100644 --- a/docs/storage-node-configuration.md +++ b/docs/storage-node-configuration.md @@ -169,13 +169,14 @@ Contains configuration for each shard. Keys must be consecutive numbers starting `default` subsection has the same format and specifies defaults for missing values. The following table describes configuration for each shard. -| Parameter | Type | Default value | Description | -|-------------------|---------------------------------------------|---------------|------------------------------------------| -| `resync_metabase` | `bool` | `false` | Flag to enable metabase resync on start. | -| `writecache` | [Writecache config](#writecache-subsection) | | Write-cache configuration. | -| `metabase` | [Metabase config](#metabase-subsection) | | Metabase configuration. | -| `blobstor` | [Blobstor config](#blobstor-subsection) | | Blobstor configuration. | -| `gc` | [GC config](#gc-subsection) | | GC configuration. | +| Parameter | Type | Default value | Description | +|-------------------|---------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------| +| `mode` | `string` | `read-write` | Shard Mode.
Possible values: `read-write`, `read-only`, `degraded`, `degraded-read-only`, `disabled` | +| `resync_metabase` | `bool` | `false` | Flag to enable metabase resync on start. | +| `writecache` | [Writecache config](#writecache-subsection) | | Write-cache configuration. | +| `metabase` | [Metabase config](#metabase-subsection) | | Metabase configuration. | +| `blobstor` | [Blobstor config](#blobstor-subsection) | | Blobstor configuration. | +| `gc` | [GC config](#gc-subsection) | | GC configuration. | ### `blobstor` subsection