aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralexv-smirnov <alex@ydb.tech>2022-10-04 14:15:01 +0300
committeralexv-smirnov <alex@ydb.tech>2022-10-04 14:15:01 +0300
commitcd0a32136bce815fff11b9787ab5b058c2cce7d6 (patch)
treef84e0f4e6b21a2a1a131adb105a9bb25b55961bf
parentab745cf85e2bf127cfe1d2cfc4933a310f691f5f (diff)
downloadydb-cd0a32136bce815fff11b9787ab5b058c2cce7d6.tar.gz
config cluster auth
-rw-r--r--ydb/docs/en/core/deploy/configuration/config.md31
-rw-r--r--ydb/docs/ru/core/deploy/configuration/config.md32
2 files changed, 55 insertions, 8 deletions
diff --git a/ydb/docs/en/core/deploy/configuration/config.md b/ydb/docs/en/core/deploy/configuration/config.md
index 74fffbe172b..df0b76c1d87 100644
--- a/ydb/docs/en/core/deploy/configuration/config.md
+++ b/ydb/docs/en/core/deploy/configuration/config.md
@@ -211,7 +211,7 @@ Odd numbers must be used for `nto_select` because using even numbers does not im
The [authentication mode](../../concepts/auth.md) in the {{ ydb-short-name }} cluster is created in the `domains_config.security_config` section.
-Syntax:
+**Syntax**
``` yaml
domains_config:
@@ -221,9 +221,9 @@ domains_config:
...
```
- Key | Description
+Key | Description
--- | ---
- `enforce_user_token_requirement` | Require a user token.</br>Acceptable values:</br><ul><li>`false`: Anonymous authentication mode, no token needed.</li><li>`true`: Username/password authentication mode. A valid user token is needed for authentication.</li></ul>
+ `enforce_user_token_requirement` | Require a user token.</br>Acceptable values:</br><ul><li>`false`: Anonymous authentication mode, no token needed (default value, applied when the parameter is not specified).</li><li>`true`: Username/password authentication mode. A valid user token is needed for authentication.</li></ul>
### Examples {#domains-examples}
@@ -251,6 +251,29 @@ domains_config:
nto_select: 5
ssid: 1
+- Block-4-2 + Auth
+
+ ``` yaml
+ domains_config:
+ domain:
+ - name: Root
+ storage_pool_types:
+ - kind: ssd
+ pool_config:
+ box_id: 1
+ erasure_species: block-4-2
+ kind: ssd
+ pdisk_filter:
+ - property:
+ - type: SSD
+ vdisk_kind: Default
+ state_storage:
+ - ring:
+ node: [1, 2, 3, 4, 5, 6, 7, 8]
+ nto_select: 5
+ ssid: 1
+ security_config:
+ enforce_user_token_requirement: true
- Mirror-3-dc
@@ -275,7 +298,7 @@ domains_config:
ssid: 1
```
-- None
+- No fault tolerance
``` yaml
domains_config:
diff --git a/ydb/docs/ru/core/deploy/configuration/config.md b/ydb/docs/ru/core/deploy/configuration/config.md
index 87059c0ff95..5d5a217bedb 100644
--- a/ydb/docs/ru/core/deploy/configuration/config.md
+++ b/ydb/docs/ru/core/deploy/configuration/config.md
@@ -194,7 +194,7 @@ State Storage (хранилище состояний) -- это независи
При развертывании State Storage на кластерах, в которых прменяется несколько пулов хранения с возможным сочетанием режимов отказоустойчивости, рассмотрите возможность увеличения количества узлов с распространением их на разные пулы хранения, так как недоступность State Storage приводит к недоступности всего кластера.
-**Syntax**
+**Синтаксис**
``` yaml
state_storage:
- ring:
@@ -211,7 +211,7 @@ state_storage:
[Режим аутентификации](../../concepts/auth.md) на кластере {{ ydb-short-name }} задается в разделе `domains_config.security_config`.
-Синтаксис:
+**Синтаксис**
``` yaml
domains_config:
@@ -223,7 +223,7 @@ domains_config:
Ключ | Описание
--- | ---
-`enforce_user_token_requirement` | Требовать токен пользователя.</br>Допустимые значения:</br><ul><li>`false` — режим аутентификации анонимный, токен не требуется;</li><li>`true` — режим аутентификации по логину и паролю, для выполнения запроса требуется валидный токен пользователя.</li></ul>
+`enforce_user_token_requirement` | Требовать токен пользователя.</br>Допустимые значения:</br><ul><li>`false` — режим аутентификации анонимный, токен не требуется (применяется по умолчанию, если параметр не задан);</li><li>`true` — режим аутентификации по логину и паролю, для выполнения запроса требуется валидный токен пользователя.</li></ul>
### Примеры {#domains-examples}
@@ -251,6 +251,30 @@ domains_config:
nto_select: 5
ssid: 1
+- Block-4-2 + Auth
+
+ ``` yaml
+ domains_config:
+ domain:
+ - name: Root
+ storage_pool_types:
+ - kind: ssd
+ pool_config:
+ box_id: 1
+ erasure_species: block-4-2
+ kind: ssd
+ pdisk_filter:
+ - property:
+ - type: SSD
+ vdisk_kind: Default
+ state_storage:
+ - ring:
+ node: [1, 2, 3, 4, 5, 6, 7, 8]
+ nto_select: 5
+ ssid: 1
+ security_config:
+ enforce_user_token_requirement: true
+
- Mirror-3-dc
``` yaml
@@ -274,7 +298,7 @@ domains_config:
ssid: 1
```
-- None
+- Без отказоустойчивости
``` yaml
domains_config: