tarantool / tarantool/doc

TCF: уточнить раздел по ролям и пользователям

Open
#5,461 0 comments 0 reactions 1 assignee View on GitHub

@maryiaLichko is already working on this.

Since Nov 18, 2025.

TCF
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: TCF
Root document: https://www.tarantool.io/en/clustersfederation/doc/latest/admin_guide/roles/#tarantool
SME: @ xuniq @ veod32

Details

  1. Хочется добавить в начале страницы два определения:

    • пользователь (есть дальше по тексту, но в начале страницы это определение нужно, чтобы объяснить термин роль)

    • роль (в контексте управления доступом)

      Сейчас в разделе по архитектуре упоминается, что технологические роли (модули) и роли пользователей - это не одно и то же

      Технологическая роль – это программный модуль, реализующий определенные функции или логику.
      Это не те роли, которые могут быть назначены пользователям.
      Для работы TCF используются две технологические роли в конфигурации кластера:

    А вот на странице по ролям и юзерам явного указания на это нет

  2. В разделе Служебные пользователи есть юзеры peer и storage, которые отвечают соответственно за репликацию внутри кластера (связь между инстансами) и работу шардинга. И на самом деле, как и юзера для репликации МЕЖДУ кластерами, этих 2 юзеров можно назвать как угодно, эти названия не зашиты где-то внутри тарантула. Нужно явно пометить это. Сейчас выглядит так, будто любое имя может быть только у юзера для репликации между кластерами (в примере это replication_user).

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

  3. Поменять формулировку про служебных пользователей:

    Служебные пользователи – это специальные учетные записи, предназначенные для выполнения системных задач. Подробнее см. таблицу ниже. Не назначаются человеку или внешним сервисам.

    Назначаться человеку/сервисам могут роли, а не учетные записи/пользователи. Можно что-то в этом роде (можно придумать формулировку точнее и лучше):

    Служебные пользователи не используются для человека или внешних сервисов.
    

    или

    Роли `replication` и `sharding`, которые используются служебными пользователями, **не назначаются человеку или внешнему сервису**.
    
  4. Подумать про TCM-юзера, в доке по TCF его сейчас нет

  5. На странице Служебные пользователи -> Пользователь storage тавтология в следующей формулировке:

    Этот пользователь используется для управления данными в распределенной системе и
    обеспечивает работу с данными, которые шардируются между различными узлами в кластере.

    в данном контексте "управление данными в распределенной системе" и "работа с данными, которые шардируются между различными узлами в кластере" - это одно и то же, синонимы, нужно оставить что-то одно

  6. В конфиге по ссылке приводятся только служебные юзеры, но в пояснении к конфигу откуда-то взялся dml-user и пропал replication_user
    https://www.tarantool.io/en/clustersfederation/doc/latest/admin_guide/service_users/#service-users-example-config:

Пользователи:

  • dml_users: DML-пользователь;
  • peer: пользователь для репликации внутри кластера;
  • storage: пользователь для работы с модулем шардирования.
  1. В примере конфига в разделе пользователи Tarantool приводятся тарантульные юзеры, но в пояснении к конфигу откуда-то появился служебный replication_user и пропал dml_user:
  • admin: администратор БД, предоставляет полный доступ ко всем функциям кластера;
  • replication_user: служебный пользователь репликации данных. На стороне Gateway требует прав на чтение (roles: [replication]), на стороне Destination — прав на выполнение кода и запись данных. Обычно назначаются права super (без прав на управление пользователями);

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.