Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add {cluster,database} administrator roles description #13907

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ permissions Modify permissions
All commands have an additional parameter, which is not critical for them:
`--timeout ms` - a technical parameter that sets the server response timeout.

## grant, revoke
## grant, revoke {#grant-revoke}

The `grant` and `revoke` commands allow you to establish and revoke, respectively, access rights to schema objects for a user or group of users. Essentially, they are analogues of the corresponding YQL [GRANT](../../../yql/reference/syntax/grant.md) and [REVOKE](../../../yql/reference/syntax/revoke.md) commands.

Expand All @@ -51,7 +51,7 @@ Additional parameters `[options...]`:
Each right must be passed as a separate parameter, for example:

```bash
{{ ydb-cli }} scheme permissions grant -p "ydb.access.grant" -p "ydb.generic.read" '/Root/db1/MyApp/Orders' testuser
{{ ydb-cli }} scheme permissions grant -p "ydb.access.grant" -p "ydb.generic.read" '/Root/db1/MyApp/Orders' testuser
```

## set
Expand Down Expand Up @@ -129,7 +129,7 @@ Parameters:
For example, if you execute the command over the database state from the previous example [`list`](#list):

```bash
{{ ydb-cli }} scheme permissions clear '/Root/db1/MyApp'
{{ ydb-cli }} scheme permissions clear '/Root/db1/MyApp'
```

And then execute the `list` command again on the object `/Root/db1/MyApp`, you will get the following result:
Expand Down
2 changes: 1 addition & 1 deletion ydb/docs/ru/core/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@

### Владелец {#access-owner}

**[Владелец](../security/authorization.md#owner)** - [субъект доступа](#access-subject) ([пользователь](#access-user) или [группа](#access-group)) имеющий полный объем прав на конкретный [объект доступа](#access-object).
**[Владелец](../security/authorization.md#owner)** - [субъект доступа](#access-subject) ([пользователь](#access-user) или [группа](#access-group)), являющийся владельцем конкретного [объект доступа](#access-object) и потому имеющий полный объем прав на него.

### Пользователь {#access-user}

Expand Down
5 changes: 3 additions & 2 deletions ydb/docs/ru/core/reference/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,10 +384,11 @@ default_access:
- +(ConnDB):USERS
```

Ошибки в строках прав доступа фиксируются в логе, но не влияют на запуск кластера. Право доступа с ошибкой не будет добавлено.

||
|#

Ошибки в строках прав доступа фиксируются в логе, но не влияют на запуск кластера. Право доступа с ошибкой не будет добавлено.

[//]: # (TODO: требуется доработка, сейчас ошибка в формате приводит к падению процесса)

Expand Down Expand Up @@ -430,7 +431,7 @@ default_access:

Все три пустых списка дают возможности администратора любому пользователю системы.

Для защищённого развёртывания {{ ydb-short-name }} важно заранее определить модель прав и прописать в списках соответствующие группы.
Для защищённого развёртывания {{ ydb-short-name }} важно заранее определить модель управления доступом и прописать в списках соответствующие группы.

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ permissions Modify permissions
Все команды имеют дополнительный параметр, который для них не критичен:
`--timeout ms` - технологический параметр, задающий таймаут на отклик сервера.

## grant, revoke
## grant, revoke {#grant-revoke}

Команды `grant` и `revoke` позволяют установить и отозвать, соответственно, права доступа к объектам схемы для пользователя или группы пользователей. По сути, это аналоги соответствующих YQL-команд [GRANT](../../../yql/reference/syntax/grant.md) и [REVOKE](../../../yql/reference/syntax/revoke.md).

Expand All @@ -51,7 +51,7 @@ permissions Modify permissions
Каждое право нужно передавать отдельным параметром, например:

```bash
{{ ydb-cli }} scheme permissions grant -p "ydb.access.grant" -p "ydb.generic.read" '/Root/db1/MyApp/Orders' testuser
{{ ydb-cli }} scheme permissions grant -p "ydb.access.grant" -p "ydb.generic.read" '/Root/db1/MyApp/Orders' testuser
```

## set
Expand Down Expand Up @@ -111,8 +111,8 @@ user1:ydb.generic.read

Структура результата состоит из трёх блоков:

- `Owner` — показывает владельца объекта схемы.
- `Permissions` — отображает список прав, выданных непосредственно на данный объект.
- `Owner` — показывает владельца объекта схемы.
- `Permissions` — отображает список прав, выданных непосредственно на данный объект.
- `Effective permissions` — отображает список прав, фактически действующих на данный схемный объект с учётом правил наследования прав. Данный список также включает все права, отображаемые в секции `Permissions`.

## clear
Expand All @@ -129,7 +129,7 @@ user1:ydb.generic.read
Например, если над состоянием базы данных из предыдущего примера [`list`](#list) выполнить команду:

```bash
{{ ydb-cli }} scheme permissions clear '/Root/db1/MyApp'
{{ ydb-cli }} scheme permissions clear '/Root/db1/MyApp'
```

И затем заново выполнить команду `list` на объект `/Root/db1/MyApp`, то получим следующий результат:
Expand Down
1 change: 1 addition & 0 deletions ydb/docs/ru/core/security/access-rights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [{#T}](../yql/reference/_includes/permissions_list.md) %}
Loading