Browse Source

Docs: resource broker config (#8694)

Ilnaz Nizametdinov 6 months ago
parent
commit
b949049214

+ 5 - 1
ydb/docs/ru/core/concepts/_includes/secondary_indexes.md

@@ -42,7 +42,11 @@
 * Может наблюдаться увеличение задержек из-за того, что транзакции становятся распределенными (при создании синхронного индекса).
 * Возможен повышенный фон ошибок `OVERLOADED` из-за того, что во время записи данных активно работает автоматическое разделение шардов индексной таблицы.
 
-Скорость записи данных выбрана таким образом, чтобы минимизировать влияние процесса записи на пользовательские транзакции. Для быстрого завершения операции рекомендуется запускать онлайн-создание вторичного индекса во время минимальной пользовательской нагрузки.
+{% note info %}
+
+Скорость записи данных выбрана таким образом, чтобы минимизировать влияние процесса записи на пользовательские транзакции. Для управления скоростью настройте лимиты для соответствующей очереди [брокера ресурсов](../../deploy/configuration/config.md#resource-broker-config).
+
+{% endnote %}
 
 Создание индекса — асинхронная операция. Если после запуска операции произойдет разрыв клиент-серверной связности, то построение индекса будет продолжено. Управлять асинхронной операцией можно через {{ ydb-short-name }} CLI.
 

+ 33 - 0
ydb/docs/ru/core/deploy/configuration/config.md

@@ -666,6 +666,39 @@ node_broker_config:
   stable_node_name_prefix: <новый префикс>
 ```
 
+## resource_broker_config — брокер ресурсов {#resource-broker-config}
+
+Брокер ресурсов — это [акторный сервис](../../concepts/glossary.md#actor-service), контролирующий потребление ресурсов [узла](../../concepts/glossary.md#node) {{ ydb-short-name }}, таких как:
+
+- `CPU` — количество потоков;
+- `Memory` — оперативная память.
+
+Разные виды активностей (фоновые операции, удаление данных по [TTL](../../concepts/ttl.md) и т.д.) запускаются в разных *очередях* брокера ресурсов. Каждая такая очередь имеет лимитированное число ресурсов:
+
+Название очереди | CPU | Memory | Описание
+--- | --- | --- | ---
+`queue_ttl` | 2 | — | Операции удаления данных по [TTL](../../concepts/ttl.md).
+`queue_backup` | 2 | — | Операции [резервного копирования](../../devops/manual/backup-and-recovery.md#s3).
+`queue_restore` | 2 | — | Операции [восстановления из резервной копии](../../devops/manual/backup-and-recovery.md#s3).
+`queue_build_index` | 10 | — | Операции [онлайн-создания вторичного индекса](../../concepts/secondary_indexes.md#index-add).
+`queue_cdc_initial_scan` | 4 | — | [Первоначальное сканирование таблицы](../../concepts/cdc.md#initial-scan).
+
+{% note info %}
+
+Рекомендуется **дополнять** конфигурацию брокера ресурсов, используя [теги](../../maintenance/manual/dynamic-config-selectors.md#dopolnitelnye-tegi-v-yaml) `!inherit` и `!append`.
+
+{% endnote %}
+
+Пример дополнения конфигурации брокера ресурсов пользовательским лимитом для очереди `queue_ttl`:
+
+```yaml
+resource_broker_config: !inherit
+  queues: !append
+  - name: queue_ttl
+    limit:
+      cpu: 4
+```
+
 ## Примеры конфигураций кластеров {#examples}
 
 В [репозитории](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/yaml_config_examples/)  можно найти модельные примеры конфигураций кластеров для самостоятельного развертывания. Ознакомьтесь с ними перед развертыванием кластера.

+ 6 - 0
ydb/docs/ru/core/devops/manual/backup-and-recovery.md

@@ -20,6 +20,12 @@
 
 Для выполнения восстановления из резервной копии, созданной в S3-совместимом хранилище, применяется команда `{{ ydb-cli }} import s3`. Перейдите [по ссылке](../../reference/ydb-cli/export-import/import-s3.md) в справочник по {{ ydb-short-name }} CLI для получения информации о данной команде.
 
+{% note info %}
+
+Скорость операций резервного копирования и восстановления в/из S3-совместимого хранилища подобрана таким образом, чтобы минимизировать влияние на пользовательскую нагрузку. Для управления скоростью операций настройте лимиты для соответствующей очереди [брокера ресурсов](../../deploy/configuration/config.md#resource-broker-config).
+
+{% endnote %}
+
 {% include [_includes/backup_and_recovery/cli_overlay.md](_includes/backup_and_recovery/cli_overlay.md) %}
 
 {% include [_includes/backup_and_recovery/others_overlay.md](_includes/backup_and_recovery/others_overlay.md) %}