Skip to content

Commit 5e2a231

Browse files
blinkovblinkov
committed
introduce security/
1 parent 5b7fe60 commit 5e2a231

27 files changed

+89
-24
lines changed

‎ydb/docs/en/core/changelog-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Release date: October 12, 2023.
2323
* A new option `PostgreSQL` has been added to the query type selector settings, which is available when the `Enable additional query modes` parameter is enabled. Also, the query history now takes into account the syntax used when executing the query.
2424
* The YQL query template for creating a table has been updated. Added a description of the available parameters.
2525
* Now sorting and filtering for Storage and Nodes tables takes place on the server. To use this functionality, you need to enable the parameter `Offload tables filters and sorting to backend` in the experiments section.
26-
* Buttons for creating, changing and deleting [topics](https://ydb.tech/ru/docs/concepts/topic) have been added to the context menu.
26+
* Buttons for creating, changing and deleting [topics](concepts/topic.md) have been added to the context menu.
2727
* Added sorting by criticality for all issues in the tree in `Healthcheck`.
2828

2929
**Performance:**
@@ -155,7 +155,7 @@ Release date: May 5, 2023. To update to version 23.1, select the [Downloads](dow
155155

156156
* Added [initial table scan](concepts/cdc.md#initial-scan) when creating a CDC changefeed. Now, you can export all the data existing at the time of changefeed creation.
157157
* Added [atomic index replacement](dba/secondary-indexes.md#atomic-index-replacement). Now, you can atomically replace one pre-defined index with another. This operation is absolutely transparent for your application. Indexes are replaced seamlessly, with no downtime.
158-
* Added the [audit log](cluster/audit-log.md): Event stream including data about all the operations on {{ ydb-short-name }} objects.
158+
* Added the [audit log](security/audit-log.md): Event stream including data about all the operations on {{ ydb-short-name }} objects.
159159

160160
**Performance:**
161161

‎ydb/docs/en/core/cluster/toc_i.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ items:
22
- name: Deployment
33
include: { mode: link, path: ../deploy/toc_p.yaml }
44
- name: Access management
5-
href: access.md
5+
href: ../security/access-management.md
66
- name: Managing a cluster's disk subsystem
77
include: { mode: link, path: ../maintenance/manual/toc_p.yaml }
88
- name: Embedded UI
99
include: { mode: link, path: ../reference/embedded-ui/toc_p.yaml }
1010
- name: Cluster system views
1111
href: ../devops/manual/system-views.md
1212
- name: Audit log
13-
href: audit-log.md
13+
href: ../security/audit-log.md
1414
- name: Short access control notation
15-
href: short-access-control-notation.md
15+
href: ../security/short-access-control-notation.md
1616
- name: Monitoring
1717
items:
1818
- name: Setting up monitoring for a local YDB cluster

‎ydb/docs/en/core/concepts/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Authentication by username and password includes the following steps:
5454

5555
To enable username/password authentication, use `true` in the `enforce_user_token_requirement` key of the cluster's [configuration file](../deploy/configuration/config.md#auth).
5656

57-
To learn how to manage roles and users, see [{#T}](../cluster/access.md).
57+
To learn how to manage roles and users, see [{#T}](../security/access-management.md).
5858

5959
<!-- ### API получения токенов IAM {#token-refresh-api}
6060

‎ydb/docs/en/core/dba/toc_p.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
items:
22
- name: Overview
33
href: index.md
4-
- include: { mode: link, path: toc_i.yaml }
4+
- include:
5+
mode: link
6+
path: toc_i.yaml

‎ydb/docs/en/core/deploy/manual/deploy-ydb-on-premises.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ Run additional dynamic nodes on other servers to ensure database scalability and
403403

404404
If authentication mode is enabled in the cluster configuration file, initial account setup must be done before working with the {{ ydb-short-name }} cluster.
405405

406-
The initial installation of the {{ ydb-short-name }} cluster automatically creates a `root` account with a blank password, as well as a standard set of user groups described in the [Access management](../../cluster/access.md) section.
406+
The initial installation of the {{ ydb-short-name }} cluster automatically creates a `root` account with a blank password, as well as a standard set of user groups described in the [Access management](../../security/access-management.md) section.
407407

408408
To perform initial account setup in the created {{ ydb-short-name }} cluster, run the following operations:
409409

‎ydb/docs/en/core/cluster/access.md renamed to ‎ydb/docs/en/core/security/access-management.md

File renamed without changes.

‎ydb/docs/en/core/cluster/audit-log.md renamed to ‎ydb/docs/en/core/security/audit-log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can use any of the listed destinations or their combinations.
1818

1919
If you forward the stream to a file, access to the audit log is set by file-system rights. Saving the audit log to a file is recommended for production installations.
2020

21-
Forwarding the audit log to the standard error stream (`stderr`) is recommended for test installations. Further stream processing is determined by the {{ ydb-short-name }} cluster [logging](./logs.md) settings.
21+
Forwarding the audit log to the standard error stream (`stderr`) is recommended for test installations. Further stream processing is determined by the {{ ydb-short-name }} cluster [logging](../cluster/logs.md) settings.
2222

2323
## Audit log events {#events}
2424

‎ydb/docs/en/core/security/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# {{ ydb-short-name }} for Security Engineers
2+
3+
This section of {{ ydb-short-name }} documentation covers security-related aspects of working with {{ ydb-short-name }}. It'll be useful for compliance purposes too.
4+
5+
Main resources:
6+
7+
- [{#T}](access-management.md)
8+
- [{#T}](audit-log.md)
9+
- [{#T}](short-access-control-notation.md)
10+
- Concepts:
11+
- [{#T}](../concepts/auth.md)
12+
- [{#T}](../concepts/connect.md)

‎ydb/docs/en/core/cluster/short-access-control-notation.md renamed to ‎ydb/docs/en/core/security/short-access-control-notation.md

File renamed without changes.

‎ydb/docs/en/core/security/toc_p.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
items:
2+
- name: Overview
3+
href: index.md
4+
- name: Access management
5+
href: access-management.md
6+
- name: Audit log
7+
href: audit-log.md
8+
- name: Short access control notation
9+
href: short-access-control-notation.md

‎ydb/docs/en/core/toc_i.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ items:
1919
include:
2020
mode: link
2121
path: dev/toc_p.yaml
22+
- name: For Security Engineers
23+
include:
24+
mode: link
25+
path: security/toc_p.yaml
2226
- name: For Contributors
2327
include:
2428
mode: link

‎ydb/docs/en/core/toc_p.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
title: YDB
22
href: index.yaml
33
items:
4-
- include: { mode: link, path: toc_i.yaml }
4+
- include:
5+
mode: link
6+
path: toc_i.yaml

‎ydb/docs/redirects.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,14 @@ common:
136136
- from: /reference/ydb-sdk/example/python/index.md
137137
to: /dev/example-app/python/index.md
138138

139+
# Security-related redirects
140+
- from: /cluster/access.md
141+
to: /security/acess-management.md
142+
- from: /cluster/audit-log.md
143+
to: /security/audit-log.md
144+
- from: /cluster/short-access-control-notation.md
145+
to: /security/short-access-control-notation.md
146+
139147
# Contributors-related redirects
140148
- from: /development/build-ya.md
141149
to: /contributor/build-ya.md

‎ydb/docs/ru/core/changelog-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* В настройках селектора типа запроса добавлена новая опция `PostgreSQL`, которая доступна при включении параметра `Enable additional query modes`. Также в истории запросов теперь учитывается синтаксис, используемый при выполнении запроса.
2424
* Обновлен шаблон YQL-запроса для создания таблицы. Добавлено описание доступных параметров.
2525
* Сортировка и фильтрация для таблиц Storage и Nodes вынесена на сервер. Необходимо включить параметр `Offload tables filters and sorting to backend` в разделе экспериментов, чтобы использовать данный функционал.
26-
* В контекстное меню были добавлены кнопки для создания, изменения и удаления [топиков](https://ydb.tech/ru/docs/concepts/topic).
26+
* В контекстное меню были добавлены кнопки для создания, изменения и удаления [топиков](concepts/topic.md).
2727
* Добавлена сортировка по критичности для всех issues в дереве в `Healthcheck`.
2828

2929
**Производительность:**
@@ -155,7 +155,7 @@
155155

156156
* Добавлено [первоначальное сканирование таблицы](concepts/cdc.md#initial-scan) при создании потока изменений CDC. Теперь можно выгрузить все данные, которые существуют на момент создания потока.
157157
* Добавлена возможность [атомарной замены индекса](dba/secondary-indexes.md#atomic-index-replacement). Теперь можно атомарно и прозрачно для приложения подменить один индекс другим заранее созданным индексом. Замена выполняется без простоя.
158-
* Добавлен [аудитный лог](cluster/audit-log.md) — поток событий, который содержит информацию обо всех операциях над объектами {{ ydb-short-name }}.
158+
* Добавлен [аудитный лог](security/audit-log.md) — поток событий, который содержит информацию обо всех операциях над объектами {{ ydb-short-name }}.
159159

160160
**Производительность:**
161161

‎ydb/docs/ru/core/cluster/toc_i.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ items:
22
- name: Развертывание
33
include: { mode: link, path: ../deploy/toc_p.yaml }
44
- name: Управление доступом
5-
href: access.md
5+
href: ../security/access-management.md
66
- name: Управление дисковой подсистемой кластера
77
include: { mode: link, path: ../maintenance/manual/toc_p.yaml }
88
- name: Встроенный UI
99
include: { mode: link, path: ../reference/embedded-ui/toc_p.yaml }
1010
- name: Аудитный лог
11-
href: audit-log.md
11+
href: ../security/audit-log.md
1212
- name: Краткая запись управления доступом
13-
href: short-access-control-notation.md
13+
href: ../security/short-access-control-notation.md
1414
- name: Мониторинг
1515
items:
1616
- name: Настройка мониторинга локального кластера YDB

‎ydb/docs/ru/core/concepts/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454

5555
Для включения аутентификации по логину и паролю укажите значение `true` для ключа `enforce_user_token_requirement` в [конфигурационном файле](../deploy/configuration/config.md#auth) кластера.
5656

57-
Об управлении ролями и пользователями читайте в [{#T}](../cluster/access.md).
57+
Об управлении ролями и пользователями читайте в [{#T}](../security/access-management.md).
5858

5959
<!-- ### API получения токенов IAM {#token-refresh-api}
6060

‎ydb/docs/ru/core/dba/toc_p.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
items:
22
- name: Обзор
33
href: index.md
4-
- include: { mode: link, path: toc_i.yaml }
4+
- include:
5+
mode: link
6+
path: toc_i.yaml

‎ydb/docs/ru/core/deploy/manual/deploy-ydb-on-premises.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ sudo chmod 700 /opt/ydb/certs
403403

404404
Если в файле настроек кластера включен режим аутентификации, то перед началом работы с кластером {{ ydb-short-name }} необходимо выполнить первоначальную настройку учетных записей.
405405

406-
При первоначальной установке кластера {{ ydb-short-name }} автоматически создается учетная запись `root` с пустым паролем, а также стандартный набор групп пользователей, описанный в разделе [Управление доступом](../../cluster/access.md).
406+
При первоначальной установке кластера {{ ydb-short-name }} автоматически создается учетная запись `root` с пустым паролем, а также стандартный набор групп пользователей, описанный в разделе [Управление доступом](../../security/access-management.md).
407407

408408
Для выполнения первоначальной настройки учетных записей в созданном кластере {{ ydb-short-name }} выполните следующие операции:
409409

‎ydb/docs/ru/core/reference/kafka-api/auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
В Kafka API аутентификация выполняется через механизмы `SASL_PLAINTEXT/PLAIN` или `SASL_SSL/PLAIN`.
33

44
Для аутентификации необходимы:
5-
* `<user-name>` — имя пользователя. Об управлении пользователями читайте в разделе [Управление доступом](../../cluster/access.md).
6-
* `<password>` — пароль пользователя. Об управлении пользователями читайте в разделе [Управление доступом](../../cluster/access.md).
5+
* `<user-name>` — имя пользователя. Об управлении пользователями читайте в разделе [Управление доступом](../../security/access-management.md).
6+
* `<password>` — пароль пользователя. Об управлении пользователями читайте в разделе [Управление доступом](../../security/access-management.md).
77
* `<database>` — [путь базы данных](../../concepts/connect#database).
88

99
Из этих параметров формируются:

‎ydb/docs/ru/core/reference/kafka-api/read-write.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Перед выполнением примеров:
66
1. [Создайте топик](../ydb-cli/topic-create.md).
77
1. [Добавьте читателя](../ydb-cli/topic-consumer-add.md).
8-
1. [Создайте пользователя](../../cluster/access.md#users).
8+
1. [Создайте пользователя](../../security/access-management.md#users).
99

1010
В примерах используются:
1111

‎ydb/docs/ru/core/cluster/access.md renamed to ‎ydb/docs/ru/core/security/access-management.md

File renamed without changes.

‎ydb/docs/ru/core/cluster/audit-log.md renamed to ‎ydb/docs/ru/core/security/audit-log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ _Аудитный лог_ — это поток, который содержит
1818

1919
В случае направления в файл доступ к аудитному логу задается правами на уровне файловой системы. Сохранение аудитного лога в файл рекомендуется для использования в промышленных инсталляциях.
2020

21-
Направление аудитного лога в стандартный вывод ошибок `stderr` рекомендуется для тестовых инсталляций. Дальнейшая обработка данных потока определяется настройками [логирования](./logs.md) кластера {{ ydb-short-name }}.
21+
Направление аудитного лога в стандартный вывод ошибок `stderr` рекомендуется для тестовых инсталляций. Дальнейшая обработка данных потока определяется настройками [логирования](../cluster/logs.md) кластера {{ ydb-short-name }}.
2222

2323
## События аудитного лога {#events}
2424

‎ydb/docs/ru/core/security/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# {{ ydb-short-name }} для инженеров по безопасности
2+
3+
В этом разделе документации {{ ydb-short-name }} рассматриваются аспекты работы с {{ ydb-short-name }}, связанные с безопасностью. Также он будет полезнен для целей обеспечения compliance.
4+
5+
Основные материалы:
6+
7+
- [{#T}](access-management.md)
8+
- [{#T}](audit-log.md)
9+
- [{#T}](short-access-control-notation.md)
10+
- Концепции:
11+
- [{#T}](../concepts/auth.md)
12+
- [{#T}](../concepts/connect.md)

‎ydb/docs/ru/core/cluster/short-access-control-notation.md renamed to ‎ydb/docs/ru/core/security/short-access-control-notation.md

File renamed without changes.

‎ydb/docs/ru/core/security/toc_p.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
items:
2+
- name: Обзор
3+
href: index.md
4+
- name: Управление доступом
5+
href: access-management.md
6+
- name: Аудитный лог
7+
href: audit-log.md
8+
- name: Краткая запись управления доступом
9+
href: short-access-control-notation.md

‎ydb/docs/ru/core/toc_i.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ items:
2323
include:
2424
mode: link
2525
path: contributor/toc_p.yaml
26-
26+
- name: Для инженеров безопасности
27+
include:
28+
mode: link
29+
path: security/toc_p.yaml
2730
- name: Справка
2831
include:
2932
mode: link

‎ydb/docs/ru/core/toc_p.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
title: YDB
22
href: index.yaml
33
items:
4-
- include: { mode: link, path: toc_i.yaml }
4+
- include:
5+
mode: link
6+
path: toc_i.yaml

0 commit comments

Comments
 (0)