Skip to content

Commit ac90ad4

Browse files
AvtandilkoNikita Velgin
andauthored
add managed deckhouse seeds description (#234)
* add managed deckhouse seeds description * add action description * fix * fix --------- Co-authored-by: Nikita Velgin <nikita.velgin@flant.com>
1 parent 17c5559 commit ac90ad4

4 files changed

Lines changed: 110 additions & 0 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ weight: 10
77

88
- создавать проекты, переменные, ветки или теги в GitLab;
99
- создавать ресурсы в Kubernetes;
10+
- получать ресурсы из Kubernetes;
1011
- создавать секреты в Deckhouse Stronghold или HashiCorp Vault;
1112
- создавать проекты в SonarQube, DefectDojo и других системах;
1213
- создавать топики и ACL в Kafka.

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,42 @@ manifests:
620620

621621
* `token` — токен сервисного аккаунта в Kubernetes.
622622

623+
## GetKubernetesResource
624+
625+
GetKubernetesResource — получает ресурс из Kubernetes кластера.
626+
627+
### Пример запроса
628+
629+
```yaml
630+
group: managed-services.deckhouse.io
631+
version: v1alpha1
632+
resource_type: postgres
633+
resource_name: example-postgres
634+
namespace: default
635+
```
636+
637+
### Спецификация запроса
638+
639+
| Название | Обязательность | Описание | Возможные значения |
640+
|---------------------------|----------------|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
641+
| group | Да | API-группа ресурса. Указывает, к какой группе API относится запрашиваемый объект | [Определение требуемых Group и Version](#определение-требуемых-group-и-version) |
642+
| version | Да | Версия API ресурса | [Определение требуемых Group и Version](#определение-требуемых-group-и-version) |
643+
| resource_type | Да | Название ресурса во множественном числе, как в поле NAME вывода команды `kubectl api-resources` | - |
644+
| resource_name | Да | Название конкретного ресурса, который необходимо получить | - |
645+
| namespace | Да | Неймспейс, в котором находится ресурс | - |
646+
647+
### Ответ
648+
649+
При успешном выполнении действие возвращает объект ресурса в поле `resource`. Если ресурс не найден, действие завершается с ошибкой.
650+
651+
| Название | Описание |
652+
|------------|-----------------------------------------------|
653+
| `resource` | Объект ресурса в формате Kubernetes |
654+
655+
### Учётные данные
656+
657+
* `token` — токен сервисного аккаунта в Kubernetes.
658+
623659
## CreateRepositoryFromTemplate
624660

625661
CreateRepositoryFromTemplate — создаёт новый репозиторий из шаблона в Gitlab. Механизм рендеринга основан на [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) и поддерживает все встроенные методы, а также расширения, добавленные в платформу.

content/documentation/admin/datasets.ru.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,69 @@ menuTitle: Наборы данных
159159
1. Подключите внешний сервис «Vault» к действиям, виджетам или источникам данных, которые обращаются к API Vault.
160160

161161
После этого запросы через внешний сервис будут использовать токен из учётных данных пользователя. Например, внешний сервис можно подключить к виджету [«Vault. Секреты»](../widgets/types/#vault-секреты) для просмотра секретов в KV v2.
162+
163+
### Deckhouse managed PostgreSQL
164+
165+
Набор данных для развёртывания managed PostgreSQL в Deckhouse Kubernetes Platform.
166+
167+
Набор данных подготавливает ресурс, действия и процессы для управления жизненным циклом managed PostgreSQL: создание инстанса в кластере через внешний сервис Kubernetes и сохранение реквизитов подключения в Vault или Stronghold.
168+
169+
Настройка:
170+
171+
Перед применением настройте внешние сервисы [Kubernetes](../external-services/#kubernetes) и [Vault](../external-services/#vault) (или Stronghold).
172+
173+
{{< alert level="info" >}}
174+
Подробное описание компонентов набора данных доступно по кнопке «Описание» на карточке в разделе «Наборы данных».
175+
{{< /alert >}}
176+
177+
Параметры настройки:
178+
179+
| Название | Описание | Значение по умолчанию |
180+
|----------|----------|-----------------------|
181+
| «Внешний сервис Kubernetes» | Kubernetes кластер, в котором будет разворачиваться managed PostgreSQL ||
182+
| «Внешний сервис Vault или Stronghold» | Внешний сервис для записи реквизитов подключения в KV v2 ||
183+
| «Префикс пути Vault» | Префикс пути KV v2 для сохранения реквизитов (с `/data/`) | `services/data/` |
184+
185+
### Deckhouse managed Valkey
186+
187+
Набор данных для развёртывания managed Valkey в Deckhouse Kubernetes Platform.
188+
189+
Набор данных подготавливает ресурс, действия и процессы для управления жизненным циклом managed Valkey: создание инстанса в кластере через внешний сервис Kubernetes и сохранение реквизитов подключения в Vault или Stronghold.
190+
191+
Настройка:
192+
193+
Перед применением настройте внешние сервисы [Kubernetes](../external-services/#kubernetes) и [Vault](../external-services/#vault) (или Stronghold).
194+
195+
{{< alert level="info" >}}
196+
Подробное описание компонентов набора данных доступно по кнопке «Описание» на карточке в разделе «Наборы данных».
197+
{{< /alert >}}
198+
199+
Параметры настройки:
200+
201+
| Название | Описание | Значение по умолчанию |
202+
|----------|----------|-----------------------|
203+
| «Внешний сервис Kubernetes» | Kubernetes кластер, в котором будет разворачиваться managed Valkey ||
204+
| «Внешний сервис Vault или Stronghold» | Внешний сервис для записи реквизитов подключения в KV v2 ||
205+
| «Префикс пути Vault» | Префикс пути KV v2 для сохранения реквизитов (с `/data/`) | `services/data/` |
206+
207+
### Deckhouse managed Kafka
208+
209+
Набор данных для развёртывания managed Kafka в Deckhouse Kubernetes Platform.
210+
211+
Набор данных подготавливает ресурс, действия и процессы для управления жизненным циклом managed Kafka: создание инстанса в кластере через внешний сервис Kubernetes и сохранение реквизитов подключения в Vault или Stronghold.
212+
213+
Настройка:
214+
215+
Перед применением настройте внешние сервисы [Kubernetes](../external-services/#kubernetes) и [Vault](../external-services/#vault) (или Stronghold).
216+
217+
{{< alert level="info" >}}
218+
Подробное описание компонентов набора данных доступно по кнопке «Описание» на карточке в разделе «Наборы данных».
219+
{{< /alert >}}
220+
221+
Параметры настройки:
222+
223+
| Название | Описание | Значение по умолчанию |
224+
|----------|----------|-----------------------|
225+
| «Внешний сервис Kubernetes» | Kubernetes кластер, в котором будет разворачиваться managed Kafka ||
226+
| «Внешний сервис Vault или Stronghold» | Внешний сервис для записи реквизитов подключения в KV v2 ||
227+
| «Префикс пути Vault» | Префикс пути KV v2 для сохранения реквизитов (с `/data/`) | `services/data/` |

content/documentation/release-notes/v1.6.0.ru.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ description: Заметки о выпуске v1.6.0 — хранилище пр
4040

4141
Добавлена функция шаблонизации [«toSlug»](../../user/templating/#toslug).
4242

43+
### Действия
44+
45+
Добавлено действие [GetKubernetesResource](../../admin/actions/types/#getkubernetesresource) для получения спецификации ресурса из Kubernetes кластера.
46+
4347
### Процессы
4448

4549
- Добавлен элемент [«Таймер»](../../admin/processes/overview/#таймер) — пауза выполнения процесса до заданного момента времени.
@@ -58,6 +62,9 @@ description: Заметки о выпуске v1.6.0 — хранилище пр
5862

5963
- Добавлен [набор данных Yandex Cloud](../../admin/datasets/#yandex-cloud) для подключения к API Yandex Cloud.
6064
- Добавлен [набор данных Vault](../../admin/datasets/#vault) для подключения к API HashiCorp Vault.
65+
- Добавлен [набор данных Deckhouse managed PostgreSQL](../../admin/datasets/#deckhouse-managed-postgresql) для развёртывания managed PostgreSQL в Deckhouse Kubernetes Platform.
66+
- Добавлен [набор данных Deckhouse managed Valkey](../../admin/datasets/#deckhouse-managed-valkey) для развёртывания managed Valkey в Deckhouse Kubernetes Platform.
67+
- Добавлен [набор данных Deckhouse managed Kafka](../../admin/datasets/#deckhouse-managed-kafka) для развёртывания managed Kafka в Deckhouse Kubernetes Platform.
6168

6269
### Проверки статуса
6370

0 commit comments

Comments
 (0)