diff options
| author | alexv-smirnov <[email protected]> | 2022-03-18 01:12:14 +0300 |
|---|---|---|
| committer | alexv-smirnov <[email protected]> | 2022-03-18 01:12:14 +0300 |
| commit | bff5ee4727d90f5e8bdce6cb848771c1c203136d (patch) | |
| tree | b1cb83df5faf427ca07bf236305a8386cf466e5d | |
| parent | 5b08edd14a8f5f26c14b6875021305b4d9095ef5 (diff) | |
ydb docs manage db/cluster top-level sections
ref:d53a647c2362eb972ae6f393c655faede901ff04
35 files changed, 152 insertions, 269 deletions
diff --git a/ydb/docs/ru/core/cluster/index.md b/ydb/docs/ru/core/cluster/index.md new file mode 100644 index 00000000000..0bcddd08492 --- /dev/null +++ b/ydb/docs/ru/core/cluster/index.md @@ -0,0 +1,9 @@ +# Управление кластером YDB + +В данном разделе находятся статьи для системных администраторов, отвечающих за работоспособность кластеров YDB, на которых разворачиваются прикладные базы данных. + +{% note warning "Предупреждение" %} + +Раздел находится в стадии разработки. + +{% endnote %}
\ No newline at end of file diff --git a/ydb/docs/ru/core/cluster/toc_i.yaml b/ydb/docs/ru/core/cluster/toc_i.yaml new file mode 100644 index 00000000000..6b73aa2043d --- /dev/null +++ b/ydb/docs/ru/core/cluster/toc_i.yaml @@ -0,0 +1,13 @@ +items: +- name: Kubernetes + include: { mode: link, path: ../deploy/orchestrated/toc_p.yaml } +- name: Вручную + items: + - include: { mode: link, path: ../deploy/manual/toc_p.yaml } + - include: { mode: link, path: ../deploy/configuration/toc_p.yaml } + - name: Production checklist + href: ../deploy/production_checklist.md + - name: Обслуживание дисковой подсистемы кластера + include: { mode: link, path: ../maintenance/manual/toc_p.yaml } +- name: Встроенный UI + include: { mode: link, path: ../maintenance/embedded_monitoring/toc_p.yaml } diff --git a/ydb/docs/ru/core/cluster/toc_p.yaml b/ydb/docs/ru/core/cluster/toc_p.yaml new file mode 100644 index 00000000000..3e62ad228bc --- /dev/null +++ b/ydb/docs/ru/core/cluster/toc_p.yaml @@ -0,0 +1,4 @@ +items: +- name: Обзор + href: index.md +- include: { mode: link, path: toc_i.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/db/_includes/cloud_remark.md b/ydb/docs/ru/core/db/_includes/cloud_remark.md new file mode 100644 index 00000000000..173c7ae74ed --- /dev/null +++ b/ydb/docs/ru/core/db/_includes/cloud_remark.md @@ -0,0 +1 @@ +Облачные сервисы YDB предоставляют инструменты самообслуживания, позволяющие создавать, изменять и удалять базы данных. Документация по этим функциям доступна в составе документации таких облачных сервисов. diff --git a/ydb/docs/ru/core/db/index.md b/ydb/docs/ru/core/db/index.md new file mode 100644 index 00000000000..ff61a653ce5 --- /dev/null +++ b/ydb/docs/ru/core/db/index.md @@ -0,0 +1,7 @@ +# Управление базами данных + +В данном разделе находятся статьи для разработчиков приложений, SRE, и администраторов приложений, описывающие инструменты YDB по управлению базами данных и их обслуживанию. + +{% include [cloud_remark.md](_includes/cloud_remark.md) %} + +В необлачных конфигурациях YDB операции создания, модификации и удаления баз данных выполняются администраторами кластеров, и описаны в разделе [Управление кластером](../cluster/index.md).
\ No newline at end of file diff --git a/ydb/docs/ru/core/db/toc_i.yaml b/ydb/docs/ru/core/db/toc_i.yaml new file mode 100644 index 00000000000..d5f4781a1e8 --- /dev/null +++ b/ydb/docs/ru/core/db/toc_i.yaml @@ -0,0 +1,9 @@ +items: +# - name: Облако Yandex.Cloud +# include: { mode: link, path: yandexcloud/toc_i.yaml } +# - name: Внутреннее облако Yandex-Team +# include: { mode: link, path: yandex-team/toc_i.yaml } +- name: Резервное копирование и восстановление + href: ../maintenance/backup_and_recovery.md +- name: Диагностика + include: { mode: link, path: ../troubleshooting/toc_p.yaml } diff --git a/ydb/docs/ru/core/db/toc_p.yaml b/ydb/docs/ru/core/db/toc_p.yaml new file mode 100644 index 00000000000..3e62ad228bc --- /dev/null +++ b/ydb/docs/ru/core/db/toc_p.yaml @@ -0,0 +1,4 @@ +items: +- name: Обзор + href: index.md +- include: { mode: link, path: toc_i.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/deploy/_includes/index.md b/ydb/docs/ru/core/deploy/_includes/index.md index cfe9268abda..0c182e9bddc 100644 --- a/ydb/docs/ru/core/deploy/_includes/index.md +++ b/ydb/docs/ru/core/deploy/_includes/index.md @@ -1,6 +1,10 @@ -# Администрирование кластеров YDB +# Развертывание баз данных и кластеров -В данном разделе представлена информация по развертыванию и конфигурации кластеров YDB для администраторов. Пошаговые сценарии быстрого развертывания для прикладных разработчиков приведены в разделе [Начало работы - Самостоятельное развертывание](../../getting_started/self_hosted/index.md). +В данном разделе представлена информация по развертыванию и конфигурации баз данных и кластеров YDB. + +Пошаговые сценарии быстрого самостоятельного развертывания локальных баз данных для прикладных разработчиков приведены в разделе [Начало работы - Самостоятельное развертывание](../../getting_started/self_hosted/index.md). + +Информация о развертывании и конфигурации кластеров презназначена для администраторов. {% note warning "Предупреждение" %} diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/index.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/index.md index 73084dd3513..b4c678623c9 100644 --- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/index.md +++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/index.md @@ -6,4 +6,4 @@ - [Запуск YDB из бинарного файла](../ydb_local.md) - [Запуск YDB в Minikube](../ydb_minikube.md) -Информация по развертыванию кластеров YDB для администраторов находится в разделе [Администрирование](../../../deploy/index.md). +Информация по развертыванию кластеров YDB для администраторов находится в разделе [Управление кластером](../../../cluster/index.md). diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/01_intro.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/01_intro.md deleted file mode 100644 index a87bcd2d2f8..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/01_intro.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Резервное копирование YDB" -description: "В разделе описаны поддерживаемые способы создания резервных копий баз данных YDB и восстановления из созданных ранее резервных копий. YDB позволяет использовать для создания резервных копий csv-файлы на файловой системе и AWS S3-совместимые хранилища." ---- - -# Резервное копирование - -В этом разделе описаны поддерживаемые способы создания резервных копий баз данных {{ ydb-short-name }} и восстановления из созданных ранее резервных копий. {{ ydb-short-name }} позволяет использовать следующие места назначения для создания резервных копий: -* csv-файлы на файловой системе; -* AWS S3-совместимые хранилища. - -{% note warning "Влияние резервного копирования на производительность" %} - -Операция резервного копирования может отрицательно сказываться на показателях взаимодействия с базой. Может вырасти время выполнения запросов. До того, как выполнять резервное копирование под нагрузкой на продакшн базах протестируйте, пожалуйста, процесс в тестовом контуре. - -{% endnote %}
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/02_prerequisites.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/02_prerequisites.md deleted file mode 100644 index 4efcf3a7b81..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/02_prerequisites.md +++ /dev/null @@ -1,6 +0,0 @@ -## Предварительные требования - -1. Установите [консольный клиент {{ ydb-short-name }}](../../../reference/ydb-cli/index.md). -1. Узнайте параметры для соединения с базой данных -- **Эндпоинт** и **База данных**. -1. Сохраните значения параметров **Эндпоинт** и **База данных** в переменных окружения `$YDB_ENDPOINT` и `$YDB_DB_PATH`. - diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/03_limitations.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/03_limitations.md deleted file mode 100644 index cf990c61391..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/03_limitations.md +++ /dev/null @@ -1,3 +0,0 @@ -## Ограничения {#limitations} - -В текущей реализации в {{ ydb-short-name }} допустимо создание резервной копии не более чем 1000 таблиц одновременно.
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_1_header.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_1_header.md deleted file mode 100644 index 788519f3463..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_1_header.md +++ /dev/null @@ -1,8 +0,0 @@ -## Резервное копирование на файловую систему {#filesystem_backup} - -Сохранение структуры директории `backup` в базе `$YDB_DB_PATH` в директорию `my_backup_of_basic_example` на файловой системе. -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH tools dump -p $YDB_DB_PATH/backup -o my_backup_of_basic_example/ -``` - -Для каждой директории в базе будет создана директория на файловой системе. Для каждой таблицы также будет создана директория на файловой системе, в которую будет помещён файл с описанием структуры. Данные таблиц будут сохранены в одном или нескольких файлах в формате `csv`, по одной строке в файле для строки таблицы. diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_2_body.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_2_body.md deleted file mode 100644 index b6fbb8d623a..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/04_fs_backup_2_body.md +++ /dev/null @@ -1,26 +0,0 @@ -### Пример листинга содержимого директории с резервной копией - -``` -tree my_backup_of_basic_example/ -my_backup_of_basic_example/ -├── episodes -│ ├── data_00.csv -│ └── scheme.pb -├── seasons -│ ├── data_00.csv -│ └── scheme.pb -└── series - ├── data_00.csv - └── scheme.pb - -3 directories, 6 files -``` - -Структура каждой таблицы сохранена в файле с именем `scheme.pb`, например в `episodes/scheme.pb` сохранена схема таблицы `episodes`. Данные каждой таблицы сохранены в одном или нескольких файлах с именами вида `data_хх.csv`, где хх – порядковый номер файла. Имя первого файла – `data_00.csv`. Ограничение на размер одного файла – 100 Мб. - -### Сохранение схемы таблиц - -Команда `{{ ydb-cli }} tools dump`, запущенная с опцией `--scheme-only`, сохранит только схемы таблиц. Команда, приведённая ниже, сохранит все директории и файлы со структурой таблиц из директории `examples` в базе `$YDB_DB_PATH` в папку `my_backup_of_basic_example`. Файлы с данными таблиц созданы не будут. -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH tools dump -p $YDB_DB_PATH/examples -o my_backup_of_basic_example/ --scheme-only -``` diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/05_fs_restore.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/05_fs_restore.md deleted file mode 100644 index e3859b074a5..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/05_fs_restore.md +++ /dev/null @@ -1,17 +0,0 @@ - -## Восстановление из резервной копии на файловой системе {#filesystem_restore} - -Команда, приведённая ниже, создаст директории и таблицы из резервной копии, сохранённой в директории `my_backup_of_basic_example` и загрузит в них данные. -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH tools restore -p $YDB_DB_PATH/backup/restored -i my_backup_of_basic_example/ -``` - -### Проверка резервной копии - -Команда `{{ ydb-cli }} tools restore`, запущенная с опцией `--dry-run`, позволяет проверить, что все таблицы в базе содержатся в резервной копии и что структуры таблиц одинаковы. - -Команда, приведённая ниже, проверит, что все таблицы, сохранённые в `my_backup_of_basic_example`, существуют в базе `$YDB_DB_PATH` и их структура (состав и порядок столбцов, типы данных столбцов, состав первичного ключа) одинаковы. - -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH tools restore -p $YDB_DB_PATH/restored_basic_example -i my_backup_of_basic_example/ --dry-run -``` diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_1_header.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_1_header.md deleted file mode 100644 index 77c5dcf3253..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_1_header.md +++ /dev/null @@ -1,4 +0,0 @@ -## Резервное копирование в S3-совместимые хранилища {#s3_backup} - -{{ ydb-short-name }} позволяет сохранять резервные копии баз данных в хранилища, поддерживающие [Amazon Simple Storage Service (AWS S3) API](https://docs.aws.amazon.com/AmazonS3/latest/dev/Introduction.html). - diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_2_prerequisites.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_2_prerequisites.md deleted file mode 100644 index ca14af807db..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_2_prerequisites.md +++ /dev/null @@ -1,4 +0,0 @@ -### Предварительные требования {#s3_prerequisites} - -Для сохранения резервной копии вам понадобится предварительно созданный S3-бакет. - diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_3_access_keys.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_3_access_keys.md deleted file mode 100644 index 10f02511ddf..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_3_access_keys.md +++ /dev/null @@ -1,9 +0,0 @@ -### Создание ключей доступа {#s3_create_access_keys} - -Для аутентификации и авторизации в S3-совместимых хранилищах используются ключи доступа. [Консольный клиент {{ ydb-short-name }}](../../../reference/ydb-cli/index.md) предоставляет три варианта передачи ключей: - -* через опции командной строки `--access-key` и `--secret-key`; -* через переменные окружения `AWS_ACCESS_KEY_ID` и `AWS_SECRET_ACCESS_KEY`; -* через файл `~/.aws/credentials`, создаваемый и используемый [AWS CLI]{% if lang == "en" %}(https://aws.amazon.com/cli/){% endif %}{% if lang == "ru" %}(https://aws.amazon.com/ru/cli/){% endif %}. - -Настройки применяются в порядке, описанном выше. Например, если одновременно использовать все три варианта передачи значения access_key или secret_key, то будут использованы значения, переданные через опции командной строки. diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_4_export.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_4_export.md deleted file mode 100644 index 11e56f879fc..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_4_export.md +++ /dev/null @@ -1,102 +0,0 @@ -### Запуск операции экспорта в S3 {#s3_export} - -Команды в примерах ниже составлены из расчёта, что данные ключей доступа сохранены в файл `~/.aws/credentials`. - -Запуск операции операции экспорта данных из таблиц `$YDB_DB_PATH/backup/episodes`, `$YDB_DB_PATH/backup/seasons`, `$YDB_DB_PATH/backup/series` в {{ ydb-short-name }} в базе `$YDB_DB_PATH` в файлы с префиксом `20200601/` в бакете `testdbbackups` в {{ objstorage-name }}. -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH export s3 --s3-endpoint {{ s3-storage-host }} --bucket testdbbackups\ ---item source=$YDB_DB_PATH/backup/episodes,destination=20200601/episodes\ ---item source=$YDB_DB_PATH/backup/seasons,destination=20200601/seasons\ ---item source=$YDB_DB_PATH/backup/series,destination=20200601/series -``` - -В результате выполнения команды консольный клиент выведет информацию о статусе запущенной операции. - -``` -┌───────────────────────────────────────────┬───────┬─────────┬───────────┬───────────────────┬───────────────┐ -| id | ready | status | progress | endpoint | bucket | -├───────────────────────────────────────────┼───────┼─────────┼───────────┼───────────────────┼───────────────┤ -| ydb://export/6?id=846776181822113&kind=s3 | false | SUCCESS | Preparing | s3.mds.yandex.net | testdbbackups | -├╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┤ -| Items: | -| - source_path: /some_path/episodes | -| destination_prefix: 20200601/episodes | -| - source_path: /some_path/seasons | -| destination_prefix: 20200601/seasons | -| - source_path: /some_path/series | -| destination_prefix: 20200601/series | -| Description: | -| Number of retries: 10 | -└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` - -После успешного завершения операции экспорта в бакете `testdbbackups` будут сохранены файлы в формате `csv` с данными и схемой таблиц c префиксами, перечисленными ниже. -``` -20200601/episodes -20200601/seasons -20200601/series -``` - -Формат идентичен формату файлов, создаваемых в результате [резервного копирования на файловую систему](#filesystem_backup). - -В результате выполнения с помощью AWS CLI приведённой ниже команды на экран будет выведен список префиксов, созданных в результате бекапа в бакете `testdbbackup`. - -``` -aws --endpoint-url=https://{{ s3-storage-host }} s3 ls testdbbackups/20200601/ - PRE episodes/ - PRE seasons/ - PRE series/ -``` - -{% note info "Работа с директориями" %} - -Чтобы сделать резервную копию всех таблиц в директории {{ ydb-short-name }}, следует указать путь до директории в качестве источника. - -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH export s3 \ ---s3-endpoint {{ s3-storage-host }} \ ---bucket testdbbackups \ ---item source=$YDB_DB_PATH/backup,destination=20200601/ -``` - -{% endnote %} - -вывести на экран текущее состояние запущенной ранее операции экспорта можно приведённой ниже командой. -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH operation get 'ydb://export/6?id=846776181822113&kind=s3' -┌───────────────────────────────────────────┬───────┬─────────┬───────────────┬───────────────────┬───────────────┐ -| id | ready | status | progress | endpoint | bucket | -├───────────────────────────────────────────┼───────┼─────────┼───────────────┼───────────────────┼───────────────┤ -| ydb://export/6?id=846776181822113&kind=s3 | false | SUCCESS | TransferData | s3.mds.yandex.net | testdbbackups | -├╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┤ -| Items: | -| - source_path: /some_path/episodes | -| destination_prefix: 20200601/episodes | -| - source_path: /some_path/seasons | -| destination_prefix: 20200601/seasons | -| - source_path: /some_path/series | -| destination_prefix: 20200601/series | -| description: | -| Number of retries: 10 | -└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` - -В случае успешного завершения операции экспорта в столбце progress будет отображено значение `Done`, в столбце status – `Success`, в столбце ready – `true`. -``` -┌───────────────────────────────────────────┬───────┬─────────┬──────────┬───────────────────┬───────────────┐ -| id | ready | status | progress | endpoint | bucket | -├───────────────────────────────────────────┼───────┼─────────┼──────────┼───────────────────┼───────────────┤ -| ydb://export/6?id=846776181822113&kind=s3 | true | SUCCESS | Done | s3.mds.yandex.net | testdbbackups | -├╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┴╴╴╴╴╴╴╴╴╴╴╴╴╴╴╴┤ -| Items: | -| - source_path: /some_path/episodes | -| destination_prefix: 20200601/episodes | -| - source_path: /some_path/seasons | -| destination_prefix: 20200601/seasons | -| - source_path: /some_path/series | -| destination_prefix: 20200601/series | -| description: | -| Number of retries: 10 | -└────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` - diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_5_restore.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_5_restore.md deleted file mode 100644 index bd8f54e996d..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_5_restore.md +++ /dev/null @@ -1,5 +0,0 @@ -### Восстановление из S3-совместимых хранилищ {#s3_restore} - -Предварительно нужно подключить бакет, содержащий файлы с резервной копией базы {{ ydb-short-name }} в s3-совместимом хранилище, чтобы она была доступна через операции с файловой системой. - -После успешного подключения следует загрузить данные из копии в {{ ydb-short-name }} по инструкции, описанной в разделе [Восстановление из резервной копии на файловой системе](#filesystem_restore).
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_6_forget.md b/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_6_forget.md deleted file mode 100644 index 34183298101..00000000000 --- a/ydb/docs/ru/core/maintenance/_includes/backup_and_recovery/06_s3_6_forget.md +++ /dev/null @@ -1,9 +0,0 @@ -### Завершение операции резервного копирования {#s3_forget} - -Для минимизации влияния процесса резервного копирования на показатели пользовательской нагрузки отправка данных осуществляется с копий таблиц. Перед отправкой данных из {{ ydb-short-name }} процесс резервного копирования создаёт консистентные копии всех отправляемых таблиц в {{ ydb-short-name }}. Так как это copy-on-write копии, то в момент их создания размер базы практически не меняется. После завершения отправки данных созданные копии остаются в базе. - -Чтобы удалить созданные копии таблиц из базы и завершённую операцию из списка операций, нужно выполнить команду - -``` -{{ ydb-cli }} -e $YDB_ENDPOINT -d $YDB_DB_PATH operation forget 'ydb://export/6?id=283824558378666&kind=s3' -```
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/_includes/index.md b/ydb/docs/ru/core/maintenance/_includes/index.md new file mode 100644 index 00000000000..70c281a6a7f --- /dev/null +++ b/ydb/docs/ru/core/maintenance/_includes/index.md @@ -0,0 +1,12 @@ +# Обслуживание YDB + +В данном разделе собраны статьи по обслуживанию баз данных и кластеров YDB. При использовании облачной базы данных актуальны только статьи по обслуживанию баз данных, так как обслуживание кластера под этими базами осуществляется командой облачного поставшика. + +## Обслуживание баз данных +- [Резервное копирование и восстановление](../backup_and_recovery.md) +- [Диагностика](../../troubleshooting/index.md) + +## Обслуживание кластера +- [Встроенный UI](../embedded_monitoring/overview.md) +- [Дисковая подсистема кластера](../manual/index.md) + diff --git a/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md b/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md new file mode 100644 index 00000000000..dba0826ce22 --- /dev/null +++ b/ydb/docs/ru/core/maintenance/embedded_monitoring/index.md @@ -0,0 +1,9 @@ +# Встроенный UI + +{{ ydb-short-name }} предоставляет инструменты для мониторинга и определения состояния системы: + +* [{{ ydb-short-name }} Monitoring](ydb_monitoring.md) - Основной обозреватель кластера. Показывает состояние узлов, групп хранения. +* [Interconnect overview](interconnect_overview.md) - состояние соединений узлов кластера друг с другом. +* [Логи](logs.md) - Каждый компонент {{ ydb-short-name }} пишет сообщения в логи разного уровня. По ним можно детектировать критические проблемы или разобраться в причинах неполадок. +* [Графики](charts.md) - {{ ydb-short-name }} собирает множество метрик, по которым можно определить состояние системы либо конкретного компонента. + diff --git a/ydb/docs/ru/core/maintenance/embedded_monitoring/overview.md b/ydb/docs/ru/core/maintenance/embedded_monitoring/overview.md index 4462617056c..179c1c1af87 100644 --- a/ydb/docs/ru/core/maintenance/embedded_monitoring/overview.md +++ b/ydb/docs/ru/core/maintenance/embedded_monitoring/overview.md @@ -1,9 +1 @@ -# Обзор средств интроспекции - -{{ ydb-short-name }} предоставляет инструменты для мониторинга и определения состояния системы: - -* [{{ ydb-short-name }} Monitoring](ydb_monitoring.md) - Основной обозреватель кластера. Показывает состояние узлов, групп хранения. -* [Interconnect overview](interconnect_overview.md) - состояние соединений узлов кластера друг с другом. -* [Логи](logs.md) - Каждый компонент {{ ydb-short-name }} пишет сообщения в логи разного уровня. По ним можно детектировать критические проблемы или разобраться в причинах неполадок. -* [Графики](charts.md) - {{ ydb-short-name }} собирает множество метрик, по которым можно определить состояние системы либо конкретного компонента. - +Страница перемещена в [новое место размещения](index.md), обновите ссылки.
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_i.yaml b/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_i.yaml new file mode 100644 index 00000000000..2bb60d05400 --- /dev/null +++ b/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_i.yaml @@ -0,0 +1,17 @@ +items: +- name: Обзор + href: overview.md + hidden: true +- name: Viewer + href: viewer.md + when: false +- name: YDB Monitoring + href: ydb_monitoring.md +- name: Hive web-viewer + href: hive.md +- name: Обзор соединений + href: interconnect_overview.md +- name: Логи + href: logs.md +- name: Графики + href: charts.md
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_p.yaml b/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_p.yaml new file mode 100644 index 00000000000..3e62ad228bc --- /dev/null +++ b/ydb/docs/ru/core/maintenance/embedded_monitoring/toc_p.yaml @@ -0,0 +1,4 @@ +items: +- name: Обзор + href: index.md +- include: { mode: link, path: toc_i.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/index.md b/ydb/docs/ru/core/maintenance/index.md new file mode 100644 index 00000000000..eb2590567da --- /dev/null +++ b/ydb/docs/ru/core/maintenance/index.md @@ -0,0 +1 @@ +{% include [_includes/index.md](_includes/index.md) %}
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/manual/toc_i.yaml b/ydb/docs/ru/core/maintenance/manual/toc_i.yaml new file mode 100644 index 00000000000..7a5186ecb35 --- /dev/null +++ b/ydb/docs/ru/core/maintenance/manual/toc_i.yaml @@ -0,0 +1,23 @@ +items: +- name: Способы предотвращения выхода за модель отказа + href: failure_model.md +- name: Балансировка нагрузки на диски + href: balancing_load.md +- name: Способы освобождения места на физических устройствах + href: disk_end_space.md +- name: Расширение кластера + href: cluster_expansion.md +- name: Добавление групп хранения + href: adding_storage_groups.md +- name: Безопасные рестарт и выключение узлов + href: node_restarting.md +- name: Включение/выключение SelfHeal + href: selfheal.md +- name: Включение/выключение Scrubbing + href: scrubbing.md +- name: Перевоз VDisk'ов + href: moving_vdisks.md +- name: Изменение конфигураций через CMS + href: cms.md +- name: Изменение конфигурации акторсистемы + href: change_actorsystem_configs.md
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/manual/toc_p.yaml b/ydb/docs/ru/core/maintenance/manual/toc_p.yaml new file mode 100644 index 00000000000..3e62ad228bc --- /dev/null +++ b/ydb/docs/ru/core/maintenance/manual/toc_p.yaml @@ -0,0 +1,4 @@ +items: +- name: Обзор + href: index.md +- include: { mode: link, path: toc_i.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/toc_i.yaml b/ydb/docs/ru/core/maintenance/toc_i.yaml index 43058252bb4..d8ea264495d 100644 --- a/ydb/docs/ru/core/maintenance/toc_i.yaml +++ b/ydb/docs/ru/core/maintenance/toc_i.yaml @@ -1,47 +1,11 @@ items: - - name: Резервное копирование - href: backup_and_recovery.md - - name: Средства интроспекции при самостоятельном развертывании - items: - - name: Обзор - href: embedded_monitoring/overview.md - - name: Viewer - href: embedded_monitoring/viewer.md - when: false - - name: YDB Monitoring - href: embedded_monitoring/ydb_monitoring.md - - name: Hive web-viewer - href: embedded_monitoring/hive.md - - name: Обзор соединений - href: embedded_monitoring/interconnect_overview.md - # when: false - - name: Логи - href: embedded_monitoring/logs.md - - name: Графики - href: embedded_monitoring/charts.md +- name: Резервное копирование + href: backup_and_recovery.md +- name: Диагностика + include: { mode: link, path: ../troubleshooting/toc_p.yaml } +- name: Обслуживание кластера + items: + - name: Встроенный UI + include: { mode: link, path: embedded_monitoring/toc_p.yaml } - name: Обслуживание дисковой подсистемы кластера - items: - - name: Обзор - href: manual/index.md - - name: Способы предотвращения выхода за модель отказа - href: manual/failure_model.md - - name: Балансировка нагрузки на диски - href: manual/balancing_load.md - - name: Способы освобождения места на физических устройствах - href: manual/disk_end_space.md - - name: Расширение кластера - href: manual/cluster_expansion.md - - name: Добавление групп хранения - href: manual/adding_storage_groups.md - - name: Безопасные рестарт и выключение узлов - href: manual/node_restarting.md - - name: Включение/выключение SelfHeal - href: manual/selfheal.md - - name: Включение/выключение Scrubbing - href: manual/scrubbing.md - - name: Перевоз VDisk'ов - href: manual/moving_vdisks.md - - name: Изменение конфигураций через CMS - href: manual/cms.md - - name: Изменение конфигурации акторсистемы - href: manual/change_actorsystem_configs.md + include: { mode: link, path: manual/toc_p.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/maintenance/toc_p.yaml b/ydb/docs/ru/core/maintenance/toc_p.yaml index 5bfec4365de..3e62ad228bc 100644 --- a/ydb/docs/ru/core/maintenance/toc_p.yaml +++ b/ydb/docs/ru/core/maintenance/toc_p.yaml @@ -1,2 +1,4 @@ items: +- name: Обзор + href: index.md - include: { mode: link, path: toc_i.yaml }
\ No newline at end of file diff --git a/ydb/docs/ru/core/toc_i.yaml b/ydb/docs/ru/core/toc_i.yaml index 9db01477bf1..10f1d72a489 100644 --- a/ydb/docs/ru/core/toc_i.yaml +++ b/ydb/docs/ru/core/toc_i.yaml @@ -11,9 +11,12 @@ items: - { name: Пошаговые инструкции, include: { mode: link, path: operations/toc_p.yaml } } - { name: Рекомендации, include: { mode: link, path: best_practices/toc_p.yaml } } -- { name: Обслуживание, include: { mode: link, path: maintenance/toc_p.yaml } } -- { name: Диагностика, include: { mode: link, path: troubleshooting/toc_p.yaml } } -- { name: Администрирование, include: { mode: link, path: deploy/toc_p.yaml } } +# - { name: Диагностика, include: { mode: link, path: troubleshooting/toc_p.yaml } } moved into maintenance! +# - { name: Развертывание, include: { mode: link, path: deploy/toc_p.yaml } } +# - { name: Обслуживание, include: { mode: link, path: maintenance/toc_p.yaml } } + +- { name: Управление базами данных, include: { mode: link, path: db/toc_p.yaml } } +- { name: Управление кластером, include: { mode: link, path: cluster/toc_p.yaml } } # References - { name: YQL, include: { mode: link, path: yql/toc_p.yaml } } diff --git a/ydb/docs/ru/core/troubleshooting/_includes/index.md b/ydb/docs/ru/core/troubleshooting/_includes/index.md new file mode 100644 index 00000000000..f84d99e080d --- /dev/null +++ b/ydb/docs/ru/core/troubleshooting/_includes/index.md @@ -0,0 +1,7 @@ +# Диагностика + +В данном разделе собраны статьи по инструментам диагностики баз данных YDB. + +- [Системные таблицы](../system_views.md) +- [Метрики](../monitoring.md) + diff --git a/ydb/docs/ru/core/troubleshooting/index.md b/ydb/docs/ru/core/troubleshooting/index.md new file mode 100644 index 00000000000..eb2590567da --- /dev/null +++ b/ydb/docs/ru/core/troubleshooting/index.md @@ -0,0 +1 @@ +{% include [_includes/index.md](_includes/index.md) %}
\ No newline at end of file diff --git a/ydb/docs/ru/core/troubleshooting/toc_p.yaml b/ydb/docs/ru/core/troubleshooting/toc_p.yaml index 5bfec4365de..3e62ad228bc 100644 --- a/ydb/docs/ru/core/troubleshooting/toc_p.yaml +++ b/ydb/docs/ru/core/troubleshooting/toc_p.yaml @@ -1,2 +1,4 @@ items: +- name: Обзор + href: index.md - include: { mode: link, path: toc_i.yaml }
\ No newline at end of file |
