Related dev. issue(s):

• https://jira.vk.team/browse/TNTP-3664
• https://jira.vk.team/browse/TNTP-1059
• jira-эпик по доке ATE: https://jira.vk.team/browse/TNTP-1108
• https://jira.vk.team/browse/TNTP-3866

Product: ATE
Root document: https://www.tarantool.io/en/devops/latest/
SME: @ opomuc @ lastoCHka42

Details

MR: https://gitlab.corp.mail.ru/tarantool/delivery/ansible-tarantool-enterprise/-/merge_requests/328

Собрала все упоминания этой задачи из разных Jira-тикетов (см. ниже). По итогам собранной инфы требуется описать использование переменных по аналогии с ansible-cartridge. Большая часть переменных ATE унаследована без особых изменений, но список переменных из ansible-cartridge нужно выверять и дополнять. В доке ATE на текущий момент:

• часть переменных указана на странице "Использование Docker-образа" (пример: https://www.tarantool.io/ru/devops/latest/docker-scenarios-products/)
• часть переменных добавлена в рамках недавних PR и болтается сейчас на верхнем уровне доки с непонятными уровнями заголовков:
  • https://www.tarantool.io/ru/devops/latest/variable-reference/
  • https://www.tarantool.io/ru/devops/latest/variable-reference/#tcf-destination
  • https://www.tarantool.io/ru/devops/latest/variable-reference/#ssl-etcd

Нужно всю это разрозненную информацию собрать и понятно организовать.

Навскидку по предложенному вижу 2 варианта решения:

1. сделать референс со всеми переменными на верхнем уровне (что-то по типу https://gitlab.corp.mail.ru/tarantool/delivery/ansible-tarantool-enterprise/-/blob/master/docs/source/variable-reference.md), из других мест дать ссылки на эту страницу
2. сделать такой референс рядом с примерами инвентарей (тут не уверена, как это красиво и понятно можно сделать)

Упоминания этой задачи из разных Jira-тикетов:

1. (https://jira.vk.team/browse/TNTP-3664) Продукт Ansible Tarantool Enterprise (ATE) унаследован от более не поддерживаемого продукта ansible-cartridge (ссылка на репозиторий). Продукт ansible-cartridge предоставлял клиентам описание используемых для работы переменных (ссылка на описание).
   ATE в большинстве случаев переиспользует эти же переменные, так как унаследовал большую часть кодовой базы от ansible-caridge. Также артефакт ATE содержит постепенно устаревающую документацию по ansible-cartridge внутри себя (ссылка).
   Вместе это создаёт ситуацию, когда новые заказчики не знают о части функционала ATE, так как её нет на сайте, а знакомые с ansible-cartridge заказчики могут допустить ошибку, так как находят устаревшую документацию внутри поставки ATE и применяют эту документацию к ATE.

2. (коммент из https://jira.vk.team/browse/TNTP-3664) Олег Страхов: В части документации необходимо следующее описание - предоставить пример развертывания динамического инвентаря с всевозможными опциями (эндпоинты мониторинга и хелсчеки, настройки шифрования экземпляров Тарантула, описание глобальных опций при развертывании Тарантула).

3. (https://jira.vk.team/browse/TNTP-1059) В документации на сайте есть примеры инвентарей, но для них не хватает описания переменных. Какие-то из них указаны на странице "Использование Docker-образа", но не все. Было бы намного удобнее, если бы они были все в одном месте рядом с инвентарями

4. (https://jira.vk.team/browse/TNTP-1968) на этой страничке хочется видеть инвентари с всеми возможными переменными и их описанием в виде комментариев в коде + если возможна вариативность можно внизу странички указать список обязательных, взаимоисключащих и опциональных переменных https://www.tarantool.io/ru/devops/latest/inventory-examples/

5. (https://jira.vk.team/browse/TNTP-3866) После задачи TNTP-2722 в документации АТЕ появилось описание некоторых переменных. Необходимо дополнить её и собрать все существующие в АТЕ переменные, чтобы улучшить пользовательский опыт и сделать написание инвентарей и использование плейбуков удобнее и понятнее. Задача: Сделать файл https://gitlab.corp.mail.ru/tarantool/delivery/ansible-tarantool-enterprise/-/blob/master/docs/source/variable-reference.md полным собранием всех переменных