Description
Product: TCF
Root documents:
- https://www.tarantool.io/ru/clustersfederation/doc/latest/user_guide/
- https://www.tarantool.io/ru/clustersfederation/doc/latest/admin_guide/
SME: @ DifferentialOrange @ Руслан Галиев
Details
Необходимо привести структуру документации в порядок: разграничить информацию, предназначенную для конечного пользователя (User Guide), и информацию, требующую административного уровня доступа и знаний (Admin Guide).
-
Создать разводящую страницу для пользователей TCF (Admin Guide): Сценарии использования и роли пользователей TCF #4964
-
Добавить вводный текст + типы поддерживаемых кластеров в раздел Общая информация
Вводный текст: Tarantool Clusters Federation (TCF) позволяет построить отказоустойчивую систему из двух кластеров Tarantool. В такой системе один из кластеров является активным и принимает все запросы от приложения. Второй кластер является пассивным и содержит копию данных активного кластера.
TCF позволяет управлять переключением трафика между активным и пассивным кластерами. Например, размещение кластеров в разных центрах обработки данных позволяет минимизировать негативные последствия при техногенных или природных инцидентах. Также переключение трафика на другой кластер позволяет проводить технические работы и изменения логики работы приложения без простоя.Типы поддерживаемых кластеров:
TCF поддерживает следующие типы кластеров Tarantool и продуктов на его основе:- кластер Tarantool 2.x на основе Cartridge;
- кластер Tarantool 3.x Enterprise Edition (EE);
- кластер Tarantool Data Grid на основе Tarantool 2.x;
- кластер Tarantool DB 1.x на основе Tarantool 2.x;
- кластер Tarantool DB 2.x на основе Tarantool 3.x;
- кластер Tarantool Column Store на основе Tarantool 3.x. (спрятать раздел)
-
Убрать информациию из вводного текста в разделе Общая информация о поддержке кластера Tarantool Column Store на основе Tarantool 3.x и спрятать раздел Использование TCF c кластерами Tarantool Column Store https://www.tarantool.io/ru/clustersfederation/doc/latest/user_guide/column_store_tcf_example/
-
Вынести раздел Архитектура отдельно из юзер гайда
-
Обновить дерево в разделе Руководство по установке:
- Установка через Ansible Tarantool Enterprise
- Установка TCF вручную поверх кластеров Tarantool DB
- Миграция кластеров Tarantool Cartridge на Tarantool 3.x с помощью TCF
-
Обновить дерево раздела Руководство по эксплуатации:
- [Настройка стенда TDB+TCF] (в разводящем тексте нужно указать, какой стенд будет развернут после прохождения примера)
- Настройка хранилища конфигурации и состояния TCF
- Настройка и запуск кластеров
- Настройка расширений WAL (подумать куда положить этот раздел: настройка и запуск кластеров?)
- Работа TCF с кластерами, запущенными в режиме синхронной репликации (подумать куда положить этот раздел: настройка и запуск кластеров?)
- Настройка межкластерных репликаторов (нужно добавить раздел с проверкой репликации)
- Использование TCF для объединения кластеров Tarantool Cartridge и Tarantool 3.x
- Использование TCF c кластерами Tarantool Column Store
- Использование HTTP API для управления репликаторами данных
- [Настройка стенда TDB+TCF] (в разводящем тексте нужно указать, какой стенд будет развернут после прохождения примера)
-
Обновить дерево раздела Руководство по администрированию:
- Роли и пользователи
- Мониторинг
- Устранение неполадок
- Управление (переключение) TCF в веб-интерфейсе TCM (устранение неполадок)
- Смена состояния кластеров (устранение неполадок)
- Журналирование
-
Переименовать раздел Управление TCF в веб-интерфейсе TCM в Переключение TCF в веб-интерфейсе TCM
-
Перенести разделы Переключение TCF в веб-интерфейсе TCM и Смена состояния кластеров в раздел Устранение неполадок
-
Возможно соединить разделы Переключение TCF в веб-интерфейсе TCM и Смена состояния кластеров
-
Повесить редиректы, если это потребуется
Подробнее в: https://confluence.vk.team/pages/viewpage.action?pageId=1598371174