refactor: restructure project — separate tools, config, generated, provider

TOOLS/        — generators + scripts + config + ARCHITECTURE.md
  ├── yaml-generator/    (code)
  ├── resource-generator/ (code)
  ├── docs-generator/    (code)
  ├── scripts/           (← devops/*.sh)
  ├── config/            (← devops/profiles/ + devops/config/)
  │   ├── test/          profile.env, services_list.txt, operation_timeouts.json
  │   ├── prod/
  │   └── dev/
  └── ARCHITECTURE.md    (← devops/ARCHITECTURE.md)

generated/    — pipeline output only (gitignored)
  ├── test/resources_yaml/, go/, docs/, provider_build/
  ├── prod/
  └── dev/

provider/     — code only, no generated files
  resources_yaml/        — DELETED (generated)
  internal/resources_gen/ — DELETED (generated)

devops/       — removed (replaced by TOOLS/scripts + TOOLS/config + generated/)

Generators now fail if NUBES_*_DIR not set (no defaults to provider/).
Provider requires pipeline to populate resources_gen/ before build.
This commit is contained in:
“Naeel”
2026-07-06 09:06:09 +04:00
parent c34db5e5e3
commit dd56bcda83
1285 changed files with 84004 additions and 1910 deletions
View File
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## MAN
<div class="man-content">
# Инструкция по развертыванию Apache Kafka через платформу<br/><br/>---<br/>## 1. Общая информация<br/>AKHQ — это веб-интерфейс для работы с кластерами Apache Kafka.<br/>Позволяет просматривать топики, consumer group'ы, сообщения, ACL, схему безопасности, состояние брокеров и метаданные.<br/>Поддерживает работу с несколькими кластерами Kafka одновременно, включая внутренние и внешние (TLS) подключения.<br/><br/>## Доступные операции<br/>- **create** — Создание ресурса AKHQ<br/>- **suspend** — Остановка ресурса<br/>- **resume** — Возобновление работы ресурса<br/>- **modify** — Модификация настроек<br/>- **delete** — Удаление ресурса<br/><br/>---<br/>## 2. Параметры развертывания кластера<br/>Ниже перечислены параметры, которые необходимо указать при создании ресурса Kafka:<br/><br/>* **Кластер Kafka к которому нужно настроить подключение**<br/>Для использования AKHQ необходимо предварительно развернуть сервис Kafka. Пример: `kafka-external`.<br/><br/>* **Платформа для развертывания:**<br/>Платформа для развертывания (среда, в которой будет развернут кластер). Пример: `k8s-3.ext.nubes.ru`.<br/><br/>* **Количество узлов в сети:**<br/>Количество узлов для работы Akhq. Пример `2`<br/><br/>* **Квота (megabyte) памяти пода:**<br/>Квота памяти пода в мегабайтах. Пример: `512`<br/><br/>* **Квота (millicore ) ядра пода:**<br/>Квота CPU пода в миликорах (1000 mCPU = 1 vCPU). Пример: `500`<br/><br/>* **Имя домена:**<br/>Dns Имя по которому будет происходить обращение к сервису. Указать необходимо уникальное имя до . ( то есть если необходимо получить dns ui) Пример: `kafka-external`<br/><br/>---<br/>## 4. Выходные параметры<br/>После успешного развертывания ресурса Kafka платформа возвращает ряд параметров.<br/>Ключевым из них является:<br/><br/>**connectionUrl**<br/>Это полное доменное имя (FQDN), по которому будет доступен интерфейс AKHQ. После развёртывания подождите несколько минут — UI станет доступен по HTTPS, как только все сервисы полностью запустятся.<br/><br/>**Учетные данные**<br/>Здесь представлены поля для ввода логина и пароля, с помощью которых вы сможете авторизоваться в сервисе.<br/><br/>---<br/>## 5. Дополнительная информация<br/>Учётные записи, созданные для работы с AKHQ, предоставляют доступ только для просмотра данных. Для управления Kafka, пожалуйста, используйте возможности личного кабинета.<br/>---
</div>
+50
View File
@@ -0,0 +1,50 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Copy-ready manifest (`akhq_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_akhq" "baza" {
resource_realm = "TODO" # Выбрать платформу из списка
domain = "TODO" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
kafka_uid = "TODO" # Выбрать кластер из списка
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
resource_memory = 512 # Пример: `1024`
resource_cpu = 500 # Пример: `1000`
resource_instances = 1
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_akhq.baza.state_params["имя_ключа"]
nubes_akhq.baza.state_out["имя_ключа"]
nubes_akhq.baza.state_params_flat["имя_ключа"]
nubes_akhq.baza.state_out_flat["имя_ключа"]
nubes_akhq.baza.vault_secrets["имя_ключа"]
nubes_akhq.baza.vault_url
nubes_akhq.baza.vault_user_path
nubes_akhq.baza.vault_fields
```
+15
View File
@@ -0,0 +1,15 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](akhq_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](akhq_params_modify.md)
- `resume`
- `suspend`
+33
View File
@@ -0,0 +1,33 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["connectionUrl"]`
### `vault_secrets` ключи
- `vault_secrets["pass"]`
- `vault_secrets["user"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Parameters
- [Create params](akhq_params_create.md)
- [Modify params](akhq_params_modify.md)
+40
View File
@@ -0,0 +1,40 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>550</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>553</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>555</td><td><strong><code class="code-no-wrap">kafka_uid</code></strong></td><td><code>uuid</code></td><td>Выбрать кластер из списка</td><td>ref_svc_id=116</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>551</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Пример: `1024`</td><td>minvalue=512</td></tr>
<tr><td>552</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>500</code></td><td>Пример: `1000`</td><td>minvalue=500</td></tr>
<tr><td>554</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td></td><td>minvalue=1</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+15
View File
@@ -0,0 +1,15 @@
# Resource nubes_akhq
Service ID: `119`
Service Name: Akhq
[Manual](akhq.md) | [Create params](akhq_params_create.md) | [Modify params](akhq_params_modify.md) | [Output params](akhq_outputs.md) | [Operations](akhq_ops.md) | [Example](akhq_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>565</td><td><strong><code class="code-no-wrap">kafka_uid</code></strong></td><td><code>uuid</code></td><td>Выбрать кластер из списка</td><td>ref_svc_id=116</td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## MAN
<div class="man-content">
Необходима DNS зона, в которой будет создана DNS запись.<br/>Выберите <br/>* Зону в которой будет создана запись<br/>* Тип записи<br/>* Имя записи<br/>* Значение записи
</div>
+49
View File
@@ -0,0 +1,49 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Copy-ready manifest (`dnsrecord_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_dnsrecord" "baza" {
zone_uid = "TODO" # UUID экземпляра услуги DNS-зоны
record_type = "A" # Тип DNS-записи
record_name = "TODO" # Имя записи. Имя зоны в конце проставляется автоматически
record_input = "TODO" # Значение. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
record_ttl = 3600 # Time-to-Leave записи. Раз в какое время запись будет обновлена
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_dnsrecord.baza.state_params["имя_ключа"]
nubes_dnsrecord.baza.state_out["имя_ключа"]
nubes_dnsrecord.baza.state_params_flat["имя_ключа"]
nubes_dnsrecord.baza.state_out_flat["имя_ключа"]
nubes_dnsrecord.baza.vault_secrets["имя_ключа"]
nubes_dnsrecord.baza.vault_url
nubes_dnsrecord.baza.vault_user_path
nubes_dnsrecord.baza.vault_fields
```
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](dnsrecord_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](dnsrecord_params_modify.md)
+29
View File
@@ -0,0 +1,29 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["dnsServers"]`
- `state_out_flat["record"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Parameters
- [Create params](dnsrecord_params_create.md)
- [Modify params](dnsrecord_params_modify.md)
@@ -0,0 +1,27 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>75</td><td><strong><code class="code-no-wrap">zone_uid</code></strong></td><td><code>uuid</code></td><td>UUID экземпляра услуги DNS-зоны</td><td>ref_svc_id=110</td></tr>
<tr><td>76</td><td><strong><code class="code-no-wrap">record_type</code></strong></td><td><code>string</code></td><td>Тип DNS-записи</td><td>value_list=A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT, LUA, NS, SSHFP</td></tr>
<tr><td>77</td><td><strong><code class="code-no-wrap">record_name</code></strong></td><td><code>string</code></td><td>Имя записи. Имя зоны в конце проставляется автоматически</td><td>unique_scope=parent</td></tr>
<tr><td>78</td><td><strong><code class="code-no-wrap">record_input</code></strong></td><td><code>string</code></td><td>Значение. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP</td><td></td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>450</td><td><strong><code class="code-no-wrap">record_ttl</code></strong></td><td><code>integer</code></td><td><code>3600</code></td><td>Time-to-Leave записи. Раз в какое время запись будет обновлена</td><td>minvalue=30; maxvalue=604800</td></tr>
</tbody></table>
@@ -0,0 +1,15 @@
# Resource nubes_dnsrecord
Service ID: `111`
Service Name: DNS запись
[Manual](dnsrecord.md) | [Create params](dnsrecord_params_create.md) | [Modify params](dnsrecord_params_modify.md) | [Output params](dnsrecord_outputs.md) | [Operations](dnsrecord_ops.md) | [Example](dnsrecord_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>256</td><td><strong><code class="code-no-wrap">record_input</code></strong></td><td><code>string</code></td><td>Запись. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP</td><td></td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## MAN
<div class="man-content">
## ![image](https://img.icons8.com/?size=50&id=41400&format=png) Необходимо делегировать зону у регистратора на Авторитетные DNS (Сервера зон)<br/><br/>ns3.ngcloud.ru<br/>``` bash<br/>185.247.187.83<br/>2a10:aa80:0:5::3<br/>```<br/><br/>ns4.ngcloud.ru<br/>``` bash<br/>81.22.46.43<br/>2a10:aa80:0:6::3<br/>```
</div>
+52
View File
@@ -0,0 +1,52 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Copy-ready manifest (`dnszone_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_dnszone" "baza" {
zone_email = "TODO" # Контактный e-mail
zone_name = "TODO" # Имя зоны
resource_realm = "TODO" # Платформа для развертывания
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
zone_kind = "NATIVE" # Тип зоны
zone_time_to_refresh = 86400 # Время ожидания ответа вторичного DNS перед запросом SOA-записи с первичных серверов
zone_time_to_retry = 7200 # Время в течение которого сервер повторно попробует синхронизировать информацию с первичных DNS-серверов
zone_time_to_expire = 3600000 # Время в течение которого вторичный DNS будет пытаться завершить синхронизацию зоны с первичным
zone_time_to_live = 86400 # Время, в течение которого информация будет кешироваться другими DNS-серверами
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_dnszone.baza.state_params["имя_ключа"]
nubes_dnszone.baza.state_out["имя_ключа"]
nubes_dnszone.baza.state_params_flat["имя_ключа"]
nubes_dnszone.baza.state_out_flat["имя_ключа"]
nubes_dnszone.baza.vault_secrets["имя_ключа"]
nubes_dnszone.baza.vault_url
nubes_dnszone.baza.vault_user_path
nubes_dnszone.baza.vault_fields
```
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](dnszone_params_create.md)
- `delete`
+32
View File
@@ -0,0 +1,32 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["dnsServers"]`
- `state_out_flat["dnsServers.ns1.nubes.ru"]`
- `state_out_flat["dnsServers.ns2.nubes.ru"]`
- `state_out_flat["zoneSerial"]`
- `state_out_flat["zoneSoaServer"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Parameters
- [Create params](dnszone_params_create.md)
- [Modify params](dnszone_params_modify.md)
@@ -0,0 +1,31 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>66</td><td><strong><code class="code-no-wrap">zone_email</code></strong></td><td><code>string</code></td><td>Контактный e-mail</td><td></td></tr>
<tr><td>67</td><td><strong><code class="code-no-wrap">zone_name</code></strong></td><td><code>string</code></td><td>Имя зоны</td><td>regex=^([a-z0-9-]+\.)+[a-z0-9-]+$</td></tr>
<tr><td>69</td><td><strong><code class="code-no-wrap">zone_masters_for_slave</code></strong></td><td><code>string</code></td><td>Использовать если выбран тип SLAVE. IP адреса в формате через пробел для настройки Master-серверов</td><td></td></tr>
<tr><td>284</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>68</td><td><strong><code class="code-no-wrap">zone_kind</code></strong></td><td><code>string</code></td><td><code>NATIVE</code></td><td>Тип зоны</td><td>value_list=NATIVE, SLAVE</td></tr>
<tr><td>70</td><td><strong><code class="code-no-wrap">zone_time_to_refresh</code></strong></td><td><code>string</code></td><td><code>86400</code></td><td>Время ожидания ответа вторичного DNS перед запросом SOA-записи с первичных серверов</td><td></td></tr>
<tr><td>71</td><td><strong><code class="code-no-wrap">zone_time_to_retry</code></strong></td><td><code>string</code></td><td><code>7200</code></td><td>Время в течение которого сервер повторно попробует синхронизировать информацию с первичных DNS-серверов</td><td></td></tr>
<tr><td>72</td><td><strong><code class="code-no-wrap">zone_time_to_expire</code></strong></td><td><code>string</code></td><td><code>3600000</code></td><td>Время в течение которого вторичный DNS будет пытаться завершить синхронизацию зоны с первичным</td><td></td></tr>
<tr><td>73</td><td><strong><code class="code-no-wrap">zone_time_to_live</code></strong></td><td><code>string</code></td><td><code>86400</code></td><td>Время, в течение которого информация будет кешироваться другими DNS-серверами</td><td></td></tr>
</tbody></table>
@@ -0,0 +1,11 @@
# Resource nubes_dnszone
Service ID: `110`
Service Name: DNS зона
[Manual](dnszone.md) | [Create params](dnszone_params_create.md) | [Modify params](dnszone_params_modify.md) | [Output params](dnszone_outputs.md) | [Operations](dnszone_ops.md) | [Example](dnszone_example.md)
## Modify params
None.
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## MAN
<div class="man-content">
## Болванка для тестов.<br/><br/>А это просто много букв, чтобы посмотреть, как ведет себя текст при переполнении контейнера. <br/><br/><br/>``` json<br/>{<br/> &quot;iamServiceUrl&quot;: &quot;https://auth-api-test.ngcloud.ru/api/v1/user&quot;,<br/> &quot;idpResponse&quot;: {<br/> &quot;prefix&quot;: {<br/> &quot;charset&quot;: &quot;&quot;,<br/> &quot;status_text&quot;: &quot;Request Time-out&quot;,<br/> &quot;text&quot;: true,<br/> &quot;errordetail&quot;: &quot;&quot;,<br/> &quot;filecontent&quot;: &quot;Connection Timeout&quot;,<br/> &quot;responseheader&quot;: {},<br/> &quot;header&quot;: &quot;&quot;,<br/> &quot;statuscode&quot;: &quot;408 Request Time-out&quot;,<br/> &quot;status_code&quot;: 408,<br/> &quot;mimetype&quot;: &quot;Unable to determine MIME type of file.&quot;<br/> }<br/> }<br/>}<br/>```
</div>
+49
View File
@@ -0,0 +1,49 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Copy-ready manifest (`dummy_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_dummy" "baza" {
resource_realm = "TODO" # Платформа для развертывания
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
duration_ms = 0 # перед завершением подождать (sleep) столько миллисекунд
fail_at_start = false # если true, завершить джоб, ничего не записывая в cmdb
fail_in_progress = false # если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb
where_fail = 1 # принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_dummy.baza.state_params["имя_ключа"]
nubes_dummy.baza.state_out["имя_ключа"]
nubes_dummy.baza.state_params_flat["имя_ключа"]
nubes_dummy.baza.state_out_flat["имя_ключа"]
nubes_dummy.baza.vault_secrets["имя_ключа"]
nubes_dummy.baza.vault_url
nubes_dummy.baza.vault_user_path
nubes_dummy.baza.vault_fields
```
+17
View File
@@ -0,0 +1,17 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](dummy_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](dummy_params_modify.md)
- `reconcile`
- `redeploy`
- `resume`
- `suspend`
+28
View File
@@ -0,0 +1,28 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `vault_secrets` ключи
- `vault_secrets["someKey"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Parameters
- [Create params](dummy_params_create.md)
- [Modify params](dummy_params_modify.md)
+46
View File
@@ -0,0 +1,46 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>242</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Наименование ресурсной платформы для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>286</td><td><strong><code class="code-no-wrap">bodymessage</code></strong></td><td><code>string</code></td><td>Дата, уходящая в Vault</td><td></td></tr>
<tr><td>321</td><td><strong><code class="code-no-wrap">map_example</code></strong></td><td><code>map</code></td><td></td><td></td></tr>
<tr><td>322</td><td><strong><code class="code-no-wrap">json_example</code></strong></td><td><code>json</code></td><td>Для тестирования интерфейса. Сюда можно писать корректный json</td><td></td></tr>
<tr><td>396</td><td><strong><code class="code-no-wrap">nested_ref_example</code></strong></td><td></td><td></td><td></td></tr>
<tr><td>447</td><td><strong><code class="code-no-wrap">yaml_example</code></strong></td><td><code>yaml</code></td><td></td><td></td></tr>
<tr><td>647</td><td><strong><code class="code-no-wrap">map_fixed</code></strong></td><td><code>map-fixed</code></td><td>Новый тип поля</td><td></td></tr>
<tr><td>654</td><td><strong><code class="code-no-wrap">array_map_fixed_example</code></strong></td><td><code>array-map-fixed</code></td><td>Array of map-fixed</td><td></td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>198</td><td><strong><code class="code-no-wrap">duration_ms</code></strong></td><td><code>integer</code></td><td><code>0</code></td><td>перед завершением подождать (sleep) столько миллисекунд</td><td></td></tr>
<tr><td>199</td><td><strong><code class="code-no-wrap">fail_at_start</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>**Операция не будет завершена**<br/>Она будет в постоянном статусе PENDING, однако в Jenkins Job завершится с ошибкой</td><td>value_list=false, true</td></tr>
<tr><td>200</td><td><strong><code class="code-no-wrap">fail_in_progress</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>201</td><td><strong><code class="code-no-wrap">where_fail</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write</td><td>value_list=1, 2, 3</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+21
View File
@@ -0,0 +1,21 @@
# Resource nubes_dummy
Service ID: `1`
Service Name: Болванка
[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>287</td><td><strong><code class="code-no-wrap">duration_ms</code></strong></td><td><code>integer</code></td><td>перед завершением подождать (sleep) столько миллисекунд</td><td></td></tr>
<tr><td>288</td><td><strong><code class="code-no-wrap">fail_at_start</code></strong></td><td><code>boolean</code></td><td>если true, завершить джоб, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>289</td><td><strong><code class="code-no-wrap">fail_in_progress</code></strong></td><td><code>boolean</code></td><td>если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>290</td><td><strong><code class="code-no-wrap">where_fail</code></strong></td><td><code>integer</code></td><td>принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write</td><td>value_list=1, 2, 3</td></tr>
<tr><td>291</td><td><strong><code class="code-no-wrap">bodymessage</code></strong></td><td></td><td>Дата, уходящая в Vault</td><td></td></tr>
<tr><td>373</td><td><strong><code class="code-no-wrap">map_example</code></strong></td><td><code>map</code></td><td></td><td></td></tr>
<tr><td>374</td><td><strong><code class="code-no-wrap">json_example</code></strong></td><td></td><td></td><td></td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## MAN
<div class="man-content">
# Инструкция по развертыванию Web-сервер с фреймворком Flask через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Web-сервер с фреймворком Flask** предназначен для развертывания веб-приложений на базе Flask.<br/><br/>### Доступные операции<br/><br/>create — включить сервис, развернуть веб-приложение с указанными параметрами.<br/>delete — удалить сервис, только после suspend.<br/>modify — изменить настройки сервиса и переразвернуть.<br/>suspend — выключить веб-приложение, остановить обслуживание.<br/>resume — включить веб-приложение после suspend.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Имя домена<br/>Описание: доменное имя для доступа к веб-приложению. Если указан FQDN, происходит проверка DNS на валидность А-записи. А-запись должна указывать на балансировщик ресурсной платформы. Если указано имя в рамках одного октета, оно будет добавлено в публичную DNS-зону.<br/>Пример значения: строка, допустимые FQDN или имя в одном октете. Пример: example.com или myapp.<br/><br/>### Платформа для развертывания<br/>Описание: кластер Kubernetes, в котором будет развернуто приложение.<br/>Пример значения: идентификатор кластера Kubernetes.<br/><br/>### Квота ядра пода<br/>Описание: количество CPU, выделяемое на под, в Milicores.<br/>Пример значения: целое число, например 500 для 0.5 ядра.<br/><br/>### Квота памяти пода<br/>Описание: количество памяти, выделяемое на под, в Megabytes.<br/>Пример значения: целое число, например 512 для 512 MB.<br/><br/>### Кол-во реплик пода<br/>Описание: количество инстансов пода для масштабирования.<br/>Пример значения: целое число, шт, например 2.<br/><br/>### URL Проекта (gitpath)<br/>Описание: полный HTTPS путь до проекта в Git-репозитории.<br/>Пример значения: URL в формате https://github.com/myuser/myproject.git. Доступ к репозиторию должен быть публичным.<br/><br/>### URL HealthCheck<br/>Описание: путь для проверки здоровья приложения внутри пода.<br/>Пример значения: строка, путь, например /api/v1/health.<br/><br/>### Переменные окружения пода<br/>Описание: структура данных, которая будет передана как переменные окружения в под.<br/>Пример значения: ключ-значение, например {&quot;ENV&quot;: &quot;production&quot;}.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Квота ядра пода: 300m (0.3 ядра)<br/>- Квота памяти пода: 256 MB<br/>- Кол-во реплик пода: 1<br/><br/>### Промышленное окружение<br/>- Квота ядра пода: от 1000m (1 ядро) в зависимости от нагрузки<br/>- Квота памяти пода: от 1024 MB (1 GB) с учетом потребностей приложения<br/>- Кол-во реплик пода: от 2 для обеспечения отказоустойчивости<br/><br/>---<br/><br/>## 4. Выходные параметры<br/>Операция create не возвращает явных выходных параметров. Успешное выполнение операции приводит к развертыванию сервиса, доступного по указанному домену.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>- В корне проекта должен находиться файл requirements.txt со списком зависимостей Python.<br/>- Исходный код веб-приложения должен располагаться в директории site.<br/>- Запуск веб-сервера осуществляется командой python app.py.<br/>- Используется версия Python: python:3.12-slim.<br/>- Git-репозиторий должен быть публично доступен для платформы.<br/>- Операция delete возможна только после suspend.<br/>- Операция modify приводит к переразвертыванию с новыми параметрами.
</div>
+50
View File
@@ -0,0 +1,50 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Copy-ready manifest (`flask_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_flask" "baza" {
resource_realm = "TODO" # Кластер Kubernetes в котором будет развёрнуто приложение
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
domain = "web01" # Если будет указан `FQDN`, то происходят проверки DNS на валидность А-записи. А-запись **обязана смотреть на балансировщик** ресурсной платформы. Если указано имя `в рамках одного октета`, будет добавлено **в публичную днс-зону**
resource_cpu = 300 # Пример: `1000`
resource_memory = 256 # Пример: `2048`
resource_instances = 1 # Пример: `3`
git_path = "https://github.com/Foxyhhd/Baldurs-Gate-test.git" # Пример: `https://github.com/myuser/myproject.git`
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_flask.baza.state_params["имя_ключа"]
nubes_flask.baza.state_out["имя_ключа"]
nubes_flask.baza.state_params_flat["имя_ключа"]
nubes_flask.baza.state_out_flat["имя_ключа"]
nubes_flask.baza.vault_secrets["имя_ключа"]
nubes_flask.baza.vault_url
nubes_flask.baza.vault_user_path
nubes_flask.baza.vault_fields
```
+15
View File
@@ -0,0 +1,15 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](flask_params_create.md)
- `delete` — Удаление возможно только после остановки сервиса через операцию `suspend` После выполнения операции необходимо выждать определенное кол-во времени
- `modify` — Изменение кластера. Параметры: [Modify params](flask_params_modify.md)
- `resume`
- `suspend`
+18
View File
@@ -0,0 +1,18 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Parameters
- [Create params](flask_params_create.md)
- [Modify params](flask_params_modify.md)
+42
View File
@@ -0,0 +1,42 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>249</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>254</td><td><strong><code class="code-no-wrap">json_env</code></strong></td><td><code>map</code></td><td>Структура, которая будет передана как переменные окружения</td><td></td></tr>
<tr><td>255</td><td><strong><code class="code-no-wrap">health_path</code></strong></td><td><code>string</code></td><td>Может быть пустым. Если ничего не передано, проверяется `tcpsocket`<br/>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код</td><td></td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>248</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>web01</code></td><td>Если будет указан `FQDN`, то происходят проверки DNS на валидность А-записи. А-запись **обязана смотреть на балансировщик** ресурсной платформы.<br/>Если указано имя `в рамках одного октета`, будет добавлено **в публичную днс-зону**</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>250</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>300</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=100; maxvalue=8000</td></tr>
<tr><td>251</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>256</code></td><td>Указывается в Megabytes</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>252</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Балансировка производится между всеми репликами</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>253</td><td><strong><code class="code-no-wrap">git_path</code></strong></td><td><code>string</code></td><td><code>https://github.com/Foxyhhd/Baldurs-Gate-test.git</code></td><td>Проект должен быть публичным</td><td></td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+19
View File
@@ -0,0 +1,19 @@
# Resource nubes_flask
Service ID: `89`
Service Name: Web-сервер с фреймворком Flask
[Manual](flask.md) | [Create params](flask_params_create.md) | [Modify params](flask_params_modify.md) | [Output params](flask_outputs.md) | [Operations](flask_ops.md) | [Example](flask_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>451</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=100; maxvalue=8000</td></tr>
<tr><td>452</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Указывается в Megabytes</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>453</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Балансировка производится между всеми репликами</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>454</td><td><strong><code class="code-no-wrap">git_path</code></strong></td><td></td><td>Проект должен быть публичным</td><td></td></tr>
<tr><td>455</td><td><strong><code class="code-no-wrap">json_env</code></strong></td><td><code>map</code></td><td>Структура, которая будет передана как переменные окружения</td><td></td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## MAN
<div class="man-content">
Развертывает сервис контроля версий Gitea<br/>Зависит от сервиса postgresql который должен быть развернут заранее.
</div>
+50
View File
@@ -0,0 +1,50 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Copy-ready manifest (`gitea_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_gitea" "baza" {
psql_uid = "TODO" # UUID Услуги k8sPgsql. Пользователя techGitea, базу данных gitea создаёт автоматически
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
resource_cpu = 500 # Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро
resource_memory = 512 # Квота памяти пода (Указывается в Megabytes)
resource_disk = 1 # Квота диска (Указывается в GIGAbytes)
resource_instances = 1 # Количество узлов
domain = "web01" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_gitea.baza.state_params["имя_ключа"]
nubes_gitea.baza.state_out["имя_ключа"]
nubes_gitea.baza.state_params_flat["имя_ключа"]
nubes_gitea.baza.state_out_flat["имя_ключа"]
nubes_gitea.baza.vault_secrets["имя_ключа"]
nubes_gitea.baza.vault_url
nubes_gitea.baza.vault_user_path
nubes_gitea.baza.vault_fields
```
+15
View File
@@ -0,0 +1,15 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](gitea_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](gitea_params_modify.md)
- `resume`
- `suspend`
+39
View File
@@ -0,0 +1,39 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["connectionUrl"]`
- `state_out_flat["monitoring"]`
- `state_out_flat["monitoring.allDashboards"]`
- `state_out_flat["monitoring.base"]`
- `state_out_flat["monitoring.base.url"]`
- `state_out_flat["monitoring.loki"]`
- `state_out_flat["monitoring.loki.url"]`
### `vault_secrets` ключи
- `vault_secrets["adminPass"]`
- `vault_secrets["adminUser"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Parameters
- [Create params](gitea_params_create.md)
- [Modify params](gitea_params_modify.md)
+40
View File
@@ -0,0 +1,40 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>238</td><td><strong><code class="code-no-wrap">psql_uid</code></strong></td><td><code>uuid</code></td><td>UUID Услуги k8sPgsql. Пользователя techGitea, базу данных gitea создаёт автоматически</td><td>ref_svc_id=90</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>232</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>500</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=300; maxvalue=4000</td></tr>
<tr><td>233</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>234</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>235</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>237</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+18
View File
@@ -0,0 +1,18 @@
# Resource nubes_gitea
Service ID: `99`
Service Name: Gitea
[Manual](gitea.md) | [Create params](gitea_params_create.md) | [Modify params](gitea_params_modify.md) | [Output params](gitea_outputs.md) | [Operations](gitea_ops.md) | [Example](gitea_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>259</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>260</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>261</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>262</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## MAN
<div class="man-content">
Расширенный реестр для управления Docker-образами с enterprise-функциями безопасности, репликации и контроля доступа.<br/>Container Registry позволяет хранить, развертывать и управлять Docker-образами контейнеров в инфраструктуре NGcloud.<br/>Сервис можно использовать в процессе разработки контейнеров. Например, вы можете настроить систему автоматизации на работу с реестром в Container Registry в рамках процесса непрерывной интеграции. Контейнеры идеально подходят для запуска небольших, независимых и легко изменяемых сервисов.<br/>Чтобы начать работу, создайте реестр и загрузите в него Docker-образ<br/>Авторизация: keycloak
</div>
+51
View File
@@ -0,0 +1,51 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Copy-ready manifest (`harbor_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_harbor" "baza" {
resource_realm = "TODO" # Платформа для развертывания
s3_uid = "TODO" # UUID экземпляра услуги S3
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
domain = "web01" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
emails = "testuser1" # Учётная запись, которой будут выданы админские права. Обязана находиться в Keycloak. Можно передавать несколько через пробел
resource_cpu = 100 # Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро
resource_memory = 200 # Квота памяти пода (Указывается в Megabytes)
resource_instances = 1 # Количество узлов
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_harbor.baza.state_params["имя_ключа"]
nubes_harbor.baza.state_out["имя_ключа"]
nubes_harbor.baza.state_params_flat["имя_ключа"]
nubes_harbor.baza.state_out_flat["имя_ключа"]
nubes_harbor.baza.vault_secrets["имя_ключа"]
nubes_harbor.baza.vault_url
nubes_harbor.baza.vault_user_path
nubes_harbor.baza.vault_fields
```
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](harbor_params_create.md)
- `delete` — DEV-Ветка удаления Harbor
+40
View File
@@ -0,0 +1,40 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["connectionUrl"]`
- `state_out_flat["monitoring"]`
- `state_out_flat["monitoring.allDashboards"]`
- `state_out_flat["monitoring.base"]`
- `state_out_flat["monitoring.base.url"]`
- `state_out_flat["monitoring.k8sregistry"]`
- `state_out_flat["monitoring.k8sregistry.url"]`
- `state_out_flat["monitoring.loki"]`
- `state_out_flat["monitoring.loki.url"]`
### `vault_secrets` ключи
- `vault_secrets["adminPass"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Parameters
- [Create params](harbor_params_create.md)
- [Modify params](harbor_params_modify.md)
@@ -0,0 +1,29 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>110</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>231</td><td><strong><code class="code-no-wrap">s3_uid</code></strong></td><td><code>uuid</code></td><td>UUID экземпляра услуги S3</td><td>ref_svc_id=12</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>16</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>17</td><td><strong><code class="code-no-wrap">emails</code></strong></td><td><code>string</code></td><td><code>testuser1</code></td><td>Учётная запись, которой будут выданы админские права. Обязана находиться в Keycloak. Можно передавать несколько через пробел</td><td></td></tr>
<tr><td>228</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>100</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>229</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>200</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>230</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>
@@ -0,0 +1,11 @@
# Resource nubes_harbor
Service ID: `82`
Service Name: Container Registry
[Manual](harbor.md) | [Create params](harbor_params_create.md) | [Modify params](harbor_params_modify.md) | [Output params](harbor_outputs.md) | [Operations](harbor_ops.md) | [Example](harbor_example.md)
## Modify params
None.
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## MAN
<div class="man-content">
Manual not available.
</div>
+51
View File
@@ -0,0 +1,51 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Copy-ready manifest (`http_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_http" "baza" {
resource_realm = "TODO" # Платформа для развертывания
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
domain = "web01" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
resource_cpu = 100 # Квота ядра пода (Указывается в mili)
resource_memory = 200 # Квота памяти пода (Указывается в Megabytes)
resource_instances = 1 # Количество узлов
registry_path = "nexus-sa.tst.nubes.ru/docker-nubes/jolt" # Путь до image, который будет установлен как deployment
json_env = {&quot;param&quot;: &quot;value&quot;} # Массив переменных, будут переданы в env приложения
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_http.baza.state_params["имя_ключа"]
nubes_http.baza.state_out["имя_ключа"]
nubes_http.baza.state_params_flat["имя_ключа"]
nubes_http.baza.state_out_flat["имя_ключа"]
nubes_http.baza.vault_secrets["имя_ключа"]
nubes_http.baza.vault_url
nubes_http.baza.vault_user_path
nubes_http.baza.vault_fields
```
+16
View File
@@ -0,0 +1,16 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](http_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](http_params_modify.md)
- `redeploy`
- `resume`
- `suspend`
+34
View File
@@ -0,0 +1,34 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["connectionUrl"]`
- `state_out_flat["monitoring"]`
- `state_out_flat["monitoring.allDashboards"]`
- `state_out_flat["monitoring.base"]`
- `state_out_flat["monitoring.base.url"]`
- `state_out_flat["monitoring.loki"]`
- `state_out_flat["monitoring.loki.url"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Parameters
- [Create params](http_params_create.md)
- [Modify params](http_params_modify.md)
+41
View File
@@ -0,0 +1,41 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>216</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>212</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>213</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>100</code></td><td>Квота ядра пода (Указывается в mili)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>214</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>200</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>215</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество реплик приложения. Трафик будет распределяться между подами в режиме Round-Robin</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>217</td><td><strong><code class="code-no-wrap">registry_path</code></strong></td><td><code>string</code></td><td><code>nexus-sa.tst.nubes.ru/docker-nubes/jolt</code></td><td>Путь до image, который будет установлен как deployment</td><td></td></tr>
<tr><td>241</td><td><strong><code class="code-no-wrap">json_env</code></strong></td><td><code>json</code></td><td><code>{&amp;quot;param&amp;quot;: &amp;quot;value&amp;quot;}</code></td><td>Массив переменных, будут переданы в env приложения</td><td></td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+17
View File
@@ -0,0 +1,17 @@
# Resource nubes_http
Service ID: `98`
Service Name: Простой HTTP контейнер
[Manual](http.md) | [Create params](http_params_create.md) | [Modify params](http_params_modify.md) | [Output params](http_outputs.md) | [Operations](http_ops.md) | [Example](http_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>218</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td></td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>219</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td></td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>220</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>
+40
View File
@@ -0,0 +1,40 @@
# Ресурсы провайдера
| ID | Ресурс | Описание |
|-----|--------|----------|
| 1 | [nubes_dummy](dummy.md) | Болванка |
| 2 | [nubes_template](template.md) | Темплейт k8s |
| 12 | [nubes_s3](s3.md) | S3 Object Storage |
| 13 | [nubes_s3bucket](s3bucket.md) | S3 бакет |
| 19 | [nubes_vc_org](vc_org.md) | Организация в Cloud Director |
| 21 | [nubes_vc_vdc](vc_vdc.md) | Виртуальный датацентр (vDC) |
| 22 | [nubes_vc_nsxt](vc_nsxt.md) | Сетевой шлюз периметра (Edge) |
| 25 | [nubes_vcexternalip](vcexternalip.md) | Публичные IP адреса |
| 26 | [nubes_vapp](vapp.md) | Виртуальный каталог ВМ (vApp) |
| 28 | [nubes_vc_vm_v3](vc_vm_v3.md) | Виртуальная машина |
| 29 | [nubes_vc_vdc_group](vc_vdc_group.md) | Группа датацентров |
| 50 | [nubes_nextcloud](nextcloud.md) | Nextcloud |
| 81 | [nubes_superset](superset.md) | Apache Superset |
| 82 | [nubes_harbor](harbor.md) | Container Registry |
| 88 | [nubes_k8s_ziti_controller](k8s_ziti_controller.md) | k8sZitiController |
| 89 | [nubes_flask](flask.md) | Web-сервер с фреймворком Flask |
| 90 | [nubes_postgres](postgres.md) | PostgreSQL |
| 91 | [nubes_redis](redis.md) | Redis |
| 92 | [nubes_mongodb](mongodb.md) | MongoDB |
| 93 | [nubes_rabbitmq](rabbitmq.md) | RabbitMQ |
| 94 | [nubes_lucee](lucee.md) | Lucee |
| 95 | [nubes_nodejs](nodejs.md) | NodeJS |
| 96 | [nubes_pgadmin](pgadmin.md) | pgAdmin |
| 97 | [nubes_nodered](nodered.md) | NodeRed |
| 98 | [nubes_http](http.md) | Простой HTTP контейнер |
| 99 | [nubes_gitea](gitea.md) | Gitea |
| 109 | [nubes_zones_v2](zones_v2.md) | Управление днс-зонами и записями |
| 110 | [nubes_dnszone](dnszone.md) | DNS зона |
| 111 | [nubes_dnsrecord](dnsrecord.md) | DNS запись |
| 115 | [nubes_mariadb](mariadb.md) | Mariadb |
| 116 | [nubes_kafka](kafka.md) | ApacheKafka |
| 119 | [nubes_akhq](akhq.md) | Akhq |
| 149 | [nubes_valo_tenant](valo_tenant.md) | VALO Cloud |
| 150 | [nubes_k8s_sthutrval_cluster](k8s_sthutrval_cluster.md) | Kubernetes кластер Штурвал |
| 151 | [nubes_k8s_openbao](k8s_openbao.md) | Vault |
| 153 | [nubes_nifi](nifi.md) | Nifi |
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## MAN
<div class="man-content">
# Инструкция по развертыванию Хранилища секретов через платформу<br/><br/>## 1. Общая информация<br/>Хранилище секретов — сервис централизованного и защищённого хранения чувствительных данных (секретов, ключей, конфигураций). Предназначен для использования приложениями и сервисами в Kubernetes с управлением доступом на основе ролей.<br/>В качестве приложения используется открытый проект OpenBao с поддержкой кластерного режима RAFT.<br/><br/>### Доступные операции<br/>**create** — Создание хранилища секретов и инициализация кластера.<br/>**delete** — Удаление хранилища секретов с полной очисткой всех связанных сущностей.<br/>**modify** — Изменение параметров развернутого хранилища секретов.<br/>**suspend** — Приостановка работы кластера без удаления Persistent Volume.<br/>**resume** — Возобновление работы кластера с автоматическим unseal всех нод.<br/>**restart** — Поочередный перезапуск нод с последующим подключением в кластер.<br/>**create_kv** — Создание Key/Value хранилища версии V2.<br/>**delete_kv** — Удаление Key/Value хранилища со всеми содержащимися секретами.<br/>**create_secrets** — Создание секрета внутри Key/Value хранилища.<br/>**delete_secrets** — Удаление секрета из Key/Value хранилища.<br/>**update_secrets** — Обновление значения секрета.<br/>**recovery_secrets** — Откат секрета к указанной версии.<br/>**create_role** — Создание роли для управления Key/Value хранилищем или секретами.<br/>**update_role** — Обновление параметров роли.<br/>**delete_role** — Удаление роли доступа.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: Кластер Kubernetes, в котором будет развернуто приложение.<br/>Формат значения: имя Kubernetes-кластера.<br/><br/>### Имя домена<br/>Описание: Доменное имя сервиса. При указании полного FQDN выполняется проверка DNS A-записи или добавляется А-запись в техническую зону.<br/>Формат значения: secrets.domain.com / mysecretdomain.<br/><br/>### Кол-во реплик<br/>Описание: Количество узлов в кластере.<br/>Формат значения: целое число.<br/><br/>### Квота ядра пода<br/>Описание: Лимит CPU для одного узла. Указывается в milicores (1000 milicores = 1 CPU).<br/>Формат значения: целое число.<br/><br/>### Квота памяти пода<br/>Описание: Лимит оперативной памяти для одного узла. Указывается в megabytes.<br/>Формат значения: целое число.<br/><br/>### Размер диска под хранение секретов<br/>Описание: Объем диска для хранения данных. Фактический объем равен значению, умноженному на количество реплик. Указывается в Gigabytes<br/>Формат значения: целое число.<br/><br/>### Версия OpenBao<br/>Описание: Версия OpenBao для развертывания сервиса.<br/>Формат значения: выбор из предоставленного списка версий.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>Кол-во реплик: 2.<br/>Квота ядра пода: 200.<br/>Квота памяти пода: 256.<br/>Размер диска под хранение секретов: 1.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>### Промышленное окружение<br/>Кол-во реплик: от 3.<br/>Квота ядра пода: от 1000.<br/>Квота памяти пода: от 1024.<br/>Размер диска под хранение секретов: от 10.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>---<br/><br/>## 4. Выходные параметры<br/>Настройки внутри хранилища (kv/secrets/roles) — конфигурации Key/Value, секретов и ролей, созданные соответствующими операциями.<br/>Настройки самого хранилище (сайзинг, объемы) — параметры ресурсов и хранилища данных, примененные к сервису.<br/>Статус кластера (running / suspended) — текущее состояние работы кластера.<br/>url для подключения к веб — адрес веб-интерфейса сервиса.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>При удалении хранилища все данные и настройки безвозвратно удаляются.<br/>При использовании доменного имени требуется корректная настройка DNS.<br/>Операции управления секретами и ролями выполняются только после успешного создания хранилища.<br/>Удаление кластера производится через операцию `suspend`, а удаление становится доступно через 14 дней после остановки кластера<br/>Правило выше не относится к операции `delete_kv` / `delete_secrets` / `delete_role`
</div>
+51
View File
@@ -0,0 +1,51 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Copy-ready manifest (`k8s_openbao_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_k8s_openbao" "baza" {
resource_realm = "TODO" # Кластер Kubernetes в котором будет развёрнуто приложение
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
resource_cpu = 500 # Пример: `500`
resource_instances = 3 # Пример: `3`
resource_memory = 512 # Пример: `2048`
resource_disk = 10 # Пример: `10`
app_version = 2.4.4 # Выбрать из списка
domain = "bao-" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_k8s_openbao.baza.state_params["имя_ключа"]
nubes_k8s_openbao.baza.state_out["имя_ключа"]
nubes_k8s_openbao.baza.state_params_flat["имя_ключа"]
nubes_k8s_openbao.baza.state_out_flat["имя_ключа"]
nubes_k8s_openbao.baza.vault_secrets["имя_ключа"]
nubes_k8s_openbao.baza.vault_url
nubes_k8s_openbao.baza.vault_user_path
nubes_k8s_openbao.baza.vault_fields
```
+26
View File
@@ -0,0 +1,26 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](k8s_openbao_params_create.md)
- `create_kv` — Создание кластера. Параметры: [Create params](k8s_openbao_params_create.md)
- `create_policy` — Создание кластера. Параметры: [Create params](k8s_openbao_params_create.md)
- `create_secrets` — Создание кластера. Параметры: [Create params](k8s_openbao_params_create.md)
- `delete`
- `delete_kv`**ОСТОРОЖНО** Удаление KV подразумевает удаление ВСЕХ secrets внутри этой KV
- `delete_policy`
- `delete_secrets`
- `modify` — Изменение кластера. Параметры: [Modify params](k8s_openbao_params_modify.md)
- `reconcile`
- `recovery_secrets` — Данная операция подразумевает откат на конкретную версию в секрете. **Это не восстановление удалённого секрета**
- `restart`
- `resume`
- `suspend`
- `update_policy`
- `update_secrets`
+18
View File
@@ -0,0 +1,18 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Parameters
- [Create params](k8s_openbao_params_create.md)
- [Modify params](k8s_openbao_params_modify.md)
@@ -0,0 +1,41 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>663</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>664</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>500</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=250; maxvalue=8000</td></tr>
<tr><td>665</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>3</code></td><td>Пример: `3`</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>666</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Указывается в Megabytes</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>667</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td><code>10</code></td><td>Указывается в Gigabytes</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>668</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td><code>2.4.4</code></td><td>Выбрать из списка</td><td>value_list=2.4.4</td></tr>
<tr><td>669</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>bao-</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
@@ -0,0 +1,19 @@
# Resource nubes_k8s_openbao
Service ID: `151`
Service Name: Vault
[Manual](k8s_openbao.md) | [Create params](k8s_openbao_params_create.md) | [Modify params](k8s_openbao_params_modify.md) | [Output params](k8s_openbao_outputs.md) | [Operations](k8s_openbao_ops.md) | [Example](k8s_openbao_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>670</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Пример: `3`</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>671</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=250; maxvalue=8000</td></tr>
<tr><td>672</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Указывается в Megabytes</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>673</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td>Указывается в Gigabytes</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>674</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td>Выбрать из списка</td><td>value_list=2.4.4</td></tr>
</tbody></table>
@@ -0,0 +1,13 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## MAN
<div class="man-content">
Перед разворачиванием убедиться, что в облаке есть 2 свободных невыделенных IP в пуле
</div>
@@ -0,0 +1,49 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Copy-ready manifest (`k8s_sthutrval_cluster_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_k8s_sthutrval_cluster" "baza" {
startup_configuration = "TODO"
control_plane_configuration = "TODO"
access_configuration = "TODO"
cluster_configuration = "TODO"
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
worker_configuration = [{}]
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_k8s_sthutrval_cluster.baza.state_params["имя_ключа"]
nubes_k8s_sthutrval_cluster.baza.state_out["имя_ключа"]
nubes_k8s_sthutrval_cluster.baza.state_params_flat["имя_ключа"]
nubes_k8s_sthutrval_cluster.baza.state_out_flat["имя_ключа"]
nubes_k8s_sthutrval_cluster.baza.vault_secrets["имя_ключа"]
nubes_k8s_sthutrval_cluster.baza.vault_url
nubes_k8s_sthutrval_cluster.baza.vault_user_path
nubes_k8s_sthutrval_cluster.baza.vault_fields
```
@@ -0,0 +1,17 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](k8s_sthutrval_cluster_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](k8s_sthutrval_cluster_params_modify.md)
- `reconcile`
- `resume`
- `suspend`
- `update_secrets`
@@ -0,0 +1,33 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["ingressAddress"]`
- `state_out_flat["kubernetesApiAddress"]`
### `vault_secrets` ключи
- `vault_secrets["kubernetesAdminConfigB64"]`
@@ -0,0 +1,12 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Parameters
- [Create params](k8s_sthutrval_cluster_params_create.md)
- [Modify params](k8s_sthutrval_cluster_params_modify.md)
@@ -0,0 +1,39 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>750</td><td><strong><code class="code-no-wrap">startup_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
<tr><td>751</td><td><strong><code class="code-no-wrap">control_plane_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
<tr><td>753</td><td><strong><code class="code-no-wrap">access_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
<tr><td>755</td><td><strong><code class="code-no-wrap">cluster_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>752</td><td><strong><code class="code-no-wrap">worker_configuration</code></strong></td><td><code>array-map-fixed</code></td><td><code>[{}]</code></td><td></td><td></td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
@@ -0,0 +1,18 @@
# Resource nubes_k8s_sthutrval_cluster
Service ID: `150`
Service Name: Kubernetes кластер Штурвал
[Manual](k8s_sthutrval_cluster.md) | [Create params](k8s_sthutrval_cluster_params_create.md) | [Modify params](k8s_sthutrval_cluster_params_modify.md) | [Output params](k8s_sthutrval_cluster_outputs.md) | [Operations](k8s_sthutrval_cluster_ops.md) | [Example](k8s_sthutrval_cluster_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>756</td><td><strong><code class="code-no-wrap">cluster_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
<tr><td>757</td><td><strong><code class="code-no-wrap">control_plane_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
<tr><td>758</td><td><strong><code class="code-no-wrap">worker_configuration</code></strong></td><td><code>array-map-fixed</code></td><td></td><td></td></tr>
<tr><td>759</td><td><strong><code class="code-no-wrap">access_configuration</code></strong></td><td><code>map-fixed</code></td><td></td><td></td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## MAN
<div class="man-content">
Manual not available.
</div>
@@ -0,0 +1,50 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Copy-ready manifest (`k8s_ziti_controller_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_k8s_ziti_controller" "baza" {
resource_realm = "TODO" # Платформа для развертывания
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
resource_cpu = 300 # Квота ядра пода (milicores)
resource_memory = 512 # Квота памяти пода (MBytes)
resource_disk = 1 # Квота диска (Указывается в GIGAbytes)
resource_instances = 1 # Количество узлов
domain = "web01" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_k8s_ziti_controller.baza.state_params["имя_ключа"]
nubes_k8s_ziti_controller.baza.state_out["имя_ключа"]
nubes_k8s_ziti_controller.baza.state_params_flat["имя_ключа"]
nubes_k8s_ziti_controller.baza.state_out_flat["имя_ключа"]
nubes_k8s_ziti_controller.baza.vault_secrets["имя_ключа"]
nubes_k8s_ziti_controller.baza.vault_url
nubes_k8s_ziti_controller.baza.vault_user_path
nubes_k8s_ziti_controller.baza.vault_fields
```
@@ -0,0 +1,12 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](k8s_ziti_controller_params_create.md)
- `delete`
@@ -0,0 +1,18 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
@@ -0,0 +1,12 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Parameters
- [Create params](k8s_ziti_controller_params_create.md)
- [Modify params](k8s_ziti_controller_params_modify.md)
@@ -0,0 +1,28 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>298</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>294</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>300</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>295</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>296</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>297</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>299</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
</tbody></table>
@@ -0,0 +1,11 @@
# Resource nubes_k8s_ziti_controller
Service ID: `88`
Service Name: k8sZitiController
[Manual](k8s_ziti_controller.md) | [Create params](k8s_ziti_controller_params_create.md) | [Modify params](k8s_ziti_controller_params_modify.md) | [Output params](k8s_ziti_controller_outputs.md) | [Operations](k8s_ziti_controller_ops.md) | [Example](k8s_ziti_controller_example.md)
## Modify params
None.
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## MAN
<div class="man-content">
# Инструкция по развертыванию Организация в Cloud Director через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Организация в Cloud Director** предназначен для управления изолированными организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой организации с заданными характеристиками и типом доступа.<br/>**delete** — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей.<br/>**modify** — Изменение параметров внутри организации (на текущий момент поддерживается изменение ipSpaces).<br/>**suspend** — Заморозка организации, ограничение возможности изменения и добавления сущностей.<br/>**resume** — Разморозка организации, восстановление функций управления.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: платформа, на которой будет создана организация.<br/>Пример значения: `ngcloud.ru`.<br/><br/>### Тип организации<br/>Описание: тип создаваемой организации.<br/>Варианты:<br/>- `iaas` — организация с прямым доступом к облаку и авторизацией через Keycloak.<br/>- `saas` — организация под управлением Nubes, без прямого доступа к облаку.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Тип организации: `iaas` для обеспечения полного доступа к облачным ресурсам и самостоятельного управления.<br/><br/>### Промышленное окружение<br/>- Тип организации: `saas` (упрощённая модель использования).<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Услуга предоставляет следующие выходные параметры (формируются в процессе операций):<br/><br/>### Идентификатор организации<br/>Уникальный идентификатор созданной организации. Используется для всех дальнейших API-операций.<br/><br/>### Статус организации<br/>Отражает текущее состояние: active, suspended, modifying, deleting.<br/><br/>### Параметры сети<br/>Выходные данные при наличии ipSpaces: список выделенных внешних IP, имя ip_space, количество IP.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- Для конфигурации внешних IP внутри организации необходимо предварительно создать:<br/>-- хотя бы один **Виртуальный датацентр (VDC)**;<br/>-- хотя бы один **Сетевой шлюз периметра (Edge Gateway)**, привязанный к этой организации.<br/>- Удаление организации возможно только через 14 дней после перевода в состояние suspend.<br/>- Удаление организации приводит к удалению всех связанных сущностей: VDC, Edge Gateway, пулов IP, сетей, ВМок и иных объектов.<br/>- Операция suspend не останавливает виртуальные машины, но блокирует любые изменения инфраструктуры внутри организации.<br/>- Для iaas-организаций доступ осуществляется через Keycloak.<br/><br/>
</div>
+50
View File
@@ -0,0 +1,50 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Copy-ready manifest (`kafka_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_kafka" "baza" {
resource_instances = 1 # Пример: `2`
resource_memory = 1 # Пример: `2048`
resource_cpu = 1 # Пример: `2000`
resource_disk = 1 # Пример: `20`
resource_realm = "TODO" # Выбрать платформу из списка
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
need_external_address_master = false # Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_kafka.baza.state_params["имя_ключа"]
nubes_kafka.baza.state_out["имя_ключа"]
nubes_kafka.baza.state_params_flat["имя_ключа"]
nubes_kafka.baza.state_out_flat["имя_ключа"]
nubes_kafka.baza.vault_secrets["имя_ключа"]
nubes_kafka.baza.vault_url
nubes_kafka.baza.vault_user_path
nubes_kafka.baza.vault_fields
```
+21
View File
@@ -0,0 +1,21 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](kafka_params_create.md)
- `create_topic` — Создание кластера. Параметры: [Create params](kafka_params_create.md)
- `create_user` — Создание кластера. Параметры: [Create params](kafka_params_create.md)
- `delete`
- `delete_topic`
- `delete_user` — # Инструкция по управлению пользователями Apache Kafka. --- ## 1. Общая информация Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру. Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам. Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka. --- ## Доступные операции - **create_user** — Создание пользователя - **modify_user** — Модификация пользователя - **delete_user** — Удаление пользователя --- ## 2. Параметры создания пользователя Ниже перечислены параметры, которые необходимо указать при создании нового пользователя: * **Имя пользователя** Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: `username-admin` * **Топик** Название топика, к которому будут назначены права для данного пользователя. Пример: `orders-events`. Использовать маску нельзя (`orders*`), только полное название или `*`. * **Операции** Список разрешённых операций на указанном топике. Пример: `Describe, Read, Write` * **Группа** Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: `order-consumers`. * **Разрешённые хосты** Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: `192.168.1.0/24` или `*`. --- ## 3. Параметры модификации пользователя Ниже перечислены параметры, которые необходимо указать при модификации пользователя: * **Имя пользователя** Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: `username-admin` * **Топик** Название топика, к которому будут назначены права для данного пользователя. Пример: `orders-events`. Использовать маску нельзя (`orders*`), только полное название или `*`. * **Операции** Список разрешённых операций на указанном топике. Пример: `Describe, Read, Write` * **Группа** Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: `order-consumers`. * **Разрешённые хосты** Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: `192.168.1.0/24` или `*`. --- ## 4. Параметры удалении пользователя Ниже перечислены параметры, которые необходимо указать при удалении пользователя: * **Имя пользователя** Имя удаляемого пользователя. Пример: `username-admin` ## 5. Выходные параметры После успешного создания пользователя платформа возвращает параметры, необходимые для подключения: * **ca.crt** Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении. Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>' | base64 -d > <название>.crt ``` * **ca.p12** PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>' | base64 -d > <название>.p12 ``` * **ca.password** Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно. * **user.crt** Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka. Используется совместно с приватным ключом `user.key` для аутентификации. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>' | base64 -d > <название>.crt ``` * **user.key** Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>' | base64 -d > <название>.key ``` * **user.p12** PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo "<содержание поля>" | base64 -d > <название>.p12 ``` * **user.password** Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно. Эти параметры используются для настройки TLS-подключения. --- ## 6. Пример конфигурации клиента внутри кластера Пример пода: ```yaml apiVersion: v1 kind: Pod metadata: name: kafka-4 spec: volumes: - name: work emptyDir: {} containers: - name: kcat image: quay.io/strimzi/kafka:latest-kafka-4.0.0 command: ["sleep", "5600"] volumeMounts: - name: work mountPath: /work restartPolicy: Never ``` Создаём под и сохраняем сертификаты: ```bash kubectl cp user.p12 kafka-4:/work/ kubectl cp ca.p12 kafka-4:/work/ ``` Создаём файлы конфигурации: ```bash cat > /work/user-read.properties <<'EOF' security.protocol=SSL ssl.keystore.type=PKCS12 ssl.keystore.location=/work/user.p12 ssl.keystore.password=<user.password> ssl.truststore.type=PKCS12 ssl.truststore.location=/work/ca.p12 ssl.truststore.password=<ca.password> EOF ``` ```bash cat > /work/user-write.properties <<'EOF' security.protocol=SSL ssl.keystore.type=PKCS12 ssl.keystore.location=/work/user-write.p12 ssl.keystore.password=<user.password> ssl.truststore.type=PKCS12 ssl.truststore.location=/work/ca.p12 ssl.truststore.password=<ca.password> EOF ``` Листинг доступных топиков: ```bash /opt/kafka/bin/kafka-topics.sh \ --bootstrap-server kafkak8s-bootstrap-external:9093 \ --command-config /work/user-read.properties \ --list ``` Запись сообщений: ```bash /opt/kafka/bin/kafka-console-producer.sh \ --bootstrap-server <адрес сервис брокера>:9093 \ --topic <topic> \ --producer.config /work/user-write.properties ``` Чтение сообщений: ```bash /opt/kafka/bin/kafka-console-consumer.sh \ --bootstrap-server <адрес сервис брокера>:9093 \ --topic <topic> \ --from-beginning \ --group <group> \ --consumer.config /work/user-read.properties \ --max-messages 50 ``` --- ## 7. Пример внешнего подключения с использованием **kcat** **Листинг топиков** ```bash kcat -b <externalConnect.bootstrap.fqdn>:9093 \ -L \ -X security.protocol=SSL \ -X ssl.ca.location=./ca.crt \ -X ssl.certificate.location=./user-read.crt \ -X ssl.key.location=./user-read.key \ -X ssl.endpoint.identification.algorithm=none ``` **Запись сообщения** ```bash echo "hello from kcat" | kcat -P \ -b <externalConnect.bootstrap.fqdn>:9093 \ -t write-test \ -X security.protocol=SSL \ -X ssl.ca.location=./ca.crt \ -X ssl.certificate.location=./user-write.crt \ -X ssl.key.location=./user-write.key \ -X ssl.endpoint.identification.algorithm=none ``` **Чтение сообщений** ```bash kcat -C \ -b <externalConnect.bootstrap.fqdn>:9093 \ -t write-test \ -o beginning \ -q \ -X security.protocol=SSL \ -X ssl.ca.location=./ca.crt \ -X ssl.certificate.location=./user-read.crt \ -X ssl.key.location=./user-read.key \ -X ssl.endpoint.identification.algorithm=none ``` --- ## 9. Рекомендации * Минимизируйте набор разрешённых операций для повышения безопасности. * Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов. * Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**. * После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам. ---
- `modify` — Изменение кластера. Параметры: [Modify params](kafka_params_modify.md)
- `modify_topic` — Изменение кластера. Параметры: [Modify params](kafka_params_modify.md)
- `modify_user` — Изменение кластера. Параметры: [Modify params](kafka_params_modify.md)
- `resume`
- `suspend`
+54
View File
@@ -0,0 +1,54 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["externalConnect"]`
- `state_out_flat["externalConnect.bootstrap"]`
- `state_out_flat["externalConnect.bootstrap.fqdn"]`
- `state_out_flat["externalConnect.bootstrap.ip"]`
- `state_out_flat["externalConnect.bootstrap.isExternal"]`
- `state_out_flat["externalConnect.bootstrap.uuid"]`
- `state_out_flat["internalConnect"]`
- `state_out_flat["kafkaTopics"]`
- `state_out_flat["kafkaTopics.test-events"]`
- `state_out_flat["kafkaTopics.test-events.partitions"]`
- `state_out_flat["kafkaTopics.test-events.replicas"]`
- `state_out_flat["kafkaUsers"]`
- `state_out_flat["kafkaUsers.usertest"]`
- `state_out_flat["kafkaUsers.usertest.accessHosts"]`
- `state_out_flat["kafkaUsers.usertest.group"]`
- `state_out_flat["kafkaUsers.usertest.nameTopic"]`
- `state_out_flat["kafkaUsers.usertest.operations"]`
- `state_out_flat["monitoring"]`
- `state_out_flat["monitoring.allDashboards"]`
- `state_out_flat["monitoring.base"]`
- `state_out_flat["monitoring.base.url"]`
- `state_out_flat["monitoring.loki"]`
- `state_out_flat["monitoring.loki.url"]`
### `vault_secrets` ключи
- `vault_secrets["users"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Parameters
- [Create params](kafka_params_create.md)
- [Modify params](kafka_params_modify.md)
+41
View File
@@ -0,0 +1,41 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>461</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Пример: `2`</td><td>minvalue=1; value_list=1, 2, 3, 4, 5</td></tr>
<tr><td>462</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Пример: `2048`</td><td>minvalue=1000</td></tr>
<tr><td>463</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Пример: `2000`</td><td>minvalue=1000</td></tr>
<tr><td>464</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td>Пример: `20`</td><td></td></tr>
<tr><td>466</td><td><strong><code class="code-no-wrap">ip_space_name_master</code></strong></td><td><code>string</code></td><td>Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>469</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>465</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+20
View File
@@ -0,0 +1,20 @@
# Resource nubes_kafka
Service ID: `116`
Service Name: ApacheKafka
[Manual](kafka.md) | [Create params](kafka_params_create.md) | [Modify params](kafka_params_modify.md) | [Output params](kafka_outputs.md) | [Operations](kafka_ops.md) | [Example](kafka_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>501</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Пример: `2`</td><td>value_list=1, 2, 3, 4, 5</td></tr>
<tr><td>502</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Пример: `2048`</td><td>minvalue=1000</td></tr>
<tr><td>503</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td></td><td>Пример: `2000`</td><td>minvalue=1000</td></tr>
<tr><td>504</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td>Пример: `20`</td><td></td></tr>
<tr><td>505</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
<tr><td>506</td><td><strong><code class="code-no-wrap">ip_space_name_master</code></strong></td><td><code>string</code></td><td>Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## MAN
<div class="man-content">
Manual not available.
</div>
+52
View File
@@ -0,0 +1,52 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Copy-ready manifest (`lucee_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_lucee" "baza" {
resource_realm = "TODO" # Платформа для развертывания
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
domain = "lucee-" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
git_path = "https://github.com/xahys/testlucee" # Путь до Git, который будет webroot для сайта
json_env = { "param": "value" } # Здесь вы можете задать переменные среды в формате KEY=VALUE. Они будут доступны внутри вашего приложения.
resource_cpu = 300 # Квота ядра пода (milicores)
resource_memory = 512 # Квота памяти пода (MBytes)
resource_instances = 1 # Количество узлов
app_version = 5.4 # Версия Lucee
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_lucee.baza.state_params["имя_ключа"]
nubes_lucee.baza.state_out["имя_ключа"]
nubes_lucee.baza.state_params_flat["имя_ключа"]
nubes_lucee.baza.state_out_flat["имя_ключа"]
nubes_lucee.baza.vault_secrets["имя_ключа"]
nubes_lucee.baza.vault_url
nubes_lucee.baza.vault_user_path
nubes_lucee.baza.vault_fields
```
+17
View File
@@ -0,0 +1,17 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](lucee_params_create.md)
- `delete`
- `modify` — Изменение кластера. Параметры: [Modify params](lucee_params_modify.md)
- `redeploy`
- `restart`
- `resume`
- `suspend`
+34
View File
@@ -0,0 +1,34 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
## Реальные поля из облака (running/suspended snapshot)
Поля ниже получены из реальных инстансов этого сервиса в облаке.
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
### `state_out_flat` ключи
- `state_out_flat["connectionUrl"]`
- `state_out_flat["monitoring"]`
- `state_out_flat["monitoring.allDashboards"]`
- `state_out_flat["monitoring.base"]`
- `state_out_flat["monitoring.base.url"]`
- `state_out_flat["monitoring.loki"]`
- `state_out_flat["monitoring.loki.url"]`
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Parameters
- [Create params](lucee_params_create.md)
- [Modify params](lucee_params_modify.md)
+43
View File
@@ -0,0 +1,43 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>108</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>132</td><td><strong><code class="code-no-wrap">health_path</code></strong></td><td><code>string</code></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код</td><td></td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>103</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td><code>lucee-</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>104</td><td><strong><code class="code-no-wrap">git_path</code></strong></td><td><code>string</code></td><td><code>https://github.com/xahys/testlucee</code></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>105</td><td><strong><code class="code-no-wrap">json_env</code></strong></td><td><code>json</code></td><td><code>{ &#34;param&#34;: &#34;value&#34; }</code></td><td>Здесь вы можете задать переменные среды в формате KEY=VALUE. Они будут доступны внутри вашего приложения.</td><td>maxlength=2048</td></tr>
<tr><td>106</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>300</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>107</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>139</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>263</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td><code>5.4</code></td><td>Версия Lucee</td><td>regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0</td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
+21
View File
@@ -0,0 +1,21 @@
# Resource nubes_lucee
Service ID: `94`
Service Name: Lucee
[Manual](lucee.md) | [Create params](lucee_params_create.md) | [Modify params](lucee_params_modify.md) | [Output params](lucee_outputs.md) | [Operations](lucee_ops.md) | [Example](lucee_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>133</td><td><strong><code class="code-no-wrap">git_path</code></strong></td><td><code>string</code></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>134</td><td><strong><code class="code-no-wrap">health_path</code></strong></td><td><code>string</code></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код.</td><td></td></tr>
<tr><td>135</td><td><strong><code class="code-no-wrap">json_env</code></strong></td><td><code>json</code></td><td>Массив переменных, будут переданы в env приложения</td><td>maxlength=2048</td></tr>
<tr><td>136</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Квота ядра пода (Указывается в mili)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>137</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>138</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>264</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td></td><td>regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0</td></tr>
</tbody></table>
+13
View File
@@ -0,0 +1,13 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## MAN
<div class="man-content">
Mariadb кластер. Ресурсная платформа: k8s. Автоматизация: k8s operator.<br/>Автоматическое резервное копирование, ручное восстановление.
</div>
+57
View File
@@ -0,0 +1,57 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Copy-ready manifest (`mariadb_main.tf`)
```hcl
terraform {
required_providers {
nubes = {
source = "terra.k8c.ru/nubes/nubes"
version = "5.0.39"
}
}
}
# Токен доступа api_token к Nubes API — замените на реальный.
provider "nubes" {
api_token = "token_***"
api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
}
resource "nubes_mariadb" "baza" {
resource_realm = "TODO" # Платформа для развертывания
s3_uid = "TODO" # Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
resource_cpu = 500 # Квота ядра пода (milicores)
resource_memory = 1024 # Квота памяти пода (MBytes)
resource_disk = 1 # Квота диска (Указывается в GIGAbytes)
resource_instances = 1 # Количество узлов
need_external_address_master = false # Выделяет внешний (белый) IP для доступа к master
ext_backup_schedule = "0 * * * *" # Не обязательный. Время запуска бекапа
app_version = 9.4.0 # Версия MySQL
auto_scale = false # Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги
auto_scale_percentage = 10 # Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема
auto_scale_tech_window = 0 # Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)
auto_scale_quota_gb = 1 # Квота для autoScale
}
```
## Outputs usage
```hcl
# Выходные параметры можно использовать как
nubes_mariadb.baza.state_params["имя_ключа"]
nubes_mariadb.baza.state_out["имя_ключа"]
nubes_mariadb.baza.state_params_flat["имя_ключа"]
nubes_mariadb.baza.state_out_flat["имя_ключа"]
nubes_mariadb.baza.vault_secrets["имя_ключа"]
nubes_mariadb.baza.vault_url
nubes_mariadb.baza.vault_user_path
nubes_mariadb.baza.vault_fields
```
+19
View File
@@ -0,0 +1,19 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Operations
- `create` — Создание кластера. Параметры: [Create params](mariadb_params_create.md)
- `create_database` — Создание кластера. Параметры: [Create params](mariadb_params_create.md)
- `create_user` — Создание кластера. Параметры: [Create params](mariadb_params_create.md)
- `delete`
- `delete_database`
- `delete_user`
- `modify` — Изменение кластера. Параметры: [Modify params](mariadb_params_modify.md)
- `resume`
- `suspend`
+18
View File
@@ -0,0 +1,18 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Output params
- `state_params` (map) — параметры, отправленные в API при создании/изменении
- `state_out` (map) — ответ API с результатами/выходными значениями
- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
- `vault_url` (string) — адрес Vault для ресурса
- `vault_user_path` (string) — путь пользователя в Vault
- `vault_fields` (list) — список ключей доступных секретов
+12
View File
@@ -0,0 +1,12 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Parameters
- [Create params](mariadb_params_create.md)
- [Modify params](mariadb_params_modify.md)
@@ -0,0 +1,48 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Create params
**Обязательные параметры (вводимые пользователем)**
<table class="resource-table resource-table-compact resource-table-required">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>422</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>429</td><td><strong><code class="code-no-wrap">ip_space_name_master</code></strong></td><td><code>string</code></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster</td><td></td></tr>
<tr><td>459</td><td><strong><code class="code-no-wrap">s3_uid</code></strong></td><td><code>uuid</code></td><td>Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно</td><td>ref_svc_id=12</td></tr>
</tbody></table>
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>424</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>500</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>425</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>1024</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=1024; maxvalue=8192</td></tr>
<tr><td>426</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>427</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>428</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>430</td><td><strong><code class="code-no-wrap">ext_backup_schedule</code></strong></td><td><code>string</code></td><td><code>0 * * * *</code></td><td>Не обязательный. Время запуска бекапа</td><td>regex=^(\*|(\d+|\*\/\d+|\d+(,\d+)*))\s\*\s\*\s\*\s\*$</td></tr>
<tr><td>431</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td><code>9.4.0</code></td><td>Версия MySQL</td><td>value_list=8.4.0, 9.4.0</td></tr>
<tr><td>432</td><td><strong><code class="code-no-wrap">auto_scale</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги</td><td>value_list=false, true</td></tr>
<tr><td>433</td><td><strong><code class="code-no-wrap">auto_scale_percentage</code></strong></td><td><code>integer</code></td><td><code>10</code></td><td>Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема</td><td>value_list=10, 15, 20</td></tr>
<tr><td>434</td><td><strong><code class="code-no-wrap">auto_scale_tech_window</code></strong></td><td><code>integer</code></td><td><code>0</code></td><td>Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)</td><td>value_list=0, 5, 12, 23</td></tr>
<tr><td>435</td><td><strong><code class="code-no-wrap">auto_scale_quota_gb</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Квота для autoScale</td><td></td></tr>
</tbody></table>
<div class="lifecycle-note">
<strong>Параметры поведения (кратко)</strong><br/>
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.<br/>
При `terraform destroy` или удалении ресурса из манифеста:<br/>
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).<br/>
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.<br/>
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:<br/>
- `false` — если ресурс уже есть, будет ошибка.<br/>
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).<br/>
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.
</div>
@@ -0,0 +1,25 @@
# Resource nubes_mariadb
Service ID: `115`
Service Name: Mariadb
[Manual](mariadb.md) | [Create params](mariadb_params_create.md) | [Modify params](mariadb_params_modify.md) | [Output params](mariadb_outputs.md) | [Operations](mariadb_ops.md) | [Example](mariadb_example.md)
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>436</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>437</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>438</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>439</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>440</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td></td><td>value_list=false, true</td></tr>
<tr><td>441</td><td><strong><code class="code-no-wrap">ip_space_name_master</code></strong></td><td></td><td></td><td></td></tr>
<tr><td>442</td><td><strong><code class="code-no-wrap">ext_backup_schedule</code></strong></td><td><code>string</code></td><td></td><td></td></tr>
<tr><td>443</td><td><strong><code class="code-no-wrap">auto_scale</code></strong></td><td><code>boolean</code></td><td></td><td>value_list=false, true</td></tr>
<tr><td>444</td><td><strong><code class="code-no-wrap">auto_scale_percentage</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>445</td><td><strong><code class="code-no-wrap">auto_scale_tech_window</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
<tr><td>446</td><td><strong><code class="code-no-wrap">auto_scale_quota_gb</code></strong></td><td><code>integer</code></td><td></td><td></td></tr>
</tbody></table>

Some files were not shown because too many files have changed in this diff Show More