ale64bit/frostfs-node
1
0
Fork 0
forked from TrueCloudLab/frostfs-node
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#1994] docs: Update storage node configuration

Browse source 
Reflect the reality after a not so recent refactoring.

Signed-off-by: Evgenii Stratonikov <evgeniy@morphbits.ru>
This commit is contained in:
Evgenii Stratonikov 2022-10-28 13:22:32 +03:00 committed by fyrchik
parent f564430b90
commit 148da5fdbb
1 changed files with 42 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
docs/storage-node-configuration.md
View file

@ -169,52 +169,60 @@ Contains configuration for each shard. Keys must be consecutive numbers starting
`default` subsection has the same format and specifies defaults for missing values. `default` subsection has the same format and specifies defaults for missing values.
The following table describes configuration for each shard. The following table describes configuration for each shard.
| Parameter | Type | Default value | Description | | Parameter | Type | Default value | Description |
|-------------------|---------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------| |-------------------------------------|---------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `mode` | `string` | `read-write` | Shard Mode.<br/>Possible values: `read-write`, `read-only`, `degraded`, `degraded-read-only`, `disabled` | | `compress` | `bool` | `false` | Flag to enable compression. |
| `resync_metabase` | `bool` | `false` | Flag to enable metabase resync on start. | | `compression_exclude_content_types` | `[]string` | | List of content-types to disable compression for. Content-type is taken from `Content-Type` object attribute. Each element can contain a star `*` as a first (last) character, which matches any prefix (suffix). |
| `writecache` | [Writecache config](#writecache-subsection) | | Write-cache configuration. | | `mode` | `string` | `read-write` | Shard Mode.<br/>Possible values: `read-write`, `read-only`, `degraded`, `degraded-read-only`, `disabled` |
| `metabase` | [Metabase config](#metabase-subsection) | | Metabase configuration. | | `resync_metabase` | `bool` | `false` | Flag to enable metabase resync on start. |
| `blobstor` | [Blobstor config](#blobstor-subsection) | | Blobstor configuration. | | `writecache` | [Writecache config](#writecache-subsection) | | Write-cache configuration. |
| `gc` | [GC config](#gc-subsection) | | GC configuration. | | `metabase` | [Metabase config](#metabase-subsection) | | Metabase configuration. |
| `blobstor` | [Blobstor config](#blobstor-subsection) | | Blobstor configuration. |
| `small_object_size` | `size` | `1M` | Maximum size of an object stored in blobovnicza tree. |
| `gc` | [GC config](#gc-subsection) | | GC configuration. |
### `blobstor` subsection ### `blobstor` subsection
Contains a list of substorages each with it's own type.
Currently only 2 types are supported: `fstree` and `blobovnicza`.
```yaml ```yaml
blobstor: blobstor:
path: /path/to/blobstor - type: blobovnicza
perm: 0644 path: /path/to/blobstor
compress: true depth: 1
compression_exclude_content_types: width: 4
- audio/* - type: fstree
- video/* path: /path/to/blobstor/blobovnicza
depth: 5 perm: 0644
small_object_size: 102400 size: 4194304
blobovnicza: depth: 1
size: 4194304 width: 4
depth: 1 opened_cache_capacity: 50
width: 4
opened_cache_capacity: 50
``` ```
#### Common options for sub-storages
| Parameter | Type | Default value | Description | | Parameter | Type | Default value | Description |
|-------------------------------------|-----------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------------------------|-----------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `path` | `string` | | Path to the root of the blobstor. | | `path` | `string` | | Path to the root of the blobstor. |
| `perm` | file mode | `0660` | Default permission for created files and directories. | | `perm` | file mode | `0660` | Default permission for created files and directories. |
| `compress` | `bool` | `false` | Flag to enable compression. |
| `compression_exclude_content_types` | `[]string` | | List of content-types to disable compression for. Content-type is taken from `Content-Type` object attribute. Each element can contain a star `*` as a first (last) character, which matches any prefix (suffix). |
| `depth` | `int` | `4` | Depth of the file-system tree for large objects. Must be in range 1..31. |
| `small_object_size` | `size` | `1M` | Maximum size of an object stored in blobovnicza tree. |
| `blobovnicza` | [Blobovnicza config](#blobovnicza-subsection) | | Blobovnicza tree configuration. |
#### `blobovnicza` subsection #### `fstree` type options
| Parameter | Type | Default value | Description |
|---------------------|-----------|---------------|-------------------------------------------------------|
| `path` | `string` | | Path to the root of the blobstor. |
| `perm` | file mode | `0660` | Default permission for created files and directories. |
| `depth` | `int` | `4` | File-system tree depth. |
| Parameter | Type | Default value | Description | #### `blobovnicza` type options
|-------------------------|----------|---------------|-------------------------------------------------------| | Parameter | Type | Default value | Description |
| `path` | `string` | | Path to the root of the blobovnicza tree. | |-------------------------|-----------|---------------|-------------------------------------------------------|
| `size` | `size` | `1 G` | Maximum size of a single blobovnicza | | `path` | `string` | | Path to the root of the blobstor. |
| `depth` | `int` | `2` | Blobovnicza tree depth. | | `perm` | file mode | `0660` | Default permission for created files and directories. |
| `width` | `int` | `16` | Blobovnicza tree width. | | `size` | `size` | `1 G` | Maximum size of a single blobovnicza |
| `opened_cache_capacity` | `int` | `16` | Maximum number of simultaneously opened blobovniczas. | | `depth` | `int` | `2` | Blobovnicza tree depth. |
| `width` | `int` | `16` | Blobovnicza tree width. |
| `opened_cache_capacity` | `int` | `16` | Maximum number of simultaneously opened blobovniczas. |
### `gc` subsection ### `gc` subsection