chore: удалить 934 сгенерированных .md из git (docs/30_registry/resources/)
This commit is contained in:
Naeel
@@ -106,3 +106,4 @@ terraform-provider-mycloud
|
||||
artifacts/api-meta/*/errors.log
|
||||
TOOLS/bin/
|
||||
TOOLS/docs-generator/bin/
|
||||
docs/30_registry/resources/
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
# Resource nubes_Akhq
|
||||
|
||||
Service ID: `119`
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_akhq" "example" {
|
||||
# required params ...
|
||||
suspend_on_destroy = "suspend"
|
||||
adopt_existing_on_create = true
|
||||
}
|
||||
```
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для Akhq
|
||||
|
||||
# Инструкция по развертыванию 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/>---
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_Akhq
|
||||
|
||||
Service ID: `119`
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_Akhq
|
||||
|
||||
Service ID: `119`
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
|
||||
[Overview](Akhq.md) | [Parameters](Akhq_params.md) | [Operations](Akhq_ops.md)
|
||||
@@ -1,27 +0,0 @@
|
||||
# Resource nubes_DEPRECATED
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```text
|
||||
resource "nubes_DEPRECATED" "example" {
|
||||
# required params ...
|
||||
delete_mode = "state_only"
|
||||
resume_if_exists = true
|
||||
}
|
||||
```
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для DEPRECATED
|
||||
|
||||
Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_DEPRECATED
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_DEPRECATED
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
|
||||
[Overview](DEPRECATED.md) | [Parameters](DEPRECATED_params.md) | [Operations](DEPRECATED_ops.md)
|
||||
@@ -1,27 +0,0 @@
|
||||
# Resource nubes_GiteaComplex
|
||||
|
||||
Service ID: `114`
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_gitea_complex" "example" {
|
||||
# required params ...
|
||||
suspend_on_destroy = "state_only"
|
||||
adopt_existing_on_create = true
|
||||
}
|
||||
```
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для GiteaComplex
|
||||
|
||||
Комплексная услуга из ["gittea", "postgres"]
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_GiteaComplex
|
||||
|
||||
Service ID: `114`
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_GiteaComplex
|
||||
|
||||
Service ID: `114`
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
|
||||
[Overview](GiteaComplex.md) | [Parameters](GiteaComplex_params.md) | [Operations](GiteaComplex_ops.md)
|
||||
@@ -1,92 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
## MAN
|
||||
|
||||
<div class="man-content">
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (<code class="man-inline">https://github.com/Altinity/clickhouse-operator</code>) в ресурсной платформе типа <code class="man-inline">k8s</code><br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра <code class="man-inline">Создать ClickHouse-Keeper</code>.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу <code class="man-inline">S3 Object Storage</code>.<br/>---<br/><br/>## Доступные операции<br/><br/>* create — Создание кластера<br/>* delete — Удаление кластера<br/>* suspend — Приостановка работы кластера<br/>* resume — Возобновление работы кластера<br/>* create_database — Создание базы данных<br/>* delete_database — Удаление базы данных<br/>* create_user — Создание пользователя и настройка прав доступа к базе данных<br/>* delete_user — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию <code class="man-inline">create</code> - будет создан кластер<br/>2. Выполнить операцию <code class="man-inline">create_database</code> - будет создана база данных<br/>3. Выполнить операцию <code class="man-inline">create_user</code> - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/><pre class="man-code language-bash"># Проверка доступности кластера
|
||||
<span class="man-kw">curl</span> "http://<username>:<password>@<host>:<span class="man-num">8123</span>/<span class="man-str">" -d "</span>SELECT 1<span class="man-str">"
|
||||
|
||||
# Выполнение запроса
|
||||
curl "</span>http://<username>:<password>@<host>:<span class="man-num">8123</span>/<span class="man-str">" -d "</span>SHOW DATABASES"</pre><br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/><pre class="man-code language-clickhouse"><span class="man-kw">CREATE</span> <span class="man-kw">TABLE</span> <span class="man-ident">database.table</span>
|
||||
(
|
||||
id UInt64,
|
||||
value String
|
||||
)
|
||||
<span class="man-kw">ENGINE</span> = <span class="man-fn">MergeTree</span>()
|
||||
<span class="man-kw">ORDER</span> <span class="man-kw">BY</span> id;
|
||||
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.table</span> <span class="man-kw">SELECT</span> number, <span class="man-fn">toString</span>(number) <span class="man-kw">FROM</span> <span class="man-fn">numbers</span>(<span class="man-num">10000000</span>);
|
||||
|
||||
<span class="man-kw">SELECT</span> <span class="man-kw">count</span>() <span class="man-kw">FROM</span> <span class="man-ident">database.table</span>;</pre><br/>Базы и таблицы не реплицируются без специального ключа (<code class="man-inline">ON CLUSTER 'clickhousek8s'</code>)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/><pre class="man-code language-clickhouse"><span class="man-kw">CREATE</span> <span class="man-kw">TABLE</span> <span class="man-ident">database.localUsers</span>
|
||||
(
|
||||
id UInt64,
|
||||
value String
|
||||
)
|
||||
<span class="man-kw">ENGINE</span> = <span class="man-fn">MergeTree</span>()
|
||||
<span class="man-kw">ORDER</span> <span class="man-kw">BY</span> id;
|
||||
|
||||
<span class="man-kw">CREATE</span> <span class="man-kw">TABLE</span> <span class="man-ident">database.shardedTable</span>
|
||||
<span class="man-kw">AS</span> localUsers
|
||||
<span class="man-kw">ENGINE</span> = <span class="man-fn">Distributed</span>(<span class="man-str">'clickhousek8s'</span>, <span class="man-str">'database'</span>, <span class="man-str">'localUsers'</span>, id);
|
||||
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> shardedTable <span class="man-kw">SELECT</span> number, <span class="man-fn">toString</span>(number) <span class="man-kw">FROM</span> <span class="man-fn">numbers</span>(<span class="man-num">10000000</span>);
|
||||
|
||||
<span class="man-kw">SELECT</span> <span class="man-kw">count</span>() <span class="man-kw">FROM</span> shardedTable;</pre><br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/><pre class="man-code language-clickhouse"><span class="man-kw">CREATE</span> <span class="man-kw">TABLE</span> <span class="man-kw">IF</span> <span class="man-kw">NOT</span> <span class="man-kw">EXISTS</span> <span class="man-ident">database.localUsers</span> <span class="man-kw">ON</span> <span class="man-kw">cluster</span> <span class="man-str">'clickhousek8s'</span>
|
||||
(
|
||||
user_id UInt64,
|
||||
name String,
|
||||
email String
|
||||
)
|
||||
<span class="man-kw">ENGINE</span> = <span class="man-fn">ReplicatedMergeTree</span>(
|
||||
<span class="man-str">'/clickhouse/tables/{shard}/localUsers'</span>,
|
||||
<span class="man-str">'{replica}'</span>
|
||||
)
|
||||
<span class="man-kw">ORDER</span> <span class="man-kw">BY</span> user_id;
|
||||
|
||||
<span class="man-kw">CREATE</span> <span class="man-kw">TABLE</span> <span class="man-kw">IF</span> <span class="man-kw">NOT</span> <span class="man-kw">EXISTS</span> <span class="man-ident">database.users</span> <span class="man-kw">ON</span> <span class="man-kw">cluster</span> <span class="man-str">'clickhousek8s'</span>
|
||||
<span class="man-kw">AS</span> <span class="man-ident">database.localUsers</span>
|
||||
<span class="man-kw">ENGINE</span> = <span class="man-fn">Distributed</span>(<span class="man-str">'clickhousek8s'</span>, <span class="man-str">'database'</span>, <span class="man-str">'localUsers'</span>, rand());
|
||||
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">1</span>, <span class="man-str">'Alice'</span>, <span class="man-str">'alice@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">2</span>, <span class="man-str">'Bob'</span>, <span class="man-str">'bob@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">3</span>, <span class="man-str">'Charlie'</span>, <span class="man-str">'charlie@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">4</span>, <span class="man-str">'David'</span>, <span class="man-str">'david@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">5</span>, <span class="man-str">'Gosha'</span>, <span class="man-str">'gosha@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">6</span>, <span class="man-str">'Eve'</span>, <span class="man-str">'eve@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">7</span>, <span class="man-str">'Frank'</span>, <span class="man-str">'frank@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">8</span>, <span class="man-str">'Grace'</span>, <span class="man-str">'grace@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">9</span>, <span class="man-str">'Hannah'</span>, <span class="man-str">'hannah@example.com'</span>);
|
||||
<span class="man-kw">INSERT</span> <span class="man-kw">INTO</span> <span class="man-ident">database.users</span> <span class="man-kw">VALUES</span> (<span class="man-num">10</span>, <span class="man-str">'Ivan'</span>, <span class="man-str">'ivan@example.com'</span>);
|
||||
|
||||
<span class="man-kw">SELECT</span> * <span class="man-kw">FROM</span> <span class="man-ident">database.localUsers</span>;
|
||||
<span class="man-kw">SELECT</span> * <span class="man-kw">FROM</span> <span class="man-ident">database.users</span>;
|
||||
|
||||
<span class="man-kw">SELECT</span> <span class="man-kw">COUNT</span>(*) <span class="man-kw">AS</span> total_users <span class="man-kw">FROM</span> <span class="man-ident">database.users</span>;
|
||||
<span class="man-kw">SELECT</span> <span class="man-kw">COUNT</span>(*) <span class="man-kw">AS</span> total_users_local <span class="man-kw">FROM</span> <span class="man-ident">database.localUsers</span>;</pre>
|
||||
|
||||
- <code class="man-inline">state_params</code> (map) — параметры, отправленные в API при создании/изменении.
|
||||
- <code class="man-inline">state_out</code> (map) — ответ API с результатами/выходными значениями.
|
||||
- <code class="man-inline">state_params_flat</code> (map) — параметры в плоском виде (ключи с путями).
|
||||
- <code class="man-inline">state_out_flat</code> (map) — ответы в плоском виде (ключи с путями).
|
||||
- <code class="man-inline">vault_secrets</code> (map) — секреты, записанные в Vault для ресурса.
|
||||
- <code class="man-inline">vault_url</code> (string) — адрес Vault для ресурса.
|
||||
- <code class="man-inline">vault_user_path</code> (string) — путь пользователя в Vault.
|
||||
- <code class="man-inline">vault_fields</code> (list) — список ключей доступных секретов.
|
||||
</div>
|
||||
|
||||
## Summary
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse
|
||||
|
||||
|
||||
## Lifecycle behavior
|
||||
|
||||
- If suspend/resume exist, delete maps to suspend and apply can resume.
|
||||
- Advanced users may override delete_mode and resume_if_exists.
|
||||
@@ -1,20 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_database" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
database_name = "TODO"
|
||||
}
|
||||
```
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
-11
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
@@ -1,58 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
## Copy-ready manifest (`clickhouse_main.tf`)
|
||||
|
||||
<div class="copy-ready-code"><pre><code><span class="token-keyword">terraform</span> {
|
||||
<span class="token-attr">required_providers</span> {
|
||||
<span class="token-name">nubes</span> = {
|
||||
<span class="token-attr">source</span> = <span class="token-value">"terra.k8c.ru/nubes/nubes"</span>
|
||||
<span class="token-attr">version</span> = <span class="token-value">"2.1.10"</span> <span class="token-comment"># Для определения актуальной версии наберите в терминале terraform version</span>
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="token-comment"># Токен доступа api_token к Nubes API — замените на реальный.</span>
|
||||
<span class="token-keyword">provider</span> <span class="token-name">"nubes"</span> {
|
||||
<span class="token-attr">api_token</span> = <span class="token-value">"token_***"</span>
|
||||
<span class="token-attr">api_endpoint</span> = <span class="token-value">"https://deck-api.ngcloud.ru/api/v1/index.cfm"</span>
|
||||
}
|
||||
<span class="token-keyword">resource</span> <span class="token-type">"nubes_clickhouse"</span> <span class="token-name">"baza"</span> {
|
||||
<span class="token-comment"># TODO - обязательный параметр, задаваемый пользователем</span>
|
||||
<span class="token-attr">resourceRealm</span> = <span class="token-value">"TODO"</span> <span class="token-comment"># Кластер Kubernetes в котором будет развернуто приложение, например "k8s-3.ext.nubes.ru"</span>
|
||||
<span class="token-attr">s3Uid</span> = <span class="token-value">"TODO"</span> <span class="token-comment"># Экземпляр (учетная запись) S3, это имя S3 Object Storage</span>
|
||||
|
||||
<span class="token-comment"># Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте</span>
|
||||
<span class="token-attr">resourceInstances</span> = <span class="token-value">1</span>
|
||||
<span class="token-attr">resourceInstancesShards</span> = <span class="token-value">1</span>
|
||||
<span class="token-attr">resourceCPU</span> = <span class="token-value">1000</span>
|
||||
<span class="token-attr">resourceMemory</span> = <span class="token-value">1536</span>
|
||||
<span class="token-attr">appVersion</span> = <span class="token-value">"25.10"</span>
|
||||
<span class="token-attr">resourceDisk</span> = <span class="token-value">10</span>
|
||||
<span class="token-attr">needExternalAddressMaster</span> = <span class="token-value">false</span>
|
||||
<span class="token-attr">needCreateKeeper</span> = <span class="token-value">true</span>
|
||||
<span class="token-attr">resourceCPUKeeper</span> = <span class="token-value">50</span>
|
||||
<span class="token-attr">resourceMemoryKeeper</span> = <span class="token-value">152</span>
|
||||
<span class="token-attr">resourceInstancesKeeper</span> = <span class="token-value">1</span>
|
||||
<span class="token-attr">ext_BACKUP_SCHEDULE</span> = <span class="token-value">"0 0 * * *"</span>
|
||||
<span class="token-attr">ext_BACKUP_NUM_TO_RETAIN</span> = <span class="token-value">7</span>
|
||||
}
|
||||
</code></pre></div>
|
||||
|
||||
## Outputs usage
|
||||
|
||||
<div class="copy-ready-code"><pre><code><span class="token-comment"># Выходные параметры можно использовать как</span>
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">state_params</span>[<span class="token-value">"имя_ключа"</span>]
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">state_out</span>[<span class="token-value">"имя_ключа"</span>]
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">state_params_flat</span>[<span class="token-value">"имя_ключа"</span>]
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">state_out_flat</span>[<span class="token-value">"имя_ключа"</span>]
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">vault_secrets</span>[<span class="token-value">"имя_ключа"</span>]
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">vault_url</span>
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">vault_user_path</span>
|
||||
<span class="token-type">nubes_clickhouse</span>.<span class="token-name">baza</span>.<span class="token-attr">vault_fields</span>
|
||||
</code></pre></div>
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для clickhouse
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (`https://github.com/Altinity/clickhouse-operator`) в ресурсной платформе типа `k8s`<br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра `Создать ClickHouse-Keeper`.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу `S3 Object Storage`.<br/>---<br/><br/>## Доступные операции<br/><br/>* **create** — Создание кластера<br/>* **delete** — Удаление кластера<br/>* **suspend** — Приостановка работы кластера<br/>* **resume** — Возобновление работы кластера<br/>* **create_database** — Создание базы данных<br/>* **delete_database** — Удаление базы данных<br/>* **create_user** — Создание пользователя и настройка прав доступа к базе данных<br/>* **delete_user** — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию `create` - будет создан кластер<br/>2. Выполнить операцию `create_database` - будет создана база данных<br/>3. Выполнить операцию `create_user` - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/>```bash<br/># Проверка доступности кластера<br/>curl "http://<username>:<password>@<host>:8123/" -d "SELECT 1"<br/><br/># Выполнение запроса<br/>curl "http://<username>:<password>@<host>:8123/" -d "SHOW DATABASES"<br/>```<br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.table<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>INSERT INTO database.table SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM database.table;<br/>```<br/>Базы и таблицы не реплицируются без специального ключа (`ON CLUSTER 'clickhousek8s'`)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.localUsers<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>CREATE TABLE database.shardedTable<br/>AS localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', id);<br/><br/>INSERT INTO shardedTable SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM shardedTable;<br/>```<br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE IF NOT EXISTS database.localUsers ON cluster 'clickhousek8s'<br/>(<br/> user_id UInt64,<br/> name String,<br/> email String<br/>)<br/>ENGINE = ReplicatedMergeTree(<br/> '/clickhouse/tables/{shard}/localUsers',<br/> '{replica}'<br/>)<br/>ORDER BY user_id;<br/><br/>CREATE TABLE IF NOT EXISTS database.users ON cluster 'clickhousek8s'<br/>AS database.localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', rand());<br/><br/>INSERT INTO database.users VALUES (1, 'Alice', 'alice@example.com');<br/>INSERT INTO database.users VALUES (2, 'Bob', 'bob@example.com');<br/>INSERT INTO database.users VALUES (3, 'Charlie', 'charlie@example.com');<br/>INSERT INTO database.users VALUES (4, 'David', 'david@example.com');<br/>INSERT INTO database.users VALUES (5, 'Gosha', 'gosha@example.com');<br/>INSERT INTO database.users VALUES (6, 'Eve', 'eve@example.com');<br/>INSERT INTO database.users VALUES (7, 'Frank', 'frank@example.com');<br/>INSERT INTO database.users VALUES (8, 'Grace', 'grace@example.com');<br/>INSERT INTO database.users VALUES (9, 'Hannah', 'hannah@example.com');<br/>INSERT INTO database.users VALUES (10, 'Ivan', 'ivan@example.com');<br/><br/>SELECT * FROM database.localUsers;<br/>SELECT * FROM database.users;<br/><br/>SELECT COUNT(*) AS total_users FROM database.users;<br/>SELECT COUNT(*) AS total_users_local FROM database.localUsers;<br/>```
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: clickhouse
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (`https://github.com/Altinity/clickhouse-operator`) в ресурсной платформе типа `k8s`<br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра `Создать ClickHouse-Keeper`.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу `S3 Object Storage`.<br/>---<br/><br/>## Доступные операции<br/><br/>* **create** — Создание кластера<br/>* **delete** — Удаление кластера<br/>* **suspend** — Приостановка работы кластера<br/>* **resume** — Возобновление работы кластера<br/>* **create_database** — Создание базы данных<br/>* **delete_database** — Удаление базы данных<br/>* **create_user** — Создание пользователя и настройка прав доступа к базе данных<br/>* **delete_user** — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию `create` - будет создан кластер<br/>2. Выполнить операцию `create_database` - будет создана база данных<br/>3. Выполнить операцию `create_user` - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/>```bash<br/># Проверка доступности кластера<br/>curl "http://<username>:<password>@<host>:8123/" -d "SELECT 1"<br/><br/># Выполнение запроса<br/>curl "http://<username>:<password>@<host>:8123/" -d "SHOW DATABASES"<br/>```<br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.table<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>INSERT INTO database.table SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM database.table;<br/>```<br/>Базы и таблицы не реплицируются без специального ключа (`ON CLUSTER 'clickhousek8s'`)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.localUsers<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>CREATE TABLE database.shardedTable<br/>AS localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', id);<br/><br/>INSERT INTO shardedTable SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM shardedTable;<br/>```<br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE IF NOT EXISTS database.localUsers ON cluster 'clickhousek8s'<br/>(<br/> user_id UInt64,<br/> name String,<br/> email String<br/>)<br/>ENGINE = ReplicatedMergeTree(<br/> '/clickhouse/tables/{shard}/localUsers',<br/> '{replica}'<br/>)<br/>ORDER BY user_id;<br/><br/>CREATE TABLE IF NOT EXISTS database.users ON cluster 'clickhousek8s'<br/>AS database.localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', rand());<br/><br/>INSERT INTO database.users VALUES (1, 'Alice', 'alice@example.com');<br/>INSERT INTO database.users VALUES (2, 'Bob', 'bob@example.com');<br/>INSERT INTO database.users VALUES (3, 'Charlie', 'charlie@example.com');<br/>INSERT INTO database.users VALUES (4, 'David', 'david@example.com');<br/>INSERT INTO database.users VALUES (5, 'Gosha', 'gosha@example.com');<br/>INSERT INTO database.users VALUES (6, 'Eve', 'eve@example.com');<br/>INSERT INTO database.users VALUES (7, 'Frank', 'frank@example.com');<br/>INSERT INTO database.users VALUES (8, 'Grace', 'grace@example.com');<br/>INSERT INTO database.users VALUES (9, 'Hannah', 'hannah@example.com');<br/>INSERT INTO database.users VALUES (10, 'Ivan', 'ivan@example.com');<br/><br/>SELECT * FROM database.localUsers;<br/>SELECT * FROM database.users;<br/><br/>SELECT COUNT(*) AS total_users FROM database.users;<br/>SELECT COUNT(*) AS total_users_local FROM database.localUsers;<br/>```
|
||||
@@ -1,20 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
## Operations
|
||||
|
||||
- `create` — Создание кластера. Параметры: [Create params](clickhouse_params_create.md)
|
||||
- `modify` — Изменение кластера. Параметры: [Modify params](clickhouse_params_modify.md)
|
||||
- `delete` — Удаление кластера (после `suspend`, требуется время на остановку)
|
||||
- `suspend` — Остановка кластера (pods удаляются, PV остаются)
|
||||
- `resume` — Возобновление работы кластера
|
||||
- `create_database` — Создание базы данных. См. [nubes_clickhouse_database](clickhouse_database.md)
|
||||
- `delete_database` — Удаление базы данных. См. [nubes_clickhouse_database](clickhouse_database.md)
|
||||
- `create_user` — Создание пользователя. См. [nubes_clickhouse_user](clickhouse_user.md)
|
||||
- `delete_user` — Удаление пользователя. См. [nubes_clickhouse_user](clickhouse_user.md)
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_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) — список ключей доступных секретов.
|
||||
@@ -1,12 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
## Parameters
|
||||
|
||||
- [Create params](clickhouse_params_create.md)
|
||||
- [Modify params](clickhouse_params_modify.md)
|
||||
@@ -1,47 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_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>572</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
|
||||
<tr><td>573</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>**Если список не отображается** <br/>перейдите в раздел `S3 Object Storage` <br/>операция `create`</td><td>ref_svc_id=12</td></tr>
|
||||
<tr><td>581</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</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>574</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>575</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>576</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td><code>1000</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>577</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td><code>1536</code></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>578</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td><code>25.10</code></td><td>Версия `clickhouse-server`</td><td>value_list=25.10</td></tr>
|
||||
<tr><td>579</td><td><strong><code class="code-no-wrap">resourceDisk</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>580</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>582</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td><code>true</code></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>583</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td><code>50</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>584</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td><code>152</code></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>585</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>586</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td><code>0 0 * * *</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>587</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td><code>7</code></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
<div class="lifecycle-note">
|
||||
<strong>Параметры жизненного цикла (Lifecycle defaults)</strong><br/>
|
||||
По умолчанию: `delete_mode_default = suspend`, `resume_if_exists_default = True`.<br/>
|
||||
Если для сервиса доступны операции `suspend` и `resume`, то `delete` выполняет приостановку (без удаления данных),<br/>
|
||||
а `apply` при необходимости возобновляет работу существующего ресурса.<br/>
|
||||
Менять эти значения стоит только в продвинутых сценариях — через параметры `delete_mode` и `resume_if_exists` в манифесте.
|
||||
</div>
|
||||
@@ -1,28 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_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>603</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>604</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>605</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>606</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>607</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>Версия `clickhouse-server`</td><td></td></tr>
|
||||
<tr><td>608</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>Указывается в Gigabytes<br/>**Нельзя** выставлять меньше текущего значения</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>609</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>610</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</td><td></td></tr>
|
||||
<tr><td>611</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>612</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>613</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>614</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>615</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>616</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
@@ -1,22 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_user" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
username = "TODO"
|
||||
database_name = ["database"]
|
||||
access_hosts = ::/0
|
||||
}
|
||||
```
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
@@ -1,13 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,50 +0,0 @@
|
||||
# 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 = "2.1.23"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Токен доступа api_token к Nubes API — замените на реальный.
|
||||
provider "nubes" {
|
||||
api_token = "token_***"
|
||||
api_endpoint = "https://lk-api-gateway.ngcloud.ru/api/v1/svc" <!-- ⛔ LEGACY index.cfm удалён, заменён на Gateway -->
|
||||
}
|
||||
resource "nubes_akhq" "baza" {
|
||||
resource_realm = "TODO" # Выбрать платформу из списка
|
||||
domain = "TODO" # Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm
|
||||
kafka_uid = "TODO" # Выбрать кластер из списка
|
||||
|
||||
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
|
||||
resource_memory = 512 # Пример: `1024`
|
||||
resource_c_p_u = 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
|
||||
```
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_example.md) | [Parameters](akhq_example_params.md) | [Operations](akhq_example_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_example.md) | [Parameters](akhq_example_params.md) | [Operations](akhq_example_ops.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: akhq
|
||||
|
||||
# Инструкция по развертыванию 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/>---
|
||||
@@ -1,15 +0,0 @@
|
||||
# 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`
|
||||
@@ -1,41 +0,0 @@
|
||||
# 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) — список ключей доступных секретов
|
||||
|
||||
## Реальные поля из облака (prod / Akhq-4 / suspended)
|
||||
|
||||
Поля ниже получены из реальных инстансов этого сервиса в облаке.
|
||||
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
|
||||
|
||||
### `state_params` ключи
|
||||
|
||||
- `state_params["domain"]`
|
||||
- `state_params["resourceCPU"]`
|
||||
- `state_params["resourceRealm"]`
|
||||
- `state_params["resourceMemory"]`
|
||||
- `state_params["resourceInstances"]`
|
||||
|
||||
### `state_out_flat` ключи
|
||||
|
||||
- `state_out_flat["connectionUrl"]`
|
||||
|
||||
### `vault_secrets` ключи
|
||||
|
||||
- `vault_secrets["url"]`
|
||||
- `vault_secrets["fields"]`
|
||||
- `vault_secrets["userPath"]`
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_outputs.md) | [Parameters](akhq_outputs_params.md) | [Operations](akhq_outputs_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_outputs.md) | [Parameters](akhq_outputs_params.md) | [Operations](akhq_outputs_ops.md)
|
||||
@@ -1,12 +0,0 @@
|
||||
# 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)
|
||||
@@ -1,40 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_params_create.md) | [Parameters](akhq_params_create_params.md) | [Operations](akhq_params_create_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_params_create.md) | [Parameters](akhq_params_create_params.md) | [Operations](akhq_params_create_ops.md)
|
||||
@@ -1,15 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_params_modify.md) | [Parameters](akhq_params_modify_params.md) | [Operations](akhq_params_modify_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](akhq_params_modify.md) | [Parameters](akhq_params_modify_params.md) | [Operations](akhq_params_modify_ops.md)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,66 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Overview](clickhouse.md) | [Parameters](clickhouse_params.md) | [Operations](clickhouse_ops.md)
|
||||
|
||||
## MAN
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (`https://github.com/Altinity/clickhouse-operator`) в ресурсной платформе типа `k8s`<br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра `Создать ClickHouse-Keeper`.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу `S3 Object Storage`.<br/>---<br/><br/>## Доступные операции<br/><br/>* **create** — Создание кластера<br/>* **delete** — Удаление кластера<br/>* **suspend** — Приостановка работы кластера<br/>* **resume** — Возобновление работы кластера<br/>* **create_database** — Создание базы данных<br/>* **delete_database** — Удаление базы данных<br/>* **create_user** — Создание пользователя и настройка прав доступа к базе данных<br/>* **delete_user** — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию `create` - будет создан кластер<br/>2. Выполнить операцию `create_database` - будет создана база данных<br/>3. Выполнить операцию `create_user` - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/>```bash<br/># Проверка доступности кластера<br/>curl "http://<username>:<password>@<host>:8123/" -d "SELECT 1"<br/><br/># Выполнение запроса<br/>curl "http://<username>:<password>@<host>:8123/" -d "SHOW DATABASES"<br/>```<br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.table<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>INSERT INTO database.table SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM database.table;<br/>```<br/>Базы и таблицы не реплицируются без специального ключа (`ON CLUSTER 'clickhousek8s'`)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.localUsers<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>CREATE TABLE database.shardedTable<br/>AS localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', id);<br/><br/>INSERT INTO shardedTable SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM shardedTable;<br/>```<br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE IF NOT EXISTS database.localUsers ON cluster 'clickhousek8s'<br/>(<br/> user_id UInt64,<br/> name String,<br/> email String<br/>)<br/>ENGINE = ReplicatedMergeTree(<br/> '/clickhouse/tables/{shard}/localUsers',<br/> '{replica}'<br/>)<br/>ORDER BY user_id;<br/><br/>CREATE TABLE IF NOT EXISTS database.users ON cluster 'clickhousek8s'<br/>AS database.localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', rand());<br/><br/>INSERT INTO database.users VALUES (1, 'Alice', 'alice@example.com');<br/>INSERT INTO database.users VALUES (2, 'Bob', 'bob@example.com');<br/>INSERT INTO database.users VALUES (3, 'Charlie', 'charlie@example.com');<br/>INSERT INTO database.users VALUES (4, 'David', 'david@example.com');<br/>INSERT INTO database.users VALUES (5, 'Gosha', 'gosha@example.com');<br/>INSERT INTO database.users VALUES (6, 'Eve', 'eve@example.com');<br/>INSERT INTO database.users VALUES (7, 'Frank', 'frank@example.com');<br/>INSERT INTO database.users VALUES (8, 'Grace', 'grace@example.com');<br/>INSERT INTO database.users VALUES (9, 'Hannah', 'hannah@example.com');<br/>INSERT INTO database.users VALUES (10, 'Ivan', 'ivan@example.com');<br/><br/>SELECT * FROM database.localUsers;<br/>SELECT * FROM database.users;<br/><br/>SELECT COUNT(*) AS total_users FROM database.users;<br/>SELECT COUNT(*) AS total_users_local FROM database.localUsers;<br/>```
|
||||
|
||||
|
||||
## Summary
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse" "example" {
|
||||
resource_realm = "TODO"
|
||||
s3_uid = "235e0546-..."
|
||||
resource_instances = 1
|
||||
resource_instances_shards = 1
|
||||
resource_c_p_u = 1000
|
||||
resource_memory = 1536
|
||||
app_version = 25.10
|
||||
resource_disk = 10
|
||||
need_external_address_master = false
|
||||
need_create_keeper = true
|
||||
resource_c_p_u_keeper = 50
|
||||
resource_memory_keeper = 152
|
||||
resource_instances_keeper = 1
|
||||
ext__b_a_c_k_u_p__s_c_h_e_d_u_l_e = 0 0 * * *
|
||||
ext__b_a_c_k_u_p__n_u_m__t_o__r_e_t_a_i_n = 7
|
||||
adopt_existing_on_create = НЕТ
|
||||
suspend_on_destroy = ДА
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Outputs
|
||||
|
||||
- `state_params` (map)
|
||||
- `state_out` (map)
|
||||
- `state_params_flat` (map)
|
||||
- `state_out_flat` (map)
|
||||
- `vault_secrets` (map)
|
||||
- `vault_url` (string)
|
||||
- `vault_user_path` (string)
|
||||
- `vault_fields` (list)
|
||||
|
||||
|
||||
## Lifecycle defaults
|
||||
|
||||
- `suspend_on_destroy_default` = `True`
|
||||
- `adopt_existing_on_create_default` = `False`
|
||||
|
||||
|
||||
## Lifecycle behavior
|
||||
|
||||
- For suspend-capable services: cloud status `missing/deleted` => create, `suspend` + key params match => resume.
|
||||
- `running` requires explicit `adopt_existing_on_create=true` for adopt/import behavior, otherwise error.
|
||||
- Destroy uses `suspend_on_destroy`: true => suspend, false => remove from state only.
|
||||
@@ -1,26 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_database" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
database_name = "TODO"
|
||||
}
|
||||
```
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_clickhouse_database
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
|
||||
[Overview](clickhouse_database.md) | [Parameters](clickhouse_database_params.md) | [Operations](clickhouse_database_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
[Overview](clickhouse_example.md) | [Parameters](clickhouse_example_params.md) | [Operations](clickhouse_example_ops.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для clickhouse
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (`https://github.com/Altinity/clickhouse-operator`) в ресурсной платформе типа `k8s`<br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра `Создать ClickHouse-Keeper`.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу `S3 Object Storage`.<br/>---<br/><br/>## Доступные операции<br/><br/>* **create** — Создание кластера<br/>* **delete** — Удаление кластера<br/>* **suspend** — Приостановка работы кластера<br/>* **resume** — Возобновление работы кластера<br/>* **create_database** — Создание базы данных<br/>* **delete_database** — Удаление базы данных<br/>* **create_user** — Создание пользователя и настройка прав доступа к базе данных<br/>* **delete_user** — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию `create` - будет создан кластер<br/>2. Выполнить операцию `create_database` - будет создана база данных<br/>3. Выполнить операцию `create_user` - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/>```bash<br/># Проверка доступности кластера<br/>curl "http://<username>:<password>@<host>:8123/" -d "SELECT 1"<br/><br/># Выполнение запроса<br/>curl "http://<username>:<password>@<host>:8123/" -d "SHOW DATABASES"<br/>```<br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.table<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>INSERT INTO database.table SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM database.table;<br/>```<br/>Базы и таблицы не реплицируются без специального ключа (`ON CLUSTER 'clickhousek8s'`)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.localUsers<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>CREATE TABLE database.shardedTable<br/>AS localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', id);<br/><br/>INSERT INTO shardedTable SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM shardedTable;<br/>```<br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE IF NOT EXISTS database.localUsers ON cluster 'clickhousek8s'<br/>(<br/> user_id UInt64,<br/> name String,<br/> email String<br/>)<br/>ENGINE = ReplicatedMergeTree(<br/> '/clickhouse/tables/{shard}/localUsers',<br/> '{replica}'<br/>)<br/>ORDER BY user_id;<br/><br/>CREATE TABLE IF NOT EXISTS database.users ON cluster 'clickhousek8s'<br/>AS database.localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', rand());<br/><br/>INSERT INTO database.users VALUES (1, 'Alice', 'alice@example.com');<br/>INSERT INTO database.users VALUES (2, 'Bob', 'bob@example.com');<br/>INSERT INTO database.users VALUES (3, 'Charlie', 'charlie@example.com');<br/>INSERT INTO database.users VALUES (4, 'David', 'david@example.com');<br/>INSERT INTO database.users VALUES (5, 'Gosha', 'gosha@example.com');<br/>INSERT INTO database.users VALUES (6, 'Eve', 'eve@example.com');<br/>INSERT INTO database.users VALUES (7, 'Frank', 'frank@example.com');<br/>INSERT INTO database.users VALUES (8, 'Grace', 'grace@example.com');<br/>INSERT INTO database.users VALUES (9, 'Hannah', 'hannah@example.com');<br/>INSERT INTO database.users VALUES (10, 'Ivan', 'ivan@example.com');<br/><br/>SELECT * FROM database.localUsers;<br/>SELECT * FROM database.users;<br/><br/>SELECT COUNT(*) AS total_users FROM database.users;<br/>SELECT COUNT(*) AS total_users_local FROM database.localUsers;<br/>```
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: clickhouse
|
||||
|
||||
# Инструкция по управлению кластерами и пользователями ClickHouse<br/><br/>---<br/><br/>## Общая информация<br/><br/>ClickHouse — это колоночная система управления базами данных, предназначенная для обработки аналитических запросов в реальном времени. Платформа позволяет создавать, удалять, приостанавливать и возобновлять кластеры ClickHouse, а также управлять базами данных и пользователями.<br/><br/>Кластер создаётся через оператор Altinity (`https://github.com/Altinity/clickhouse-operator`) в ресурсной платформе типа `k8s`<br/><br/>Кластеры могут создаваться шардированными с произвольным количеством реплик. Для обеспечения отказоустойчивости и координации обязательно включение параметра `Создать ClickHouse-Keeper`.<br/><br/>Кластера создаются с обязательным бекапом. Для этого необходимо предварительно создать услугу `S3 Object Storage`.<br/>---<br/><br/>## Доступные операции<br/><br/>* **create** — Создание кластера<br/>* **delete** — Удаление кластера<br/>* **suspend** — Приостановка работы кластера<br/>* **resume** — Возобновление работы кластера<br/>* **create_database** — Создание базы данных<br/>* **delete_database** — Удаление базы данных<br/>* **create_user** — Создание пользователя и настройка прав доступа к базе данных<br/>* **delete_user** — Удаление пользователя<br/><br/>## Процесс создания и первого подключения<br/><br/>1. Выполнить операцию `create` - будет создан кластер<br/>2. Выполнить операцию `create_database` - будет создана база данных<br/>3. Выполнить операцию `create_user` - будет создан пользователь (выбрать доступ подключения к БД, созданной в п.2)<br/><br/>## Примеры подключения<br/><br/>### Подключение через HTTP-интерфейс<br/><br/>```bash<br/># Проверка доступности кластера<br/>curl "http://<username>:<password>@<host>:8123/" -d "SELECT 1"<br/><br/># Выполнение запроса<br/>curl "http://<username>:<password>@<host>:8123/" -d "SHOW DATABASES"<br/>```<br/><br/>## Простые кейсы<br/>*Создать БД и обычной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.table<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>INSERT INTO database.table SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM database.table;<br/>```<br/>Базы и таблицы не реплицируются без специального ключа (`ON CLUSTER 'clickhousek8s'`)<br/>В случае создания в стиле, описанным выше, необходимо будет выполнять действия на всех шардах/репликах<br/><br/><br/>*Создание БД и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE database.localUsers<br/>(<br/> id UInt64,<br/> value String<br/>)<br/>ENGINE = MergeTree()<br/>ORDER BY id;<br/><br/>CREATE TABLE database.shardedTable<br/>AS localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', id);<br/><br/>INSERT INTO shardedTable SELECT number, toString(number) FROM numbers(10000000);<br/><br/>SELECT count() FROM shardedTable;<br/>```<br/>Важный момент - в данном примере таблицы придётся также выполнять на всех нодах ClickHouse<br/><br/>*Создание реплицируемой и шардированной таблицы*<br/>```clickhouse<br/>CREATE TABLE IF NOT EXISTS database.localUsers ON cluster 'clickhousek8s'<br/>(<br/> user_id UInt64,<br/> name String,<br/> email String<br/>)<br/>ENGINE = ReplicatedMergeTree(<br/> '/clickhouse/tables/{shard}/localUsers',<br/> '{replica}'<br/>)<br/>ORDER BY user_id;<br/><br/>CREATE TABLE IF NOT EXISTS database.users ON cluster 'clickhousek8s'<br/>AS database.localUsers<br/>ENGINE = Distributed('clickhousek8s', 'database', 'localUsers', rand());<br/><br/>INSERT INTO database.users VALUES (1, 'Alice', 'alice@example.com');<br/>INSERT INTO database.users VALUES (2, 'Bob', 'bob@example.com');<br/>INSERT INTO database.users VALUES (3, 'Charlie', 'charlie@example.com');<br/>INSERT INTO database.users VALUES (4, 'David', 'david@example.com');<br/>INSERT INTO database.users VALUES (5, 'Gosha', 'gosha@example.com');<br/>INSERT INTO database.users VALUES (6, 'Eve', 'eve@example.com');<br/>INSERT INTO database.users VALUES (7, 'Frank', 'frank@example.com');<br/>INSERT INTO database.users VALUES (8, 'Grace', 'grace@example.com');<br/>INSERT INTO database.users VALUES (9, 'Hannah', 'hannah@example.com');<br/>INSERT INTO database.users VALUES (10, 'Ivan', 'ivan@example.com');<br/><br/>SELECT * FROM database.localUsers;<br/>SELECT * FROM database.users;<br/><br/>SELECT COUNT(*) AS total_users FROM database.users;<br/>SELECT COUNT(*) AS total_users_local FROM database.localUsers;<br/>```
|
||||
@@ -1,179 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Overview](clickhouse.md) | [Parameters](clickhouse_params.md) | [Operations](clickhouse_ops.md)
|
||||
|
||||
## Operations
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `181` | resourceRealm, s3Uid, resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN | Операция создания кластера ClickHouse<br/><br/>Для подключения к кластеру также необходимо создать базу данных через операцию `create_database` и создание пользователя через операцию `create_user` |
|
||||
| `create_database` | `subresource` | `create` | `database` | `186` | databaseName | База данных создаётся на всех репликах кластера ClickHouse |
|
||||
| `create_user` | `subresource` | `create` | `user` | `185` | username, databaseName, accessHosts | |
|
||||
| `delete` | `instance` | `delete` | `` | `184` | | Удаление возможно только после остановки сервиса через операцию `suspend`<br/>После выполнения операции необходимо выждать определенное кол-во времени |
|
||||
| `delete_database` | `subresource` | `delete` | `database` | `188` | databaseName | Необратимое действие!!!<br/>Трижды подумай, заблокируй телефон тимлида и не выполняй это действие |
|
||||
| `delete_user` | `subresource` | `delete` | `user` | `187` | username | |
|
||||
| `modify` | `instance` | `modify` | `` | `189` | resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN | |
|
||||
| `resume` | `instance` | `resume` | `` | `183` | | |
|
||||
| `suspend` | `instance` | `suspend` | `` | `182` | | Операция приводит к удалению всех подов<br/>Persistent Volume остаются нетронутыми |
|
||||
|
||||
### Operation: create
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>572</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
|
||||
<tr><td>573</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>**Если список не отображается** <br/>перейдите в раздел `S3 Object Storage` <br/>операция `create`</td><td>ref_svc_id=12</td></tr>
|
||||
<tr><td>574</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>575</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>576</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1000</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>577</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1536</code></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>578</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>25.10</code></td><td>Версия `clickhouse-server`</td><td>value_list=25.10</td></tr>
|
||||
<tr><td>579</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>Указывается в Gigabytes</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>580</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>581</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</td><td></td></tr>
|
||||
<tr><td>582</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>583</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>50</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>584</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>152</code></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>585</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>586</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>0 0 * * *</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>587</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>7</code></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: create_database
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>600</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пример: `db01`</td><td>regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: create_user
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>596</td><td><strong><code class="code-no-wrap">username</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пример: `myusername`</td><td>regex=^(?![0-9_])[a-zA-Z_][a-zA-Z0-9_]{0,62}$; maxlength=62; minlength=2</td></tr>
|
||||
<tr><td>598</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>["database"]</code></td><td>Если базы не существует - при выполнении операции вернётся ошибка</td><td></td></tr>
|
||||
<tr><td>599</td><td><strong><code class="code-no-wrap">accessHosts</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>::/0</code></td><td>Пример: `::/0`</td><td></td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: delete
|
||||
|
||||
None.
|
||||
|
||||
### Operation: delete_database
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>602</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>ВСЕ ДАННЫЕ ВНУТРИ БД БУДУТ УДАЛЕНЫ</td><td></td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: delete_user
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>601</td><td><strong><code class="code-no-wrap">username</code></strong></td><td></td><td>ДА</td><td></td><td>Имя пользователя, созданное через операцию `create_user`</td><td></td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: modify
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>603</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>604</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>605</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>606</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>607</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>25.10</code></td><td>Версия `clickhouse-server`</td><td></td></tr>
|
||||
<tr><td>608</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Gigabytes<br/>**Нельзя** выставлять меньше текущего значения</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>609</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>610</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</td><td></td></tr>
|
||||
<tr><td>611</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>612</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>613</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>614</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>615</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>0 0 * * *</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>616</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
### Operation: resume
|
||||
|
||||
None.
|
||||
|
||||
### Operation: suspend
|
||||
|
||||
None.
|
||||
|
||||
|
||||
## Subresources
|
||||
|
||||
### nubes_clickhouse_database
|
||||
|
||||
#### Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_database" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
database_name = "TODO"
|
||||
}
|
||||
```
|
||||
|
||||
#### Create parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>600</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пример: `db01`</td><td>regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
#### Modify parameters
|
||||
|
||||
None.
|
||||
|
||||
#### Delete parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>602</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>ВСЕ ДАННЫЕ ВНУТРИ БД БУДУТ УДАЛЕНЫ</td><td></td></tr>
|
||||
</tbody></table>
|
||||
### nubes_clickhouse_user
|
||||
|
||||
#### Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_user" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
username = "TODO"
|
||||
database_name = ["database"]
|
||||
access_hosts = ::/0
|
||||
}
|
||||
```
|
||||
|
||||
#### Create parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>596</td><td><strong><code class="code-no-wrap">username</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пример: `myusername`</td><td>regex=^(?![0-9_])[a-zA-Z_][a-zA-Z0-9_]{0,62}$; maxlength=62; minlength=2</td></tr>
|
||||
<tr><td>598</td><td><strong><code class="code-no-wrap">databaseName</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>["database"]</code></td><td>Если базы не существует - при выполнении операции вернётся ошибка</td><td></td></tr>
|
||||
<tr><td>599</td><td><strong><code class="code-no-wrap">accessHosts</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>::/0</code></td><td>Пример: `::/0`</td><td></td></tr>
|
||||
</tbody></table>
|
||||
|
||||
#### Modify parameters
|
||||
|
||||
None.
|
||||
|
||||
#### Delete parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>601</td><td><strong><code class="code-no-wrap">username</code></strong></td><td></td><td>ДА</td><td></td><td>Имя пользователя, созданное через операцию `create_user`</td><td></td></tr>
|
||||
</tbody></table>
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
[Overview](clickhouse_outputs.md) | [Parameters](clickhouse_outputs_params.md) | [Operations](clickhouse_outputs_ops.md)
|
||||
@@ -1,52 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Overview](clickhouse.md) | [Parameters](clickhouse_params.md) | [Operations](clickhouse_ops.md)
|
||||
|
||||
## Create parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>572</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
|
||||
<tr><td>573</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>**Если список не отображается** <br/>перейдите в раздел `S3 Object Storage` <br/>операция `create`</td><td>ref_svc_id=12</td></tr>
|
||||
<tr><td>574</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>575</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>576</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1000</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>577</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1536</code></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>578</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>25.10</code></td><td>Версия `clickhouse-server`</td><td>value_list=25.10</td></tr>
|
||||
<tr><td>579</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>Указывается в Gigabytes</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>580</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>581</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</td><td></td></tr>
|
||||
<tr><td>582</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>583</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>50</code></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>584</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>152</code></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>585</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>586</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>0 0 * * *</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>587</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>7</code></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
|
||||
## Modify parameters
|
||||
|
||||
<table class="resource-table">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>603</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>604</td><td><strong><code class="code-no-wrap">resourceInstancesShards</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда</td><td>minvalue=1; maxvalue=7</td></tr>
|
||||
<tr><td>605</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=1000; maxvalue=8000</td></tr>
|
||||
<tr><td>606</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Megabytes</td><td>minvalue=1536; maxvalue=8192</td></tr>
|
||||
<tr><td>607</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>25.10</code></td><td>Версия `clickhouse-server`</td><td></td></tr>
|
||||
<tr><td>608</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Gigabytes<br/>**Нельзя** выставлять меньше текущего значения</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>609</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>610</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды`</td><td></td></tr>
|
||||
<tr><td>611</td><td><strong><code class="code-no-wrap">needCreateKeeper</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Аналог `Zookeeper`, представленный от ClickHouse</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>612</td><td><strong><code class="code-no-wrap">resourceCPUKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Milicores<br/>`1000` Mili == `1` Ядро</td><td>minvalue=50; maxvalue=8000</td></tr>
|
||||
<tr><td>613</td><td><strong><code class="code-no-wrap">resourceMemoryKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Указывается в Megabytes</td><td>minvalue=152; maxvalue=8192</td></tr>
|
||||
<tr><td>614</td><td><strong><code class="code-no-wrap">resourceInstancesKeeper</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды</td><td>minvalue=1; maxvalue=3; value_list=1, 3</td></tr>
|
||||
<tr><td>615</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>0 0 * * *</code></td><td>Принимает формат `CRON`</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
|
||||
<tr><td>616</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты**</td><td>minvalue=3; maxvalue=60</td></tr>
|
||||
</tbody></table>
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
[Overview](clickhouse_params_create.md) | [Parameters](clickhouse_params_create_params.md) | [Operations](clickhouse_params_create_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
@@ -1,11 +0,0 @@
|
||||
# Resource nubes_clickhouse
|
||||
|
||||
Service ID: `120`
|
||||
|
||||
Service Name: ClickHouse
|
||||
|
||||
[Manual](clickhouse.md) | [Create params](clickhouse_params_create.md) | [Modify params](clickhouse_params_modify.md) | [Output params](clickhouse_outputs.md) | [Operations](clickhouse_ops.md) | [Example](clickhouse_example.md)
|
||||
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
[Overview](clickhouse_params_modify.md) | [Parameters](clickhouse_params_modify_params.md) | [Operations](clickhouse_params_modify_ops.md)
|
||||
@@ -1,28 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
## Example
|
||||
|
||||
```hcl
|
||||
resource "nubes_clickhouse_user" "example" {
|
||||
clickhouse_id = nubes_clickhouse.example.id
|
||||
username = "TODO"
|
||||
database_name = ["database"]
|
||||
access_hosts = ::/0
|
||||
}
|
||||
```
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
@@ -1,17 +0,0 @@
|
||||
# Resource nubes_clickhouse_user
|
||||
|
||||
Service: nubes_clickhouse
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
|
||||
[Overview](clickhouse_user.md) | [Parameters](clickhouse_user_params.md) | [Operations](clickhouse_user_ops.md)
|
||||
@@ -1,71 +0,0 @@
|
||||
# Resource nubes_d_e_p_r_e_c_a_t_e_d
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
Service Name: DEPRECATED Правила маршрутизации для VM (vc_nat)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
## MAN
|
||||
|
||||
Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Summary
|
||||
|
||||
Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
```text
|
||||
resource "nubes_d_e_p_r_e_c_a_t_e_d" "example" {
|
||||
delete_mode = "state_only"
|
||||
resume_if_exists = НЕТ
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Outputs
|
||||
|
||||
- `state_params` (map)
|
||||
- `state_out` (map)
|
||||
- `state_params_flat` (map)
|
||||
- `state_out_flat` (map)
|
||||
- `vault_secrets` (map)
|
||||
- `vault_url` (string)
|
||||
- `vault_user_path` (string)
|
||||
- `vault_fields` (list)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Lifecycle defaults
|
||||
|
||||
- `delete_mode_default` = `state_only`
|
||||
- `resume_if_exists_default` = `False`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Lifecycle behavior
|
||||
|
||||
- If suspend/resume exist, delete maps to suspend and apply can resume.
|
||||
- Advanced users may override delete_mode and resume_if_exists.
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: d_e_p_r_e_c_a_t_e_d
|
||||
|
||||
Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED
|
||||
@@ -1,13 +0,0 @@
|
||||
# Resource nubes_d_e_p_r_e_c_a_t_e_d
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
Service Name: DEPRECATED Правила маршрутизации для VM (vc_nat)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
@@ -1,13 +0,0 @@
|
||||
# Resource nubes_d_e_p_r_e_c_a_t_e_d
|
||||
|
||||
Service ID: `24`
|
||||
|
||||
Service Name: DEPRECATED Правила маршрутизации для VM (vc_nat)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
|
||||
[Overview](d_e_p_r_e_c_a_t_e_d.md) | [Parameters](d_e_p_r_e_c_a_t_e_d_params.md) | [Operations](d_e_p_r_e_c_a_t_e_d_ops.md)
|
||||
@@ -1,13 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,49 +0,0 @@
|
||||
# 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 = "2.1.23"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Токен доступа api_token к Nubes API — замените на реальный.
|
||||
provider "nubes" {
|
||||
api_token = "token_***"
|
||||
api_endpoint = "https://lk-api-gateway.ngcloud.ru/api/v1/svc" <!-- ⛔ LEGACY index.cfm удалён, заменён на Gateway -->
|
||||
}
|
||||
resource "nubes_dnsrecord" "baza" {
|
||||
zone_uid = "TODO" # UUID экземпляра услуги DNS-зоны
|
||||
record_type = "A" # Тип DNS-записи
|
||||
record_name = "TODO" # Имя записи. Имя зоны в конце проставляется автоматически
|
||||
record_input = "TODO" # Значение. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP
|
||||
|
||||
# Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
|
||||
record_t_t_l = 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
|
||||
```
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_example.md) | [Parameters](dnsrecord_example_params.md) | [Operations](dnsrecord_example_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_example.md) | [Parameters](dnsrecord_example_params.md) | [Operations](dnsrecord_example_ops.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для dnsrecord
|
||||
|
||||
Необходима DNS зона, в которой будет создана DNS запись.<br/>Выберите <br/>* Зону в которой будет создана запись<br/>* Тип записи<br/>* Имя записи<br/>* Значение записи
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: dnsrecord
|
||||
|
||||
Необходима DNS зона, в которой будет создана DNS запись.<br/>Выберите <br/>* Зону в которой будет создана запись<br/>* Тип записи<br/>* Имя записи<br/>* Значение записи
|
||||
@@ -1,13 +0,0 @@
|
||||
# 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)
|
||||
@@ -1,41 +0,0 @@
|
||||
# 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) — список ключей доступных секретов
|
||||
|
||||
## Реальные поля из облака (test / A-record (admin.1dbfe9da-ce1c-4958-b359-d016a4b455c8) / running)
|
||||
|
||||
Поля ниже получены из реальных инстансов этого сервиса в облаке.
|
||||
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
|
||||
|
||||
### `state_params` ключи
|
||||
|
||||
- `state_params["zoneUid"]`
|
||||
- `state_params["recordTTL"]`
|
||||
- `state_params["recordName"]`
|
||||
- `state_params["recordType"]`
|
||||
- `state_params["recordInput"]`
|
||||
|
||||
### `state_out_flat` ключи
|
||||
|
||||
- `state_out_flat["record"]`
|
||||
- `state_out_flat["dnsServers"]`
|
||||
|
||||
### `vault_secrets` ключи
|
||||
|
||||
- `vault_secrets["fields"]`
|
||||
- `vault_secrets["userPath"]`
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_outputs.md) | [Parameters](dnsrecord_outputs_params.md) | [Operations](dnsrecord_outputs_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_outputs.md) | [Parameters](dnsrecord_outputs_params.md) | [Operations](dnsrecord_outputs_ops.md)
|
||||
@@ -1,12 +0,0 @@
|
||||
# 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)
|
||||
@@ -1,27 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_params_create.md) | [Parameters](dnsrecord_params_create_params.md) | [Operations](dnsrecord_params_create_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_params_create.md) | [Parameters](dnsrecord_params_create_params.md) | [Operations](dnsrecord_params_create_ops.md)
|
||||
@@ -1,15 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_params_modify.md) | [Parameters](dnsrecord_params_modify_params.md) | [Operations](dnsrecord_params_modify_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnsrecord_params_modify.md) | [Parameters](dnsrecord_params_modify_params.md) | [Operations](dnsrecord_params_modify_ops.md)
|
||||
@@ -1,13 +0,0 @@
|
||||
# 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">
|
||||
##  Необходимо делегировать зону у регистратора на Авторитетные 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>
|
||||
@@ -1,52 +0,0 @@
|
||||
# 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 = "2.1.23"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Токен доступа api_token к Nubes API — замените на реальный.
|
||||
provider "nubes" {
|
||||
api_token = "token_***"
|
||||
api_endpoint = "https://lk-api-gateway.ngcloud.ru/api/v1/svc" <!-- ⛔ LEGACY index.cfm удалён, заменён на Gateway -->
|
||||
}
|
||||
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
|
||||
```
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnszone_example.md) | [Parameters](dnszone_example_params.md) | [Operations](dnszone_example_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnszone_example.md) | [Parameters](dnszone_example_params.md) | [Operations](dnszone_example_ops.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Инструкция для dnszone
|
||||
|
||||
##  Необходимо делегировать зону у регистратора на Авторитетные 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/>```
|
||||
@@ -1,3 +0,0 @@
|
||||
# MAN: dnszone
|
||||
|
||||
##  Необходимо делегировать зону у регистратора на Авторитетные 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/>```
|
||||
@@ -1,12 +0,0 @@
|
||||
# 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`
|
||||
@@ -1,41 +0,0 @@
|
||||
# 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) — список ключей доступных секретов
|
||||
|
||||
## Реальные поля из облака (prod / supermax / running)
|
||||
|
||||
Поля ниже получены из реальных инстансов этого сервиса в облаке.
|
||||
Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
|
||||
|
||||
### `state_params` ключи
|
||||
|
||||
- `state_params["zoneTtl"]`
|
||||
- `state_params["zoneKind"]`
|
||||
- `state_params["zoneName"]`
|
||||
- `state_params["zoneEmail"]`
|
||||
- `state_params["zoneRetry"]`
|
||||
- `state_params["zoneExpire"]`
|
||||
- `state_params["zoneRefresh"]`
|
||||
- `state_params["resourceRealm"]`
|
||||
- `state_params["zoneMastersForSlave"]`
|
||||
|
||||
### `state_out_flat` ключи
|
||||
|
||||
- `state_out_flat["dnsServers"]`
|
||||
- `state_out_flat["zoneSerial"]`
|
||||
- `state_out_flat["zoneSoaServer"]`
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnszone_outputs.md) | [Parameters](dnszone_outputs_params.md) | [Operations](dnszone_outputs_ops.md)
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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)
|
||||
|
||||
[Overview](dnszone_outputs.md) | [Parameters](dnszone_outputs_params.md) | [Operations](dnszone_outputs_ops.md)
|
||||
@@ -1,12 +0,0 @@
|
||||
# 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)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user