Skip to content

ATE: describe ATE variables #5294

@xuniq

Description

@xuniq

Related dev. issue(s): https://jira.vk.team/browse/TNTP-3664 https://jira.vk.team/browse/TNTP-1059 https://jira.vk.team/browse/TNTP-1108
Product: ATE
Root document: https://www.tarantool.io/en/devops/latest/
SME: @ opomuc @ lastoCHka42

Details

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

  • В документации на сайте есть примеры инвентарей, но для них не хватает описания переменных. Какие-то из них указаны на странице "Использование Docker-образа", но не все. Было бы намного удобнее, если бы они были все в одном месте рядом с инвентарями

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

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    atereference[location] Tarantool manual, Reference part

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions