Skip to content

Doc changes related to security features #17532

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

Conversation

anton-bobkov
Copy link
Collaborator

@anton-bobkov anton-bobkov commented Apr 22, 2025

Changelog category

  • Documentation

Description for reviewers

  • Deleted the concepts of root and tenant databases
  • Simplified the concept of a cluster scheme.
  • Deleted the concept of user tokens (this info is moved to the corresponding configuration section).
  • Updated the intro to the initial security configuration
    ...

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 22, 2025
@anton-bobkov anton-bobkov changed the title Deleted the root database and tenant database concepts Doc changes related to security features Apr 22, 2025
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 22, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 22, 2025
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 22, 2025
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@anton-bobkov anton-bobkov force-pushed the docs-feature-security-post-review-edits branch from 39fc521 to 3e11971 Compare April 22, 2025 21:16
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@anton-bobkov anton-bobkov marked this pull request as ready for review April 22, 2025 21:24
@anton-bobkov anton-bobkov requested a review from a team as a code owner April 22, 2025 21:24
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@anton-bobkov anton-bobkov merged commit a921899 into ydb-platform:docs-feature-security Apr 23, 2025
2 checks passed
@@ -4,7 +4,7 @@

## Схема кластера {{ ydb-short-name }} {#cluster-scheme}

Схема кластера {{ ydb-short-name }} — это иерархическое пространство имён кластера {{ ydb-short-name }}. Единственным корневым элементом этого пространства имён является **корень схемы кластера**. Дочерними элементами корня схемы кластера выступают [базы данных](../../concepts/glossary.md#database). В корне кластера также допустимо создавать различные [схемные объекты](../../concepts/glossary.md#scheme-object), эти объекты будут существовать на уровне кластера в целом и не принадлежат ни одной пользовательской БД. Внутри каждой базы данных можно создавать произвольную иерархию с помощью вложенных директорий.
Схема кластера {{ ydb-short-name }} — это иерархическое пространство имён кластера {{ ydb-short-name }}. Верхнеуровневым элементом этого пространства имён является **корень схемы кластера**. Дочерними элементами корня схемы кластера выступают [базы данных](../../concepts/glossary.md#database). Внутри каждой базы данных можно создавать произвольную иерархию с помощью вложенных директорий.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Внутри каждой базы данных можно создавать произвольную иерархию объектов (таблиц, топиков и т.п.) с помощью вложенных директорий."

### Схема кластера {#scheme}

**Схема кластера {{ ydb-short-name }}** — это иерархическое пространство имён кластера {{ ydb-short-name }}. Единственным корневым элементом этого пространства имён является [корень схемы кластера](#scheme-root). Корнем схемы кластера может выступать [директория](#folder) или [корневая база данных](#root-database). Дочерними элементами корня схемы кластера выступают [базы данных](#database) или другие [схемные объекты](#scheme-object), которые образуют произвольную иерархию с помощью вложенных директорий.
**Схема кластера {{ ydb-short-name }}** — это иерархическое пространство имён кластера {{ ydb-short-name }}. Верхнеуровневым элементом этого пространства имён является [корень схемы кластера](#scheme-root). Дочерними элементами корня схемы кластера выступают [базы данных](#database). Внутри каждой базы данных можно создавать произвольную иерархию с помощью вложенных директорий.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

аналогично

@@ -2,39 +2,35 @@

{{ ydb-short-name }} позволяет использовать различные способы аутентификации пользователей в системе. Настройки аутентификации и провайдеров аутентификации задаются в секции `auth_config` файла конфигурации {{ ydb-short-name }}.

## Конфигурация аутентификации внутренних пользователей {{ ydb-short-name }} {#internal-auth-config}
## Конфигурация аутентификации локальных пользователей {{ ydb-short-name }} {#local-auth-config}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я считаю, что мы должны термины "локальный пользователь" и "внешний пользователь" описать в Глоссарии

@@ -1,10 +1,17 @@
# Встроенная настройка безопасности
# Начальная настройка безопасности
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Начальная настройка безопасности кластера

Права доступа и уровни доступа могут быть выданы конкретному пользователю, или группе. Пользователь, которого включили в группу, наделяется правами, выданными ранее этой группе, на время нахождения в этой группе.
Подробнее о правах доступа см. в разделе [{#T}](./authorization.md#right).

- **Уровни доступа**. С помощью **уровней доступа** в {{ ydb-short-name }} определяется доступ к дополнительным возможностям по управлению кластером - мониторинг состояния, запуск и остановка узлов, изменение настроек и т.п. - для конкретного пользователей или группы.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Напишу здесь комментарий.
Я бы хотел видеть более подробное описание термина "Уровень доступа" в глоссарии.

Сейчас это:

Уровень доступа предоставляет [субъекту доступа](https://ydb-platform--ydb.viewer.diplodoc.com/ru/ru/concepts/glossary#access-subject) дополнительные возможности при работе с [объектами схемы](https://ydb-platform--ydb.viewer.diplodoc.com/ru/ru/concepts/glossary#scheme-object), а также возможность выполнения операций над кластером в целом. YDB использует три уровня доступа:

наблюдатель;
оператор;
администратор.
Уровень доступа для субъекта настраивается с помощью [списков уровня доступа](https://ydb-platform--ydb.viewer.diplodoc.com/ru/ru/concepts/glossary#access-level-list).

Я бы прямо приводил примеры, чтобы было не сухо, а понятно

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants