TCF (Admin Guide): clarify the `role` term
Open
@maryiaLichko is already working on this.
Since Nov 5, 2025.
TCF
terminology
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: TCF
Root documents:
- https://www.tarantool.io/ru/clustersfederation/doc/latest/admin_guide/role_models/
- https://docs.d.tarantool.io/ru/clustersfederation/doc/doc-4746-logs/admin_guide/logging_tarantool_roles/#admin-guide-log-tarantool-roles
- https://www.tarantool.io/ru/clustersfederation/doc/latest/references/configuration_reference_cluster_yaml_3-0/
- https://www.tarantool.io/ru/clustersfederation/doc/latest/user_guide/architecture/
- https://www.tarantool.io/ru/clustersfederation/doc/latest/admin_guide/switch_active_cluster/
(Страниц может быть больше, нужно поправить везде, проверить локальным поиском использование терминов)
SME: @ veod32 @ DifferentialOrange @ oleg-jukovec @ Андрей Капустин (PM)
Details
В доке Tarantool, в т.ч. в доке TCF, есть несколько сущностей, которые называют ролями:
- В разделе про ролевую модель выделяют
- "человеческие" роли (admin, dml-user)
- служебные роли (storage и т.д.)
- В разделе про логи (не только там, есть еще вхождения в других разделах) есть роли tcf-worker, tcf-coordinator, там они названы с подачи разрабов как роли Тарантул (что с технической точки зрения правильно, но пользователя путает)
Такое количество одинаково названных сущностей путает читателя. Нужно определить термин для каждой из этих сущностей, объяснить его и исправить вхождения в доке TCF.
Роли coordinator, worker, варианты названий:
- технологические роли - вариант для ролей-модулей из TDB;
- роли Tarantool - вариант от разработчиков;
- application role (роли приложения?) - вариант из англоязычной документации платформы. В доке платформы у нас тоже подчеркивается, что это всё разные роли:
Note
Don’t confuse application roles with other role types:
- A role is a container for privileges that can be granted to users. Learn more in Roles.
- A role of a replica set in regard to sharding. Learn more in Sharding roles.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.