docs: add {cluster,database} administrator roles description #13907
+367
−29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
This comment was marked as outdated.
This comment was marked as outdated.
ijon
force-pushed
the
docs-admin-roles
branch
from
25dd5ac to
e90d872
Compare
This comment was marked as outdated.
This comment was marked as outdated.
ijon
force-pushed
the
docs-admin-roles
branch
from
e90d872 to
8af5977
Compare
github-actions
bot
added
documentation
✅ Documentation buildRevision built successfully |
ijon
force-pushed
the
docs-admin-roles
branch
from
8af5977 to
3ad9f40
Compare
✅ Documentation buildRevision built successfully |
github-actions
bot
added
documentation
ijon
force-pushed
the
docs-admin-roles
branch
from
3ad9f40 to
da552ad
Compare
✅ Documentation buildRevision built successfully |
azevaykin
reviewed
Jan 31, 2025
|
|
||
| {% note info %} | ||
|
|
||
| Рассматривается управление кластером группой администраторов. Оставить управление кластера единственному [пользователю](../concepts/glossary.md#access-user)-администратору (или суперпользователю) может быть ненадёжно и небезопасно. |
There was a problem hiding this comment.
Хочу выделить слово "группой", оно будет противопоставляться "пользователю".
Suggested change
| Рассматривается управление кластером группой администраторов. Оставить управление кластера единственному [пользователю](../concepts/glossary.md#access-user)-администратору (или суперпользователю) может быть ненадёжно и небезопасно. | |
| Рассматривается управление кластером [группой](../concepts/glossary.md#access-group) администраторов. Оставить управление кластера единственному [пользователю](../concepts/glossary.md#access-user) администратору (или суперпользователю) может быть ненадёжно и небезопасно. |
|
|
||
| Создание и настройка администраторов кластера по шагам: | ||
|
|
||
| 1. Создать суперпользователя, группу администраторов кластера и наделить их административными правами. |
There was a problem hiding this comment.
По примеру не совсем понятно, почему пользователи будут "наделены административными правами". Я бы продублировал, что они включены в "*_allowed_sids"
|
|
||
| После выполнения данной инструкции новые администраторы кластера способны выполнять любые административные операции с {{ ydb-short-name }}. | ||
|
|
||
| Суперпользователь `root` был нужен для выполнения данной инструкции и при дальнейшем администрировании кластера его можно больше не использовать. |
There was a problem hiding this comment.
И напрашивается одно предложение, что с ним лучше сделать: удалить/заблокировать/...
|
|
||
| {% endnote %} | ||
|
|
||
| ## Инструкция общая {#setup-general} |
There was a problem hiding this comment.
Две очень похожие инструкции, но никак не могу уловить по тексту, чем они отличаются.
Предлагаю до этого написать вводный текст с отличиями и предложить читателю пойти по одному из двух вариантов.
| @@ -0,0 +1,90 @@ | |||
| # Администратор базы данных | |||
|
|
|||
| Администратор базы данных (БД) -- это пользователь, обладающий административными возможностями в рамках некоторой базы данных: | |||
There was a problem hiding this comment.
Suggested change
| Администратор базы данных (БД) -- это пользователь, обладающий административными возможностями в рамках некоторой базы данных: | |
| Администратор базы данных (БД) -- это пользователь, обладающий административными возможностями в рамках некоторой базы данных. |
|
|
||
| ## Требуемая конфигурация {#database-admin-setup} | ||
|
|
||
| 1. На уровне базы существует группа администраторов базы данных. |
There was a problem hiding this comment.
Suggested change
| 1. На уровне базы существует группа администраторов базы данных. | |
| 1. На уровне базы данных существует группа администраторов базы данных. |
| ## Требуемая конфигурация {#database-admin-setup} | ||
|
|
||
| 1. На уровне базы существует группа администраторов базы данных. | ||
| 2. Группа администраторов базы данных является владельцем корня базы данных. |
There was a problem hiding this comment.
Suggested change
| 2. Группа администраторов базы данных является владельцем корня базы данных. | |
| 2. Группа администраторов базы данных является владельцем базы данных. |
|
|
||
| База данных определяется своим путём в схеме кластера, владелец этого пути (пользователь или группа) является владельцем базы. | ||
|
|
||
| ## Требуемая конфигурация {#database-admin-setup} |
There was a problem hiding this comment.
- Не сразу понял смысл слова "Требуемая".
Первое, что приходит в голову, это что нужно сделать какие-то подготовительные действия, выставить. "требуемые параметры".
Только дочитав до конца, понял, что это то, что мы получим в итоге выполнения инструкции, "образ результата". - Возможно, этот раздел стоит перенести в конец. То есть мы выполнили инструкцию и пришли к некому целевому состоянию.
P.S.
То же самое про Администраторов кластера.
|
|
||
| На настоящем кластере имена могут быть другими. | ||
|
|
||
| Создаёт и запускает базу данных [администратор кластера](./configure-cluster-admins.md), он же настраивает администраторов базы данных. |
There was a problem hiding this comment.
Предложение смущает. Я пытаюсь найти инструкцию, как все эти шаги сделать. А оказывается, они идут далее.
Suggested change
| Создаёт и запускает базу данных [администратор кластера](./configure-cluster-admins.md), он же настраивает администраторов базы данных. | |
| Для выполнения шагов инструкции требуются права [администратора кластера](./configure-cluster-admins.md). |
|
|
||
| TODO: Сослаться на запуск нод базы разными описанными в документации способами. | ||
|
|
||
| 3. Создать в базе группу администраторов базы |
There was a problem hiding this comment.
Ниже идет пример, как создать пользователей. А тут написано "создать группу".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add description for cluster and database administrator roles and instructions on how to setup those.
RU version only.
KIKIMR-21849
Stacked on:
Changelog category