Skip to content

Commit 7b8fb9b

Browse files
valeria-brazhnikovamaxinskyLada7878
authored
docs: Large editorial pass — terminology, formatting, markup (#198)
* Edits Signed-off-by: Max Chervov <max.chervov@gmail.com> * Fix by promt /admin Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes /product-info and /user by promt Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Merge fixes Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes of bold text Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes of bold text Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes of bold text Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes of links Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Apply suggestions from code review (Lada) Co-authored-by: Lada Lysenko <127337005+Lada7878@users.noreply.github.com> Co-authored-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes after review Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes after review Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Apply suggestions from code review Co-authored-by: Lada Lysenko <127337005+Lada7878@users.noreply.github.com> Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes after review Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Apply suggestions from code review Co-authored-by: Lada Lysenko <127337005+Lada7878@users.noreply.github.com> Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes of alerts Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * fix Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fix after rebase Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fixes after merge from main Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> * Fix Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> --------- Signed-off-by: Max Chervov <max.chervov@gmail.com> Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> Co-authored-by: Max Chervov <max.chervov@gmail.com> Co-authored-by: Lada Lysenko <127337005+Lada7878@users.noreply.github.com>
1 parent 29cfba8 commit 7b8fb9b

49 files changed

Lines changed: 1732 additions & 1685 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/documentation/admin/actions/overview.ru.md

Lines changed: 57 additions & 55 deletions
Large diffs are not rendered by default.

content/documentation/admin/actions/types.ru.md

Lines changed: 196 additions & 196 deletions
Large diffs are not rendered by default.

content/documentation/admin/architecture/functional-architecture.ru.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,35 @@ weight: 10
55

66
## Описание компонентов
77

8+
В состав Deckhouse Development Platform (DDP) входят следующие компоненты.
9+
810
### DDP Frontend
911

10-
**DDP Frontend** — это веб-интерфейс платформы, построенный на Vue.js 3 с TypeScript. Компонент предоставляет пользователям графический интерфейс для работы с платформой через веб-браузер.
12+
DDP Frontend — это веб-интерфейс платформы, построенный на Vue.js 3 с TypeScript. Компонент предоставляет пользователям графический интерфейс для работы с платформой через веб-браузер.
1113

12-
**Основные функции:**
14+
Основные функции:
1315

1416
* Отображение пользовательского интерфейса для управления сервисами, окружениями и ресурсами.
1517
* Обработка пользовательских действий и передача запросов в DDP Backend через REST API.
1618

17-
**Технические характеристики:**
19+
Технические характеристики:
1820

1921
* Принимает входящие соединения от пользователей.
2022
* Взаимодействует с DDP Backend.
2123

2224
### DDP Backend
2325

24-
**DDP Backend** — это серверная часть платформы, реализованная на языке Go. Компонент предоставляет REST API для управления всеми механизмами платформы.
26+
DDP Backend — это серверная часть платформы, реализованная на языке Go. Компонент предоставляет REST API для управления всеми механизмами платформы.
2527

26-
**Основные функции:**
28+
Основные функции:
2729

2830
* Предоставление REST API для программного взаимодействия с платформой.
2931
* Обработка бизнес-логики платформы.
3032
* Реализация системы контроля доступа (RBAC) и управления правами пользователей.
3133
* Интеграция с внешними инфраструктурными сервисами для выполнения различных операций.
3234
* Управление данными через взаимодействие с PostgreSQL и Redis.
3335

34-
**Технические характеристики:**
36+
Технические характеристики:
3537

3638
* Принимает API-запросы от пользователей и DDP Frontend.
3739
* Выполняет валидацию токенов доступа локально, используя кэшированные ключи подписи.
@@ -40,15 +42,15 @@ weight: 10
4042

4143
### DDP Worker
4244

43-
**DDP Worker** — это компонент для выполнения фоновых задач и асинхронных операций, реализованный на языке Go. Worker обрабатывает задачи из очередей Redis Streams и выполняет операции по запуску действий и синхронизации источников данных.
45+
DDP Worker — это компонент для выполнения фоновых задач и асинхронных операций, реализованный на языке Go. Worker обрабатывает задачи из очередей Redis Streams и выполняет операции по запуску действий и синхронизации источников данных.
4446

45-
**Основные функции:**
47+
Основные функции:
4648

4749
* Синхронизация данных из внешних источников.
4850
* Выполнение действий в асинхронном режиме.
4951
* Выполнение проверок статуса сущностей.
5052

51-
**Технические характеристики:**
53+
Технические характеристики:
5254

5355
* Может быть развернут в нескольких экземплярах для обеспечения масштабируемости.
5456
* Использует Redis Streams для получения задач из очередей.
@@ -57,46 +59,46 @@ weight: 10
5759

5860
### Dex
5961

60-
**Dex** — это компонент системы аутентификации и авторизации, выполняющий роль identity provider. Dex обеспечивает единую точку входа для пользователей и интегрируется с различными внешними провайдерами аутентификации.
62+
Dex — это компонент системы аутентификации и авторизации, выполняющий роль identity provider. Dex обеспечивает единую точку входа для пользователей и интегрируется с различными внешними провайдерами аутентификации.
6163

6264
{{< alert level="warning" >}}
63-
**Dex** не входит в состав модуля DDP (Deckhouse Development Platform) и является частью DKP (Deckhouse Kubernetes Platform).
65+
Dex не входит в состав модуля DDP и является частью Deckhouse Kubernetes Platform (DKP).
6466
{{< /alert >}}
6567

66-
**Основные функции:**
68+
Основные функции:
6769

6870
* Управление процессом аутентификации пользователей.
6971
* Выдача токенов доступа.
7072
* Интеграция с внешними провайдерами аутентификации (Keycloak, LDAP и другими).
7173
* Предоставление ключей подписи для проверки токенов.
7274

73-
**Технические характеристики:**
75+
Технические характеристики:
7476

7577
* Выписывает токены для аутентификации в DDP Backend.
7678
* Периодически предоставляет ключи подписи токенов для проверки.
7779
* Интегрируется с внешними провайдерами аутентификации через стандартные протоколы (OIDC, LDAP и др.).
7880

7981
### Redis
8082

81-
**Redis** — это хранилище данных в памяти, используемое платформой для работы с очередями задач.
83+
Redis — это хранилище данных в памяти, используемое платформой для работы с очередями задач.
8284

8385
{{< alert level="info" >}}
8486
Redis может быть установлен в составе модуля DDP для тестовых и демонстрационных целей. В промышленной эксплуатации рекомендуется использование выделенных инстансов Redis.
8587
{{< /alert >}}
8688

87-
**Основные функции:**
89+
Основные функции:
8890

8991
* Реализация очередей задач через Redis Streams для асинхронной обработки.
9092
* Поддержка распределенных блокировок для координации работы нескольких экземпляров Worker.
9193
* Хранение событий, генерируемых при изменениях сущностей.
9294

93-
**Технические характеристики:**
95+
Технические характеристики:
9496

9597
* Используется для хранения очередей задач, которые обрабатываются DDP Worker.
9698

9799
### PostgreSQL
98100

99-
**PostgreSQL** — это основная реляционная база данных платформы, используемая для хранения всей постоянной информации.
101+
PostgreSQL — это основная реляционная база данных платформы, используемая для хранения всей постоянной информации.
100102

101103
{{< alert level="info" >}}
102104
PostgreSQL может быть установлен в составе модуля DDP для тестовых и демонстрационных целей. В промышленной эксплуатации рекомендуется использование выделенных инстансов PostgreSQL.
@@ -108,20 +110,20 @@ PostgreSQL может быть установлен в составе модул
108110

109111
### Входящие соединения
110112

111-
* Пользователи подключаются к **DDP Frontend** по протоколу HTTPS (TCP/443) для работы с веб-интерфейсом.
112-
* Пользователи могут напрямую обращаться к **DDP Backend** по протоколу HTTPS (TCP/443) для использования REST API.
113+
* Пользователи подключаются к DDP Frontend по протоколу HTTPS (TCP/443) для работы с веб-интерфейсом.
114+
* Пользователи могут напрямую обращаться к DDP Backend по протоколу HTTPS (TCP/443) для использования REST API.
113115

114116
### Взаимодействие между компонентами платформы
115117

116-
* **DDP Frontend****DDP Backend** (TCP/8080, опционально mTLS): Frontend передает запросы пользователей в Backend для обработки.
117-
* **DDP Backend****Dex** (TCP/443): Backend получает ключи подписи от Dex для проверки токенов.
118-
* **DDP Backend****Redis** (TCP/6379): Backend использует Redis для координации очередей задач и хранения событий.
119-
* **DDP Backend****PostgreSQL** (TCP/5432): Backend выполняет операции чтения и записи постоянных данных.
120-
* **DDP Worker****Redis** (TCP/6379): Worker получает задачи из очередей Redis Streams и использует распределенные блокировки.
121-
* **DDP Worker****PostgreSQL** (TCP/5432): Worker обновляет данные в базе после выполнения задач.
118+
* DDP Frontend → DDP Backend (TCP/8080, опционально mTLS): Frontend передает запросы пользователей в Backend для обработки.
119+
* DDP Backend ↔ Dex (TCP/443): Backend получает ключи подписи от Dex для проверки токенов.
120+
* DDP Backend ↔ Redis (TCP/6379): Backend использует Redis для координации очередей задач и хранения событий.
121+
* DDP Backend ↔ PostgreSQL (TCP/5432): Backend выполняет операции чтения и записи постоянных данных.
122+
* DDP Worker ↔ Redis (TCP/6379): Worker получает задачи из очередей Redis Streams и использует распределенные блокировки.
123+
* DDP Worker ↔ PostgreSQL (TCP/5432): Worker обновляет данные в базе после выполнения задач.
122124

123125
### Интеграция с внешними сервисами
124126

125-
* **Dex****Провайдеры аутентификации** (Keycloak, LDAP и др.): Dex интегрируется с внешними системами управления пользователями.
126-
* **DDP Backend****Инфраструктурные сервисы** (TCP/443): Backend взаимодействует с внешними сервисами для получения информации.
127-
* **DDP Worker****Инфраструктурные сервисы** (TCP/443): Worker выполняет операции с внешними сервисами при синхронизации данных и выполнении действий.
127+
* Dex ↔ Провайдеры аутентификации (Keycloak, LDAP и др.): Dex интегрируется с внешними системами управления пользователями.
128+
* DDP Backend ↔ Инфраструктурные сервисы (TCP/443): Backend взаимодействует с внешними сервисами для получения информации.
129+
* DDP Worker ↔ Инфраструктурные сервисы (TCP/443): Worker выполняет операции с внешними сервисами при синхронизации данных и выполнении действий.

0 commit comments

Comments
 (0)