terraform/tf_provider
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add: HAR traces

Browse Source
This commit is contained in:
“Naeel”
2026-06-30 15:46:41 +04:00
parent 1a52506fb1
commit 250a8a6be2
940 changed files with 14409 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/api-meta/dev/services/1.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":1,"svc":"Болванка","svcShort":"dummy","code":null,"version":"master","orchestratorName":"Service","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":7,"iconSrc":null,"descr":"Болванка для тестов","man":"## Болванка для тестов.<br/><br/>А это просто много букв, чтобы посмотреть, как ведет себя текст при переполнении контейнера. <br/><br/><br/>``` json<br/>{<br/> &quot;iamServiceUrl&quot;: &quot;https://auth-api-test.ngcloud.ru/api/v1/user&quot;,<br/> &quot;idpResponse&quot;: {<br/> &quot;prefix&quot;: {<br/> &quot;charset&quot;: &quot;&quot;,<br/> &quot;status_text&quot;: &quot;Request Time-out&quot;,<br/> &quot;text&quot;: true,<br/> &quot;errordetail&quot;: &quot;&quot;,<br/> &quot;filecontent&quot;: &quot;Connection Timeout&quot;,<br/> &quot;responseheader&quot;: {},<br/> &quot;header&quot;: &quot;&quot;,<br/> &quot;statuscode&quot;: &quot;408 Request Time-out&quot;,<br/> &quot;status_code&quot;: 408,<br/> &quot;mimetype&quot;: &quot;Unable to determine MIME type of file.&quot;<br/> }<br/> }<br/>}<br/>```","operations":[{"svcOperationId":18,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/create/job/master/buildWithParameters","descr":"Это описание операции CREATE сервиса Болванка","man":"Это мануал к операции CREATE сервиса Болванка"},{"svcOperationId":240,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/redeploy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":92,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":71,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":94,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":93,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/dummy/job/Service/job/suspend/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/100.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":100,"svc":"Serverless Openwhisk (openwhisk_tenant)","svcShort":"openwhisk","code":null,"version":null,"orchestratorName":"OpenWhisk","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/tenantOpenwhisk/job/serviceCreate/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":5,"iconSrc":null,"descr":"Добавление и удаления пользователя (учетной записи, тенанта) для работы с Openwhisk","man":"Добавление и удаления пользователя для работы с Openwhisk","operations":[{"svcOperationId":42,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/tenantOpenwhisk/job/serviceDelete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":41,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/tenantOpenwhisk/job/serviceCreate/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/109.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":51,"svc":{"svcId":109,"svc":"dnsRecordV2","svcShort":"rec2","code":null,"version":"master","orchestratorName":"RecordV2","createUrl":null,"isProductionReady":false,"resourceRealmTypeId":4,"iconSrc":null,"descr":null,"man":null,"operations":[]},"runDurationMs":51}
artifacts/api-meta/dev/services/110.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":47,"svc":{"svcId":110,"svc":"DNS зона","svcShort":"dnszone","code":null,"version":"master","orchestratorName":"Zones","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Zones/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":4,"iconSrc":"https://www.svgrepo.com/download/530451/dns.svg","descr":"Хостинг DNS зоны","man":"## ![image](https://img.icons8.com/?size=50&id=41400&format=png) Необходимо делегировать зону у регистратора на Авторитетные DNS (Сервера зон)<br/><br/>ns3.ngcloud.ru<br/>``` bash<br/>185.247.187.83<br/>2a10:aa80:0:5::3<br/>```<br/><br/>ns4.ngcloud.ru<br/>``` bash<br/>81.22.46.43<br/>2a10:aa80:0:6::3<br/>```","operations":[{"svcOperationId":43,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Zones/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":44,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Zones/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":47}
artifacts/api-meta/dev/services/111.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":47,"svc":{"svcId":111,"svc":"DNS запись","svcShort":"dnsrecord","code":null,"version":"master","orchestratorName":"Records","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Records/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":4,"iconSrc":"https://www.svgrepo.com/download/530451/dns.svg","descr":"DNS запись в созданной зоне","man":"Необходима DNS зона, в которой будет создана DNS запись.<br/>Выберите <br/>* Зону в которой будет создана запись<br/>* Тип записи<br/>* Имя записи<br/>* Значение записи","operations":[{"svcOperationId":46,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Records/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":45,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Records/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":90,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/powerdns/job/Records/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":47}
artifacts/api-meta/dev/services/112.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":56,"svc":{"svcId":112,"svc":"Тенант в Grafana","svcShort":"tenant","code":null,"version":"master","orchestratorName":"Tenant","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/grafana/job/Tenant/job/create/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":6,"iconSrc":null,"descr":"Организация доступов к мониторингу","man":null,"operations":[{"svcOperationId":84,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/grafana/job/Tenant/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":86,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/grafana/job/Tenant/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":87,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/grafana/job/Tenant/job/modify/job/master/buildWithParameters","descr":"Просто удаляет все текущие датасоурсы и ставит их заново<br/>Полезно, когда нужно &quot;ресетнуть&quot; / &quot;добавить&quot;","man":"Просто удаляет все текущие датасоурсы и ставит их заново<br/>Полезно, когда нужно &quot;ресетнуть&quot; / &quot;добавить&quot;"}]},"runDurationMs":56}
artifacts/api-meta/dev/services/113.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":64,"svc":{"svcId":113,"svc":"Быстрый старт","svcShort":"vcComplex","code":null,"version":"master","orchestratorName":"Complex","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/vcComplex/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Создание готовой иерархии ресурсов","man":"# Создает окружение для ВМ.<br/><br/>## Создает сервисы:<br/>**Организация**<br/>**Виртуальный датацентр**<br/>**Каталог**<br/>**Сетевой шлюз периметра**<br/><br/>","operations":[{"svcOperationId":107,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/vcComplex/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":64}
artifacts/api-meta/dev/services/115.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":54,"svc":{"svcId":115,"svc":"Mariadb","svcShort":"mariadb","code":"paas.mariadb.0","version":"master","orchestratorName":"Mariadb","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Управляемая база данных MariaDb","man":"Mariadb кластер. Ресурсная платформа: k8s. Автоматизация: k8s operator.<br/>Автоматическое резервное копирование, ручное восстановление.","operations":[{"svcOperationId":142,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":247,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/delete_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":242,"operation":"create_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/create_database/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":248,"operation":"delete_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/delete_database/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":138,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":243,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/create_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":139,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":140,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":141,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Mariadb/job/resume/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":55}
artifacts/api-meta/dev/services/116.json
+1
View File
File diff suppressed because one or more lines are too long
artifacts/api-meta/dev/services/119.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":119,"svc":"Akhq","svcShort":"Akhq","code":null,"version":"master","orchestratorName":"Akhq","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/create/job/","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Web интерфейс Akhq для работы с Apache Kafka","man":"# Инструкция по развертыванию 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/>---","operations":[{"svcOperationId":177,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/suspend/job/","descr":null,"man":null},{"svcOperationId":178,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/resume/job/","descr":null,"man":null},{"svcOperationId":180,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/modify/job/","descr":null,"man":null},{"svcOperationId":175,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/create/job/","descr":null,"man":null},{"svcOperationId":176,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Akhq/job/delete/job/","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/12.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":49,"svc":{"svcId":12,"svc":"S3 Object Storage","svcShort":"s3","code":"paas.s3.ceph","version":"master","orchestratorName":"Ceph","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":1,"iconSrc":"https://upload.wikimedia.org/wikipedia/commons/3/32/AWS_Simple_Icons_Storage_Amazon_S3.svg","descr":"Масштабируемое хранилище данных","man":"Руководство доступно по ссылке:<br/>https://docs.s3.msk-1.ngcloud.ru/s3/s3.description.html","operations":[{"svcOperationId":1,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":5,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":3,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":2,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":6,"operation":"create_sub_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/create_sub_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":7,"operation":"delete_sub_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/delete_sub_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":4,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Ceph/job/modify/job/master/buildWithParameters","descr":"При первичном вызове операции услуга Trial прекращает действие","man":"При первичном вызове операции услуга Trial прекращает действие"}]},"runDurationMs":49}
artifacts/api-meta/dev/services/120.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":51,"svc":{"svcId":120,"svc":"ClickHouse","svcShort":"clickhouse","code":null,"version":"master","orchestratorName":"ClickHouse","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Управляемая база данных ClickHouse","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 &quot;http://&lt;username&gt;:&lt;password&gt;@&lt;host&gt;:8123/&quot; -d &quot;SELECT 1&quot;<br/><br/># Выполнение запроса<br/>curl &quot;http://&lt;username&gt;:&lt;password&gt;@&lt;host&gt;:8123/&quot; -d &quot;SHOW DATABASES&quot;<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/>```","operations":[{"svcOperationId":189,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":183,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/resume/job/master/buildWithParameters","descr":"Восстанавливает все поды и приводит кластер в работоспособный вид","man":null},{"svcOperationId":185,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/create_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":186,"operation":"create_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/create_database/job/master/buildWithParameters","descr":null,"man":"База данных создаётся на всех репликах кластера ClickHouse"},{"svcOperationId":187,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/delete_user/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":188,"operation":"delete_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/delete_database/job/master/buildWithParameters","descr":null,"man":"Необратимое действие!!!<br/>Трижды подумай, заблокируй телефон тимлида и не выполняй это действие"},{"svcOperationId":181,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/create/job/master/buildWithParameters","descr":null,"man":"Операция создания кластера ClickHouse<br/><br/>Для подключения к кластеру также необходимо создать базу данных через операцию `create_database` и создание пользователя через операцию `create_user`"},{"svcOperationId":182,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/suspend/job/master/buildWithParameters","descr":null,"man":"Операция приводит к удалению всех подов<br/>Persistent Volume остаются нетронутыми"},{"svcOperationId":184,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ClickHouse/job/delete/job/master/buildWithParameters","descr":null,"man":"Удаление возможно только после остановки сервиса через операцию `suspend`<br/>После выполнения операции необходимо выждать определенное кол-во времени"}]},"runDurationMs":51}
artifacts/api-meta/dev/services/13.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":50,"svc":{"svcId":13,"svc":"S3 бакет","svcShort":"s3bucket","code":null,"version":"master","orchestratorName":"Bucket","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Bucket/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":1,"iconSrc":"https://upload.wikimedia.org/wikipedia/commons/3/32/AWS_Simple_Icons_Storage_Amazon_S3.svg","descr":"Бакет в сервисе S3","man":null,"operations":[{"svcOperationId":51,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Bucket/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":52,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/s3/job/Bucket/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":50}
artifacts/api-meta/dev/services/149.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":51,"svc":{"svcId":149,"svc":"VALO Cloud","svcShort":"valoTenant","code":null,"version":"master","orchestratorName":"Tenant","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":8,"iconSrc":null,"descr":"Корпоративная система обмена и синхронизации файлов","man":"# Инструкция по развертыванию Тенант Valo через платформу<br/><br/>## 1. Общая информация<br/>Тенант Valo — логический изолированный экземпляр сервиса VALO Cloud, предоставляющий защищённое облачное хранилище, синхронизацию данных и доступ к документам с различных устройств. При создании тенант автоматически разворачивается в тестовом режиме сроком на 2 месяца. Перевод в промышленную эксплуатацию выполняется отдельной операцией.<br/><br/>### Доступные операции<br/><br/>* **create** — создание нового тенанта в тестовом режиме сроком на 2 месяца.<br/>* **modify** — изменение настроек тенанта, включая перевод из ТЕСТ в ПРОД.<br/>* **suspend** — выключение (приостановка работы) тенанта.<br/>* **resume** — включение ранее приостановленного тенанта.<br/>* **delete** — удаление тенанта; доступно только после выполнения операции suspend.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: платформа, на которой будет создан тенант.<br/>Пример значения: `valo.ngcloud.ru`.<br/><br/>### DNS-Префикс<br/>Описание: Будет добавлено в зону valo.ngcloud.ru<br/>Пример значения: `mysimpledomain`.<br/><br/>### Параметры хранилища<br/>Описание: Сколько места будет выделено под использование в тенанте. Данные хранятся в S3. Размер указывается в Gigabytes<br/>Пример значения: `10`.<br/><br/>### Настройки тенанта<br/>Описание: Ряд конфигурации Valo-тенанта, такие как настройки пользователя и доступного функционала<br/>Пример значения: `опционально в рамках настройки`.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>Достаточно развернуть тенант в ТЕСТ. Срок предоставляется в 2 месяца. По истечению срока тенант автоматически переводится в `suspend` на стороне ресурсной платформы<br/><br/>### Промышленное окружение<br/>Для разблокировки используйте операцию `modify`<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Услуга предоставляет следующие выходные параметры (формируются в процессе операций):<br/><br/>### Статус тенанта<br/>Отражает текущее состояние и параметры.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>Тенант всегда создаётся в режиме ТЕСТ и не может быть сразу переведён в ПРОД без операции modify.<br/>Удаление тенанта возможно только после его выключения с помощью операции suspend.<br/>Срок тестового режима составляет 2 месяца с момента создания.<br/>Операции suspend и resume используются для временного управления доступностью сервиса без потери конфигурации.<br/>","operations":[{"svcOperationId":202,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/create/job/master/buildWithParameters","descr":"При создании тенант предоставляется всегда в ТЕСТ (2 месяца с момента создания)<br/>Для продления и переведения в ПРОД, воспользуйтесь в дальнейшем операцией modify","man":null},{"svcOperationId":206,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":203,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":204,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":205,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/valo/job/Tenant/job/resume/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/150.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":64,"svc":{"svcId":150,"svc":"Kubernetes кластер Штурвал","svcShort":"k8sSthutrvalCluster","code":"paas.k8s.stw","version":"master","orchestratorName":"SthutrvalCluster","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Платформа управления K8s<br/>","man":"Перед разворачиванием убедиться, что в облаке есть 2 свободных невыделенных IP в пуле","operations":[{"svcOperationId":110,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":179,"operation":"update_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/update_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":253,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/reconcile/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":173,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":109,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":174,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":108,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SthutrvalCluster/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":64}
artifacts/api-meta/dev/services/151.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":151,"svc":"Vault","svcShort":"k8sOpenbao","code":null,"version":"master","orchestratorName":"Openbao","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Хранилище секретов","man":"# Инструкция по развертыванию Хранилища секретов через платформу<br/><br/>## 1. Общая информация<br/>Хранилище секретов — сервис централизованного и защищённого хранения чувствительных данных (секретов, ключей, конфигураций). Предназначен для использования приложениями и сервисами в Kubernetes с управлением доступом на основе ролей.<br/>В качестве приложения используется открытый проект OpenBao с поддержкой кластерного режима RAFT.<br/><br/>### Доступные операции<br/>**create** — Создание хранилища секретов и инициализация кластера.<br/>**delete** — Удаление хранилища секретов с полной очисткой всех связанных сущностей.<br/>**modify** — Изменение параметров развернутого хранилища секретов.<br/>**suspend** — Приостановка работы кластера без удаления Persistent Volume.<br/>**resume** — Возобновление работы кластера с автоматическим unseal всех нод.<br/>**restart** — Поочередный перезапуск нод с последующим подключением в кластер.<br/>**create_kv** — Создание Key/Value хранилища версии V2.<br/>**delete_kv** — Удаление Key/Value хранилища со всеми содержащимися секретами.<br/>**create_secrets** — Создание секрета внутри Key/Value хранилища.<br/>**delete_secrets** — Удаление секрета из Key/Value хранилища.<br/>**update_secrets** — Обновление значения секрета.<br/>**recovery_secrets** — Откат секрета к указанной версии.<br/>**create_role** — Создание роли для управления Key/Value хранилищем или секретами.<br/>**update_role** — Обновление параметров роли.<br/>**delete_role** — Удаление роли доступа.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: Кластер Kubernetes, в котором будет развернуто приложение.<br/>Формат значения: имя Kubernetes-кластера.<br/><br/>### Имя домена<br/>Описание: Доменное имя сервиса. При указании полного FQDN выполняется проверка DNS A-записи или добавляется А-запись в техническую зону.<br/>Формат значения: secrets.domain.com / mysecretdomain.<br/><br/>### Кол-во реплик<br/>Описание: Количество узлов в кластере.<br/>Формат значения: целое число.<br/><br/>### Квота ядра пода<br/>Описание: Лимит CPU для одного узла. Указывается в milicores (1000 milicores = 1 CPU).<br/>Формат значения: целое число.<br/><br/>### Квота памяти пода<br/>Описание: Лимит оперативной памяти для одного узла. Указывается в megabytes.<br/>Формат значения: целое число.<br/><br/>### Размер диска под хранение секретов<br/>Описание: Объем диска для хранения данных. Фактический объем равен значению, умноженному на количество реплик. Указывается в Gigabytes<br/>Формат значения: целое число.<br/><br/>### Версия OpenBao<br/>Описание: Версия OpenBao для развертывания сервиса.<br/>Формат значения: выбор из предоставленного списка версий.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>Кол-во реплик: 2.<br/>Квота ядра пода: 200.<br/>Квота памяти пода: 256.<br/>Размер диска под хранение секретов: 1.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>### Промышленное окружение<br/>Кол-во реплик: от 3.<br/>Квота ядра пода: от 1000.<br/>Квота памяти пода: от 1024.<br/>Размер диска под хранение секретов: от 10.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>---<br/><br/>## 4. Выходные параметры<br/>Настройки внутри хранилища (kv/secrets/roles) — конфигурации Key/Value, секретов и ролей, созданные соответствующими операциями.<br/>Настройки самого хранилище (сайзинг, объемы) — параметры ресурсов и хранилища данных, примененные к сервису.<br/>Статус кластера (running / suspended) — текущее состояние работы кластера.<br/>url для подключения к веб — адрес веб-интерфейса сервиса.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>При удалении хранилища все данные и настройки безвозвратно удаляются.<br/>При использовании доменного имени требуется корректная настройка DNS.<br/>Операции управления секретами и ролями выполняются только после успешного создания хранилища.<br/>Удаление кластера производится через операцию `suspend`, а удаление становится доступно через 14 дней после остановки кластера<br/>Правило выше не относится к операции `delete_kv` / `delete_secrets` / `delete_role`","operations":[{"svcOperationId":215,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":216,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":237,"operation":"create_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":233,"operation":"delete_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":234,"operation":"restart","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/restart/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":210,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":211,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":238,"operation":"update_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/update_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":239,"operation":"delete_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":232,"operation":"recovery_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/recovery_secrets/job/master/buildWithParameters","descr":null,"man":"Данная операция подразумевает откат на конкретную версию в секрете.<br/><br/>**Это не восстановление удалённого секрета**"},{"svcOperationId":212,"operation":"create_kv","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_kv/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":230,"operation":"update_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":213,"operation":"delete_kv","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_kv/job/master/buildWithParameters","descr":null,"man":"**ОСТОРОЖНО**<br/>Удаление KV подразумевает удаление ВСЕХ secrets внутри этой KV"},{"svcOperationId":231,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":214,"operation":"create_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":236,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/reconcile/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":53}
artifacts/api-meta/dev/services/152.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":54,"svc":{"svcId":152,"svc":"Темплейт k8s-2-clone","svcShort":"template","code":null,"version":"master","orchestratorName":"Template","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/create/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Болванка для тестирования","man":null,"operations":[{"svcOperationId":217,"operation":"create_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/create_topic/job/","descr":null,"man":"# Инструкция по управлению топиками Apache Kafka через платформу<br/><br/>## 1. Общая информация<br/><br/>---<br/><br/>Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.<br/>Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_topic** — Создание топика<br/>- **modify_topic** — Модификация топика<br/>- **delete_topic** — Удаление топика<br/><br/>---<br/><br/>## 2. Параметры создания топика<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового топика:<br/><br/>* **Имя топика**<br/> Название топика.<br/> Должно быть уникальным в пределах кластера.<br/> Пример: `orders-events`.<br/><br/>* **Партиции**<br/> Количество партиций топика.<br/> Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.<br/> Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества<br/> Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.<br/><br/>* **Реплики**<br/> Количество реплик для каждой партиции.<br/> Обычно равно количеству доступных брокеров или меньше.<br/> Пример: `3`.<br/><br/><br/>---<br/><br/>## 4. Параметры модификации топика<br/><br/>Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:<br/><br/>* **Имя топика**<br/> Название топика.<br/> Пример: `orders-events`.<br/><br/>* **Партиции**<br/> Новое количество партиций.<br/> Пример: `12`.<br/><br/>* **Реплики**<br/> Новое количество реплик.<br/> Пример: `2`.<br/><br/>---<br/><br/>## 5. Рекомендации<br/><br/>* Планируйте количество партиций с запасом — уменьшение их числа невозможно.<br/>* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.<br/>* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.<br/><br/>---"},{"svcOperationId":218,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/suspend/job/","descr":null,"man":null},{"svcOperationId":219,"operation":"modify_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/modify_topic/job/","descr":null,"man":"# Инструкция по управлению топиками Apache Kafka через платформу<br/><br/>## 1. Общая информация<br/><br/>---<br/><br/>Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.<br/>Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_topic** — Создание топика<br/>- **modify_topic** — Модификация топика<br/>- **delete_topic** — Удаление топика<br/><br/>---<br/><br/>## 2. Параметры создания топика<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового топика:<br/><br/>* **Имя топика**<br/> Название топика.<br/> Должно быть уникальным в пределах кластера.<br/> Пример: `orders-events`.<br/><br/>* **Партиции**<br/> Количество партиций топика.<br/> Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.<br/> Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества<br/> Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.<br/><br/>* **Реплики**<br/> Количество реплик для каждой партиции.<br/> Обычно равно количеству доступных брокеров или меньше.<br/> Пример: `3`.<br/><br/><br/>---<br/><br/>## 4. Параметры модификации топика<br/><br/>Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:<br/><br/>* **Имя топика**<br/> Название топика.<br/> Пример: `orders-events`.<br/><br/>* **Партиции**<br/> Новое количество партиций.<br/> Пример: `12`.<br/><br/>* **Реплики**<br/> Новое количество реплик.<br/> Пример: `2`.<br/><br/>---<br/><br/>## 5. Рекомендации<br/><br/>* Планируйте количество партиций с запасом — уменьшение их числа невозможно.<br/>* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.<br/>* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.<br/><br/>---"},{"svcOperationId":220,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/resume/job/","descr":null,"man":null},{"svcOperationId":221,"operation":"delete_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/delete_topic/job/","descr":null,"man":null},{"svcOperationId":222,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/create_user/job/","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user** — Создание пользователя<br/>- **modify_user** — Модификация пользователя<br/>- **delete_user** — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/> Имя удаляемого пользователя.<br/> Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/> Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/> Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **ca.p12**<br/> PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **ca.password**<br/> Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/> Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/> Используется совместно с приватным ключом `user.key` для аутентификации.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **user.key**<br/> Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/> ```<br/><br/>* **user.p12**<br/> PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **user.password**<br/> Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: kafka-4<br/>spec:<br/> volumes:<br/> - name: work<br/> emptyDir: {}<br/> containers:<br/> - name: kcat<br/> image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/> command: [&quot;sleep&quot;, &quot;5600&quot;]<br/> volumeMounts:<br/> - name: work<br/> mountPath: /work<br/> restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \\<br/> --bootstrap-server kafkak8s-bootstrap-external:9093 \\<br/> --command-config /work/user-read.properties \\<br/> --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --from-beginning \\<br/> --group &lt;group&gt; \\<br/> --consumer.config /work/user-read.properties \\<br/> --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -L \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-write.crt \\<br/> -X ssl.key.location=./user-write.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -o beginning \\<br/> -q \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>---"},{"svcOperationId":223,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/create/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":224,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/modify/job/","descr":null,"man":null},{"svcOperationId":225,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/delete/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":226,"operation":"modify_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/modify_user/job/","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user** — Создание пользователя<br/>- **modify_user** — Модификация пользователя<br/>- **delete_user** — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/> Имя удаляемого пользователя.<br/> Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/> Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/> Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **ca.p12**<br/> PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **ca.password**<br/> Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/> Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/> Используется совместно с приватным ключом `user.key` для аутентификации.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **user.key**<br/> Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/> ```<br/><br/>* **user.p12**<br/> PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **user.password**<br/> Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: kafka-4<br/>spec:<br/> volumes:<br/> - name: work<br/> emptyDir: {}<br/> containers:<br/> - name: kcat<br/> image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/> command: [&quot;sleep&quot;, &quot;5600&quot;]<br/> volumeMounts:<br/> - name: work<br/> mountPath: /work<br/> restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \\<br/> --bootstrap-server kafkak8s-bootstrap-external:9093 \\<br/> --command-config /work/user-read.properties \\<br/> --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --from-beginning \\<br/> --group &lt;group&gt; \\<br/> --consumer.config /work/user-read.properties \\<br/> --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -L \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-write.crt \\<br/> -X ssl.key.location=./user-write.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -o beginning \\<br/> -q \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>---"},{"svcOperationId":227,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Kafka/job/delete_user/job/","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user** — Создание пользователя<br/>- **modify_user** — Модификация пользователя<br/>- **delete_user** — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/> Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/> Пример: `username-admin`<br/><br/>* **Топик**<br/> Название топика, к которому будут назначены права для данного пользователя.<br/> Пример: `orders-events`.<br/> Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/> Список разрешённых операций на указанном топике.<br/> Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/> Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/> Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/> Список хостов или подсетей, с которых разрешено подключение пользователя.<br/> Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/> Имя удаляемого пользователя.<br/> Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/> Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/> Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **ca.p12**<br/> PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **ca.password**<br/> Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/> Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/> Используется совместно с приватным ключом `user.key` для аутентификации.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/> ```<br/><br/>* **user.key**<br/> Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/> ```<br/><br/>* **user.p12**<br/> PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/> Выдаеться в формате base64 для получения файла сертификата использовать команду<br/> ```bash<br/> echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/> ```<br/><br/>* **user.password**<br/> Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: kafka-4<br/>spec:<br/> volumes:<br/> - name: work<br/> emptyDir: {}<br/> containers:<br/> - name: kcat<br/> image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/> command: [&quot;sleep&quot;, &quot;5600&quot;]<br/> volumeMounts:<br/> - name: work<br/> mountPath: /work<br/> restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \\<br/> --bootstrap-server kafkak8s-bootstrap-external:9093 \\<br/> --command-config /work/user-read.properties \\<br/> --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \\<br/> --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \\<br/> --topic &lt;topic&gt; \\<br/> --from-beginning \\<br/> --group &lt;group&gt; \\<br/> --consumer.config /work/user-read.properties \\<br/> --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -L \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-write.crt \\<br/> -X ssl.key.location=./user-write.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \\<br/> -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \\<br/> -t write-test \\<br/> -o beginning \\<br/> -q \\<br/> -X security.protocol=SSL \\<br/> -X ssl.ca.location=./ca.crt \\<br/> -X ssl.certificate.location=./user-read.crt \\<br/> -X ssl.key.location=./user-read.key \\<br/> -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>---"}]},"runDurationMs":55}
artifacts/api-meta/dev/services/153.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":53,"svc":{"svcId":153,"svc":"Nifi","svcShort":"nifi","code":null,"version":"master","orchestratorName":"Nifi","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nifi/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"ETL-система","man":null,"operations":[{"svcOperationId":235,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nifi/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":229,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nifi/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":54}
artifacts/api-meta/dev/services/19.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":56,"svc":{"svcId":19,"svc":"Организация в Cloud Director","svcShort":"vcOrg","code":null,"version":"master","orchestratorName":"Org","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":null,"man":"# Инструкция по развертыванию Организация в Cloud Director через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Организация в Cloud Director** предназначен для управления изолированными организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой организации с заданными характеристиками и типом доступа.<br/>**delete** — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей.<br/>**modify** — Изменение параметров внутри организации (на текущий момент поддерживается изменение ipSpaces).<br/>**suspend** — Заморозка организации, ограничение возможности изменения и добавления сущностей.<br/>**resume** — Разморозка организации, восстановление функций управления.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: платформа, на которой будет создана организация.<br/>Пример значения: `ngcloud.ru`.<br/><br/>### Тип организации<br/>Описание: тип создаваемой организации.<br/>Варианты:<br/>- `iaas` — организация с прямым доступом к облаку и авторизацией через Keycloak.<br/>- `saas` — организация под управлением Nubes, без прямого доступа к облаку.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Тип организации: `iaas` для обеспечения полного доступа к облачным ресурсам и самостоятельного управления.<br/><br/>### Промышленное окружение<br/>- Тип организации: `saas` (упрощённая модель использования).<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Услуга предоставляет следующие выходные параметры (формируются в процессе операций):<br/><br/>### Url организации<br/>Для быстрого доступа в тенант<br/><br/>### Статус организации<br/>Отражает текущее состояние и параметры.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- Для конфигурации внешних IP внутри организации необходимо предварительно создать:<br/>-- хотя бы один **Виртуальный датацентр (VDC)** привязанный к этой организации;<br/>-- хотя бы один **Сетевой шлюз периметра (Edge Gateway)**, привязанный к vdc выше.<br/>- Удаление организации возможно только через 14 дней после перевода в состояние suspend.<br/>- Удаление организации приводит к удалению всех связанных сущностей: VDC, Edge Gateway, пулов IP, сетей, ВМок и иных объектов.<br/>- Операция suspend не останавливает виртуальные машины, но блокирует любые изменения инфраструктуры внутри организации.<br/>- Для iaas-организаций доступ осуществляется через Keycloak.","operations":[{"svcOperationId":143,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/suspend/job/master/buildWithParameters","descr":null,"man":"Операция **не останавливает ВМки** в облаке, но не даёт редактировать все сущности внутри тенанта"},{"svcOperationId":144,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":136,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/create/job/master/buildWithParameters","descr":null,"man":"`IaaS` - Доступ в Keycloak предоставляется пользователю, который создаёт услугу<br/>`SaaS` - Без доступа к Keycloak"},{"svcOperationId":137,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/delete/job/master/buildWithParameters","descr":null,"man":"Удалить возможно только через 14 дней после выполнения операции `suspend`<br/>**ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого тенанта**<br/><br/>Если существуют инстансы VDC, Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к `технической поддержке` для удаления инстансов"},{"svcOperationId":249,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/reconcile/job/master/buildWithParameters","descr":"Необходимо для актуализации состояния организации.<br/>Операция приводит инстанс услуги к текущей целевой модели, принятой в Личном Кабинете: обновляет информацию из Cloud Director, производит миграцию состояния услуги до последней версии схемы","man":null},{"svcOperationId":207,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Org/job/modify/job/master/buildWithParameters","descr":null,"man":"Для возможности изменения параметров предварительно необходимо создать **Виртуальный датацентр (VDC)**, потом **Сетевой шлюз периметра (Edge Gateway)**<br/>Также при удалении ipSpaces убедитесь, что все внешние IP удалены. В случае если хоть одна привязка vIP есть, данный ipSpace удалён **не будет**"}]},"runDurationMs":56}
artifacts/api-meta/dev/services/2.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":49,"svc":{"svcId":2,"svc":"Темплейт k8s","svcShort":"template","code":null,"version":"master","orchestratorName":"Template","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Болванка для тестирования","man":null,"operations":[{"svcOperationId":75,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":74,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":97,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":76,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":98,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Template/job/resume/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":49}
artifacts/api-meta/dev/services/20.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":104,"svc":{"svcId":20,"svc":"Организация [DEPRECATED]","svcShort":"vcOrgSaas","code":null,"version":"master","orchestratorName":"OrgSaas","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/OrgSaas/job/create/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Без интеграции Keycloak","man":"Верхнеуровневая сущность создаваемая для Заказчика.<br/>Внутри Организация вы можете создать: Виртуальные датацентры, Каталоги.","operations":[{"svcOperationId":118,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/OrgSaas/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":119,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/OrgSaas/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":23,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/OrgSaas/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":8,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/OrgSaas/job/create/job/master/buildWithParameters","descr":"Создание организации в Cloud Director<br/>Id в клауд директоре создаётся на основе contragentCode","man":"Создание организации в Cloud Director<br/>Id в клауд директоре создаётся на основе contragentCode"}]},"runDurationMs":104}
artifacts/api-meta/dev/services/21.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":56,"svc":{"svcId":21,"svc":"Виртуальный датацентр (vDC)","svcShort":"vc_vdc","code":null,"version":"master","orchestratorName":"Vdc","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Выделение вычислительных ресурсов","man":"# Инструкция по развертыванию Виртуальный датацентр (vDC) через платформу<br/><br/>## 1. Общая информация<br/><br/>**Виртуальный датацентр (vDC)** — это логическая изолированная среда в VMware Cloud Director, предназначенная для размещения и управления виртуальными машинами, сетевой инфраструктурой и ресурсами хранения. Сервис обеспечивает выделение вычислительных ресурсов под конкретную организацию и предоставляет гибкие параметры масштабирования, контроля потребления и разделения ресурсов.<br/><br/>### Доступные операции<br/><br/>**create** — Создание виртуального датацентра (vDC) с заданными параметрами CPU, RAM, Storage и сетевой конфигурацией.<br/>**delete** — Удаление vDC. Требуется предварительный перевод vDC в состояние *suspend*. Полное удаление возможно через 14 дней.<br/>**modify** — Внесение изменений в параметры ресурсов (CPU/RAM/Storage), выделенных для vDC.<br/>**suspend** — Заморозка vDC. Новые ресурсы или изменения внутри vDC становятся невозможными, работа ВМ не останавливается.<br/>**resume** — Разморозка vDC. Восстановление возможности управления сущностями внутри vDC.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Ниже перечислены входные параметры операции **create**.<br/><br/>### UUID Организации<br/>Уникальный идентификатор организации в Cloud Director. Перед созданием vDC требуется предварительное создание услугу `Организация в Cloud Director`.<br/><br/>### Provider VDC в Cloud Director<br/>Свойство ресурсной платформы, определяющее, какой пул физических ресурсов будет использоваться.<br/><br/>### Network Pool в Cloud Director<br/>Определяет возможности сетевой конфигурации, включая создание Edge Gateway и выход во внешние сети.<br/><br/>### Гарантированная доля ЯДЕР<br/>Гарантированный процент вычислительных ресурсов (CPU), закрепленный за vDC. Значение устанавливается разово при создании.<br/><br/>### Гарантированная доля ОЗУ<br/>Гарантированный процент оперативной памяти, закрепленный за vDC. Также задаётся один раз при создании.<br/><br/>### Сколько аллоцировать на VDC ЯДЕР<br/>Количество виртуальных ядер, выделяемых в рамках vDC.<br/><br/>### Сколько аллоцировать на VDC ОЗУ<br/>Количество оперативной памяти в GB, выделяемой для vDC.<br/><br/>### Конфигурация Storage<br/>Набор дисковых политик и их объёмов, выделяемых для vDC. Указывается имя политики и требуемый размер (GB).<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/><br/>- Количество ядер CPU: 10–20<br/>- Аллоцируемая RAM: 16–64 GB<br/>- Гарантированная доля CPU: 20%<br/>- Гарантированная доля RAM: 20%<br/>- Storage:<br/>- Политика `SATA`<br/>- Объём: 100–300 GB<br/><br/>### Промышленное окружение<br/><br/>- Количество ядер CPU: 16–128<br/>- Аллоцируемая RAM: 64–512 GB<br/>- Гарантированная доля CPU: 50%<br/>- Гарантированная доля RAM: 50%<br/>- Storage:<br/>- Политики уровня `SSD`<br/>- Объём: 1–10 TB, выбор несколько политик под разные нагрузки<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Выходные параметры формируются операцией **create** (и используются другими операциями):<br/><br/>### Имя vDC<br/>Уникальный идентификатор созданного виртуального датацентра. Используется в дальнейших операциях (modify, suspend, delete).<br/><br/>### Параметры выделенных ресурсов<br/>Подтверждение итогового объёма CPU/RAM/Storage, выделенных vDC. Используются для учёта и контроля потребления.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- Перед созданием vDC необходимо обеспечить наличие корректно созданной организации и доступных пула ресурсов ресурсной платформы.<br/>- Гарантированная доля CPU и RAM задаётся **однократно при создании vDC**. После развертывания изменить эти значения невозможно; для изменения необходимо пересоздать vDC.<br/>- Удаление vDC возможно только через **14 дней после перевода в состояние *suspend***. Удаление очищает все связанные сущности (ВМ, сети, каталоги), поэтому необходимо убедиться, что данные перенесены.<br/>- Платформа Cloud Director использует концепцию изолированных организационных ресурсов, поэтому корректная настройка Provider VDC и Network Pool является обязательной при создании vDC.<br/>- При изменении параметров (modify) изменяются только показатели CPU, RAM и Storage. Сетевые параметры и гарантированные доли остаются неизменными.<br/>","operations":[{"svcOperationId":112,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":9,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":24,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/delete/job/master/buildWithParameters","descr":null,"man":"Удалить возможно только через 14 дней после выполнения операции `suspend`<br/>**ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого VDC**<br/><br/>Если существуют инстансы Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к `технической поддержке` для удаления инстансов"},{"svcOperationId":250,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/reconcile/job/master/buildWithParameters","descr":"Необходимо для актуализации состояния виртуального ДЦ.<br/>Операция приводит инстанс услуги к текущей целевой модели, принятой в Личном Кабинете: обновляет информацию из Cloud Director, производит миграцию состояния услуги до последней версии схемы","man":null},{"svcOperationId":171,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/suspend/job/master/buildWithParameters","descr":null,"man":"Операция **не останавливает ВМки** в облаке, но не даёт редактировать все сущности внутри VDC"},{"svcOperationId":172,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vdc/job/resume/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":57}
artifacts/api-meta/dev/services/22.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":22,"svc":"Сетевой шлюз периметра (Edge)","svcShort":"vc_nsxt","code":null,"version":"master","orchestratorName":"Nsxt","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Nsxt/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Обеспечение сетевой доступности в тенанте","man":"# Инструкция по развертыванию Сетевой шлюз периметра (Edge) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Сетевой шлюз периметра (Edge)** предназначен для создания периметрового сетевого шлюза в рамках одного виртуального датацентра (vDC) или группы виртуальных датацентров (groupvDC). <br/>При создании автоматически разворачивается routed-сеть с адресным пространством `10.10.102.0/24`. <br/>Сервис обеспечивает сетевую изоляцию, маршрутизацию, а также может включать функциональность балансировщика нагрузки AVI (ALB) для последующей интеграции, включая поддержку кластеров Штурвал.<br/><br/>### Доступные операции<br/><br/>**create** — Создание нового Edge с привязкой к vDC или groupvDC и развёртыванием routed-сети. <br/>**delete** — Удаление ранее созданного Edge. Недоступно при наличии зависимых услуг (vApp, VM, Кластер Штурвал). <br/>**modify** — Изменение параметров и сетевых настроек существующего Edge.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Ниже приведены параметры операции **create**.<br/><br/>### Тип родительской услуги<br/>Определяет контекст размещения Edge. <br/>Допустимые значения: `vdc`, `groupvdc`. <br/>Использование:<br/>- При выборе `vdc` обязателен параметр **UUID VDC**.<br/>- При выборе `groupvdc` обязателен параметр **UUID Группы VDC**.<br/><br/>### UUID VDC<br/>Идентификатор виртуального датацентра. <br/>Необходимо предварительно создать vDC через услугу «Виртуальный датацентр (vDC)». <br/>Указывается только при выборе родительского типа `vdc`.<br/><br/>### UUID Группы VDC<br/>Идентификатор группы виртуальных датацентров. <br/>Создаётся через услугу «Группа виртуальных датацентров (groupvDC)». <br/>Используется при выборе родительского типа `groupvdc`.<br/><br/>### Включить ALB<br/>Флаг активации AVI Load Balancer в Cloud Director. <br/>Пример значения: `true`/`false`. <br/>Нужен для развёртывания кластера Штурвал и возможности создания Virtual Services.<br/><br/>### Наименование segroup<br/>Имя сервиса групп (segroup) на уровне ресурсной платформы. <br/>Обязательно при включённом ALB. <br/>Определяет группу, в которой будут выделяться пулы AVI для Virtual Services.<br/><br/>### virtualServicesCount<br/>Количество резервируемых виртуальных сервисов (Virtual Services) на AVI. <br/>Типичное значение: 1–10 в зависимости от нагрузки.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение (Test)<br/><br/>- Тип родительской услуги: `vdc` <br/>- virtualServicesCount: 1–2 <br/>- ALB: выключен по умолчанию (включать только при необходимости тестирования Штурвала) <br/>- segroup: задаётся только при включённом ALB <br/>- VDC гарантии CPU/RAM: минимальные (поскольку изменить их после создания нельзя)<br/><br/>### Промышленное окружение (Production)<br/><br/>- Тип родительской услуги: `groupvdc` при работе с распределёнными нагрузками или `vdc` для локализованных проектов <br/>- virtualServicesCount: 3–10, исходя из предполагаемого количества публикаций <br/>- ALB: включён, если требуется высокая доступность сервисов или используется кластер Штурвал <br/>- segroup: рекомендуется использовать выделенную группу под проект <br/>- VDC гарантии CPU/RAM: повышенные, с учётом того, что изменить их после создания невозможно без пересоздания vDC<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>### Имя Edge<br/>Уникальное название созданного сетевого шлюза, используется для ссылок и дальнейших операций.<br/><br/>### Имя routed-сети<br/>Автоматически созданная routed-сеть с подсетью `10.10.102.0/24`, используется для подключения ресурсов.<br/><br/>### Параметры Edge<br/>Набор параметров, указанных пользователем при создании: тип услуги, ALB, segroup, virtualServicesCount и др. <br/>Используются в операциях modify и для анализа состояния сервиса.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- В рамках сервиса **один раз при создании задаётся гарантированная доля CPU/RAM vDC**. Изменить её невозможно — требуется пересоздание vDC. <br/>- Удаление Edge недоступно при наличии зависимых ресурсов (vApp, VM, кластер Штурвал). <br/>- При использовании ALB необходимо корректно указывать segroup, чтобы обеспечить корректное выделение пулов AVI. <br/>- При выборе режима `groupvdc` следует учитывать распределение нагрузки между несколькими vDC. <br/>- SNAT для всех ресурсов внутри Edge можно активировать через операцию modify (параметры выделения VIP и ipSpace).<br/><br/>","operations":[{"svcOperationId":111,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Nsxt/job/modify/job/master/buildWithParameters","descr":null,"man":"Для создания SNAT Правила убедитесь, что в организации есть свободные IP<br/>Редактировать кол-во свободных IP можно в услуге `Организация в Cloud Director` -&gt; `modify`"},{"svcOperationId":25,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Nsxt/job/delete/job/master/buildWithParameters","descr":null,"man":"Невозможно удалить если routed-сеть в Edge связана с:<br/>- vApp<br/>- VM<br/>- Kubernetes-кластер Штурвал<br/><br/>Запустить операцию возможно, но будет ошибка"},{"svcOperationId":252,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Nsxt/job/reconcile/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":10,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Nsxt/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/23.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":65,"svc":{"svcId":23,"svc":"VM в Cloud Director (старый формат) (vc_vm)","svcShort":"vc_vm","code":null,"version":"master","orchestratorName":"Vm","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/create/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Виртуальная машина без каких-либо особенностей. <br/>Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ","man":"Виртуальная машина без каких-либо особенностей. <br/>Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ","operations":[{"svcOperationId":26,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":29,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":27,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":28,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":68,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vm/job/modify/job/master/buildWithParameters","descr":"Операция автоматически останавливает ВМ.","man":"Операция автоматически останавливает ВМ."}]},"runDurationMs":65}
artifacts/api-meta/dev/services/24.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":53,"svc":{"svcId":24,"svc":"DEPRECATED Правила маршрутизации для VM (vc_nat)","svcShort":"vcNat","code":null,"version":null,"orchestratorName":"Nat","createUrl":null,"isProductionReady":false,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED","man":"Правила маршрутизации в Cloud Director. Требует наличие сетей, ВМ<br/>DEPRECATED","operations":[]},"runDurationMs":53}
artifacts/api-meta/dev/services/25.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":57,"svc":{"svcId":25,"svc":"Публичные IP адреса","svcShort":"vcexternalip","code":null,"version":"master","orchestratorName":"Ip","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Ip/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Резервирование IP адреса","man":"**Обычно эта услуга разворачивается автоматически при развёртывании более сложных услуг**<br/>Вручную создавать можно, однако услуга требует много параметров, о которых можно просто не знать<br/><br/>Резервировать публичные IP адреса можно только после создания NGcloud Organization, NGcloud Виртуальный датацентр, NGcloud Каталог, Сетевой шлюз периметра.<br/>Вы можете назначить IP адрес для существующего экземпляра сервиса.","operations":[{"svcOperationId":56,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Ip/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":57,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Ip/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":197,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Ip/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":58}
artifacts/api-meta/dev/services/26.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":56,"svc":{"svcId":26,"svc":"Виртуальный каталог ВМ (vApp)","svcShort":"vapp","code":null,"version":"master","orchestratorName":"Vapp","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vapp/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Группировка виртуальных машин","man":"# Инструкция по развертыванию Виртуальный каталог ВМ (vApp) через платформу<br/><br/>## 1. Общая информация<br/><br/>**Виртуальный каталог ВМ (vApp)** — это логическая каталог, объединённая в единый управляемый объект. Сервис предназначен для совместного развертывания, управления жизненным циклом и сетевого взаимодействия набора связанных ВМ. Основные функции включают:<br/>- централизованное управление включением, выключением и приостановкой группы ВМ;<br/>- унифицированный сетевой доступ через привязанный Edge-шлюз;<br/><br/>### Доступные операции<br/><br/>**create** — Создание нового vApp с привязкой к заданным услугам VDC и Edge<br/>**delete** — Удаление существующего vApp. Требуется предварительный перевод vApp в состояние *suspend*. Полное удаление возможно через 14 дней.<br/>**suspend** — Остановка vApp (выключение всех ВМ внутри каталога)<br/>**resume** — Запуск vApp (включение всех ВМ внутри каталога)<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры берутся из операции **create**.<br/><br/>### UUID Услуги VDC<br/>Уникальный идентификатор услуги «Виртуальный датацентр (vDC)».<br/>Используется для определения вычислительной инфраструктуры, в которой будет развернут vApp.<br/><br/>### UUID Услуги Edge<br/>Уникальный идентификатор услуги «Сетевой шлюз периметра (Edge)».<br/>Обеспечивает маршрутизацию и сетевое подключение. Может быть привязан к группе VDC, поэтому выбирается отдельно.<br/><br/>### Имя vApp<br/>Строгое имя, соответствующее маске формирования DNS-имени.<br/>Используется как часть в DNS-имени при создании виртуальных машин.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/>Так как является промежуточным этапом для создания ВМ, все характеристики описываются в услуге `Виртуальная машина`<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>### Параметры vApp<br/>Заданные при создании vApp<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- Привязка к VDC и Edge осуществляется раздельно, поскольку один Edge может обслуживать несколько VDC (через услугу `Группа виртуальных датацентров (groupvDC)`). Это гарантирует возможность развернуть ВМ в единой сети, но в разных виртуальных датацентрах.<br/>- Перед удалением vApp необходимо вручную перевести его в состояние **suspend**. Удаление возможно только спустя 14 дней после этого шага.<br/>- Операция delete удаляет весь vApp полностью, включая все виртуальные машины, связанные с ним.<br/>- Рекомендуется заранее планировать сетевые связи и назначения DNS-имён для обеспечения корректной работы сервисов, развернутых внутри vApp.<br/>- При проектировании инфраструктуры следует учитывать зависимости между Edge-шлюзом, VDC и размещаемыми ВМ, чтобы избежать ограничений при масштабировании и интеграции.","operations":[{"svcOperationId":209,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vapp/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":208,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vapp/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":69,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vapp/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":70,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/Vapp/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":56}
artifacts/api-meta/dev/services/27.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":108,"svc":{"svcId":27,"svc":"VM в Cloud Director (vc_vmV2)","svcShort":"vc_vm_v2","code":null,"version":"master","orchestratorName":"VmV2","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/create/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Виртуальная машина с возможностью настройки Cloud Init<br/>Можно развернуть в услуге несколько ВМ<br/>В зависимости от настроек можно выдавать на ВМ vip + dns","man":null,"operations":[{"svcOperationId":100,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":101,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":102,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":103,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":104,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV2/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":108}
artifacts/api-meta/dev/services/28.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":49,"svc":{"svcId":28,"svc":"Виртуальная машина","svcShort":"vc_vm_v3","code":null,"version":"master","orchestratorName":"VmV3","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Создание виртуальной машины","man":"# Документация по разворачиванию ВМ в Личном кабинете<br/><br/>Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК).<br/><br/>## Доступные операции<br/>- **create** — Создание виртуальной машины<br/>- **delete** — Удаление виртуальной машины<br/>- **resume** — Запуск виртуальной машины<br/>- **suspend** — Остановка виртуальной машины<br/><br/>---<br/><br/>## Параметры для развёртывания ВМ<br/><br/>### Обязательные параметры:<br/><br/>**vappUid**<br/>UUID vApp, в которой будет создаваться виртуальная машина.<br/>*Пример: WZ00400*<br/><br/>**vmName**<br/>Уникальное имя виртуальной машины.<br/>*Пример: test-vm*<br/><br/>**vmCpu**<br/>Количество ядер процессора. Должно быть больше 0.<br/>*Пример: 1*<br/><br/>**vmRam**<br/>Объем оперативной памяти в гигабайтах. Должно быть больше 0.<br/>*Пример: 1*<br/><br/><br/>**accessPortList**<br/>Белый список портов для доступа к виртуальной машине извне в формате JSON.<br/>*Пример: [&quot;22&quot;,&quot;10050]*<br/><br/>**imageVm**<br/>Образ операционной системы для развёртывания.<br/>*Доступные значения: RockyLinux_9-16G-cloudinit, Ubuntu_22-20G, Debian_13-20G*<br/><br/>**userLogin**<br/>Логин пользователя для SSH-доступа.<br/>*По умолчанию: myuser*<br/><br/>**userPublicKey**<br/>Публичный SSH-ключ пользователя в формате OpenSSH.<br/>*Пример: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...*<br/><br/>**needAddZabbixTemplate**<br/>Значение истина\\ложь, определяющее будет ли добавлен хост в zabbix.<br/>*Пример: true*<br/><br/>### Опциональные параметры:<br/><br/>**accessIpList**<br/>Белый список IP-адресов для доступа к виртуальной машине в формате JSON. Если оставить пустым, вм будет доступена со всех адресов.<br/>*Пример: [&quot;192.168.1.1&quot;, &quot;10.0.0.5&quot;]*<br/><br/>**vmDisk**<br/>Размер дополнительного диска в гигабайтах. Должно быть больше 0.<br/>*Пример: 50*<br/><br/>**ipSpaceName**<br/>Внешний IP-адрес. Если не требуется — укажите значение &quot;no-needed&quot; (В нем не будет работать сбор метрик zabbix). <br/><br/>**cloudInit**<br/>YAML-скрипт для кастомизации системы через cloud-init.<br/><br/>---<br/><br/>## Доступные образы операционных систем<br/><br/>### RockyLinux_9-16G-cloudinit<br/>Базовый образ на основе Rocky Linux 9 (Rocky-9.6-x86_64-minimal) для серверных задач.<br/>- Размер системного диска: 16 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Ubuntu_22-20G<br/>Образ на основе Ubuntu Server 22.04 LTS для облачного окружения.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Debian_13-20G<br/>Образ на основе Debian 13 (Trixie) для стабильной серверной работы.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>---<br/><br/>## Пример использования Cloud-init<br/><br/>```yaml<br/>users:<br/> - name: myuser<br/> sudo: ALL=(ALL) NOPASSWD:ALL<br/> groups: sudo<br/> shell: /bin/bash<br/> ssh-authorized-keys:<br/> - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...<br/><br/>packages:<br/> - nginx<br/><br/>runcmd:<br/> - systemctl enable --now nginx<br/> - systemctl restart nginx<br/>```<br/><br/>---<br/><br/>## Результат выполнения<br/><br/>После успешного развёртывания в Личном кабинете появится новая виртуальная машина с заданными характеристиками. SSH-доступ осуществляется с использованием указанных логина и публичного ключа.<br/><br/>---<br/><br/>## Важные примечания<br/><br/>### Особенности работы:<br/>- Для отключения внешнего IP укажите значение &quot;no-needed&quot; в параметре ipSpaceName<br/>- Параметр cloudInit является опциональным<br/><br/>### Ограничения:<br/>- Не рекомендуется использовать продолжительные инструкции в cloud-init (таймаут 5 минут)<br/>- Не поддерживается запись файлов через cloud-init<br/>- Не реализовано создание резервных копий ВМ<br/><br/>---<br/><br/>## Диагностика проблем с cloud-init<br/><br/>### Основной лог-файл:<br/>```bash<br/>/var/log/cloud-init.log<br/>```<br/><br/>### Пакет не устанавливается:<br/>- Проверьте доступность пакета в репозитории<br/>- Убедитесь в правильности написания имени пакета<br/>- Попробуйте установить вручную: `apt install &lt;имя_пакета&gt;` (Debian/Ubuntu) или `dnf install &lt;имя_пакета&gt;` (Rocky Linux)<br/><br/>### Команда не выполняется:<br/>- Проверьте наличие требуемой утилиты в системе<br/>- Убедитесь в правильности синтаксиса команды<br/>- Попробуйте выполнить команду вручную для диагностики","operations":[{"svcOperationId":132,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/create/job/master/buildWithParameters","descr":null,"man":"# Документация по использованию услуги развёртывания ВМ в Личном кабинете<br/><br/>Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК).<br/><br/>## Доступные операции<br/>- **create** — Создание виртуальной машины<br/>- **delete** — Удаление виртуальной машины<br/>- **resume** — Запуск виртуальной машины<br/>- **suspend** — Остановка виртуальной машины<br/><br/>---<br/><br/>## Параметры для развёртывания ВМ<br/><br/>### Обязательные параметры:<br/><br/>**vappUid**<br/>UUID vApp, в которой будет создаваться виртуальная машина.<br/>*Пример: WZ00400*<br/><br/>**vmName**<br/>Уникальное имя виртуальной машины.<br/>*Пример: test-vm*<br/><br/>**vmCpu**<br/>Количество ядер процессора. Должно быть больше 0.<br/>*Пример: 1*<br/><br/>**vmRam**<br/>Объем оперативной памяти в гигабайтах. Должно быть больше 0.<br/>*Пример: 1*<br/><br/><br/>**accessPortList**<br/>Белый список портов для доступа к виртуальной машине извне в формате JSON.<br/>*Пример: [&quot;22&quot;,&quot;10050]*<br/><br/>**imageVm**<br/>Образ операционной системы для развёртывания.<br/>*Доступные значения: RockyLinux_9-16G-cloudinit, Ubuntu_22-20G, Debian_13-20G*<br/><br/>**userLogin**<br/>Логин пользователя для SSH-доступа.<br/>*По умолчанию: myuser*<br/><br/>**userPublicKey**<br/>Публичный SSH-ключ пользователя в формате OpenSSH.<br/>*Пример: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...*<br/><br/>**needAddZabbixTemplate**<br/>Значение истина\\лож определяющее будет ли добавлен хост в zabbix.<br/>*Пример: true*<br/><br/>### Опциональные параметры:<br/><br/>**accessIpList**<br/>Белый список IP-адресов для доступа к виртуальной машине в формате JSON. Если оставить пустым, вм будет доступена со всех адресов.<br/>*Пример: [&quot;192.168.1.1&quot;, &quot;10.0.0.5&quot;]*<br/><br/>**vmDisk**<br/>Размер дополнительного диска в гигабайтах. Должно быть больше 0.<br/>*Пример: 50*<br/><br/>**ipSpaceName**<br/>Внешний IP-адрес. Если не требуется — укажите значение &quot;no-needed&quot;.<br/><br/>**cloudInit**<br/>YAML-скрипт для кастомизации системы через cloud-init.<br/><br/>---<br/><br/>## Доступные образы операционных систем<br/><br/>### RockyLinux_9-16G-cloudinit<br/>Базовый образ на основе Rocky Linux 9 (Rocky-9.6-x86_64-minimal) для серверных задач.<br/>- Размер системного диска: 16 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Ubuntu_22-20G<br/>Образ на основе Ubuntu Server 22.04 LTS для облачного окружения.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Debian_13-20G<br/>Образ на основе Debian 13 (Trixie) для стабильной серверной работы.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>---<br/><br/>## Пример использования Cloud-init<br/><br/>```yaml<br/>users:<br/> - name: myuser<br/> sudo: ALL=(ALL) NOPASSWD:ALL<br/> groups: sudo<br/> shell: /bin/bash<br/> ssh-authorized-keys:<br/> - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...<br/><br/>packages:<br/> - nginx<br/><br/>runcmd:<br/> - systemctl enable --now nginx<br/> - systemctl restart nginx<br/>```<br/><br/>---<br/><br/>## Результат выполнения<br/><br/>После успешного развёртывания в Личном кабинете появится новая виртуальная машина с заданными характеристиками. SSH-доступ осуществляется с использованием указанных логина и публичного ключа.<br/><br/>---<br/><br/>## Важные примечания<br/><br/>### Особенности работы:<br/>- Для отключения внешнего IP укажите значение &quot;no-needed&quot; в параметре ipSpaceName<br/>- Параметр cloudInit является опциональным<br/><br/>### Ограничения:<br/>- Не рекомендуется использовать продолжительные инструкции в cloud-init (таймаут 5 минут)<br/>- Не поддерживается запись файлов через cloud-init<br/>- Не реализовано создание резервных копий ВМ<br/><br/>---<br/><br/>## Диагностика проблем с cloud-init<br/><br/>### Основной лог-файл:<br/>```bash<br/>/var/log/cloud-init.log<br/>```<br/><br/>### Пакет не устанавливается:<br/>- Проверьте доступность пакета в репозитории<br/>- Убедитесь в правильности написания имени пакета<br/>- Попробуйте установить вручную: `apt install &lt;имя_пакета&gt;` (Debian/Ubuntu) или `dnf install &lt;имя_пакета&gt;` (Rocky Linux)<br/><br/>### Команда не выполняется:<br/>- Проверьте наличие требуемой утилиты в системе<br/>- Убедитесь в правильности синтаксиса команды<br/>- Попробуйте выполнить команду вручную для диагностики"},{"svcOperationId":159,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":133,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":134,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":135,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":164,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VmV3/job/redeploy/job/master/buildWithParameters","descr":"Полная потеря данных гарантирована<br/>Но будет полностью сброшенная машина","man":null}]},"runDurationMs":49}
artifacts/api-meta/dev/services/29.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":58,"svc":{"svcId":29,"svc":"Группа датацентров","svcShort":"vcVdcGroup","code":null,"version":"master","orchestratorName":"VdcGroup","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Обеспечение сетевой доступности между датацентрами","man":"# Инструкция по развертыванию Группа виртуальных датацентров (groupvDC) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Группа виртуальных датацентров (groupvDC)** предназначен для логического объединения нескольких виртуальных датацентров (vDC) в единую группу. Это позволяет растягивать SDN между разными vDC и централизованно управлять сетевой связностью. Управление инфраструктурой осуществляется через Cloud Director.<br/>Сервис применяется в случаях, когда требуется обеспечить единое сетевое пространство для распределенных виртуальных датацентров.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой группы виртуальных датацентров.<br/>**delete** — Удаление существующей группы vDC.<br/>**add_vdc** — Добавление дополнительного виртуального датацентра в группу.<br/>**remove_vdc** — Удаление ранее добавленного виртуального датацентра из группы.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры операции **create**:<br/><br/>### UUID VDC<br/>Идентификатор виртуального датацентра, который будет являться первичным в группе.<br/>Описание: требуется предварительно создать виртуальный датацентр с помощью услуги `Виртуальный датацентр (vDC)`.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Для тестового окружения создавать группу VDC нет необходимости, так как это создаёт дополнительный слой абстракции в Cloud Director<br/><br/>### Промышленное окружение<br/>- Для промышленного окружения, если в тенанте существуют разные VDC, создание groupvdc позволит снизить сетевые издержки (за счёт общей сети)<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>### Параметры groupvdc<br/>Набор параметров, указанных пользователем при создании<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>- Группа vDC используется для растягивания SDN между несколькими виртуальными датацентрами. Управление всеми сетевыми элементами внутри группы выполняется Cloud Director.<br/>- Удалить первичный vDC (тот, что был указан при операции **create**) невозможно. Для его удаления необходимо удалить всю группу и создать новую.<br/>- Перед добавлением любого vDC в группу он должен быть предварительно развернут через сервис `Виртуальный датацентр (vDC)`.<br/>- Сети создаются не в этой услуге, а в услуге `Сетевой шлюз периметра (Edge)`. В ней необходимо будет выбрать тип `groupvdc`","operations":[{"svcOperationId":191,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/create/job/master/buildWithParameters","descr":null,"man":"**VDC Группа** нужна для объединения всех VDC в организации в одну логическую группу.<br/>Это позволит, к примеру, создать **общую сеть** для всех VDC в организации<br/><br/>- Для создания группы VDC необходимо указать **инстанс** услуги VDC (`Виртуальный датацентр`)<br/>- **Важный момент** - удалить эту VDC из группы нельзя. Если такая потребность появится, необходимо будет **ПОЛНОСТЬЮ** удалить группу VDC и уже потом создать новую"},{"svcOperationId":192,"operation":"add_vdc","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/add_vdc/job/master/buildWithParameters","descr":null,"man":"**Не нужно** выбирать UUID VDC, который уже был добавлен в группу"},{"svcOperationId":251,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/reconcile/job/master/buildWithParameters","descr":"Необходимо для актуализации состояния группы датацентров.<br/>Операция приводит инстанс услуги к текущей целевой модели, принятой в Личном Кабинете: обновляет информацию из Cloud Director, производит миграцию состояния услуги до последней версии схемы","man":null},{"svcOperationId":193,"operation":"remove_vdc","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/remove_vdc/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":195,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/vc/job/VdcGroup/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":59}
artifacts/api-meta/dev/services/32.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":53,"svc":{"svcId":32,"svc":"vc_vm_postgresql_std","svcShort":"vmpostgre","code":null,"version":null,"orchestratorName":"VmPostgre","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/cloud/job/pgsqlStd/job/create/job/master/buildWithParameters","isProductionReady":false,"resourceRealmTypeId":2,"iconSrc":null,"descr":"Сервис настройки PostgreSQL для виртуальной машины.<br/>Требует наличия ВМ","man":"Сервис настройки PostgreSQL для виртуальной машины.<br/>Требует наличия ВМ","operations":[{"svcOperationId":32,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/cloud/job/pgsqlStd/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":33,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/cloud/job/pgsqlStd/job/delete/job/master/buildWithParameters","descr":"При удалении удаляется раздел с данными. Выполнять осторожно!","man":null}]},"runDurationMs":53}
artifacts/api-meta/dev/services/50.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":51,"svc":{"svcId":50,"svc":"Nextcloud","svcShort":"nextcloud","code":null,"version":"master","orchestratorName":"Nextcloud","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://www.svgrepo.com/download/349455/nextcloud.svg","descr":"Платформа совместной работы","man":"Ресурсная платформа: k8s. Автоматизация: helm chart","operations":[{"svcOperationId":128,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/suspend/job/","descr":"Не работает из за проблемы с отсуствием механизма зануления реплики (в вейлюсах нельзя задать количство реплик)","man":null},{"svcOperationId":129,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/resume/job/","descr":null,"man":null},{"svcOperationId":16,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/create/job/master/buildWithParameters","descr":"Ресурсная платформа берётся из PSQL UUID","man":"DEV-Ветка сборки Nextcloud"},{"svcOperationId":17,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/delete/job/master/buildWithParameters","descr":"DEV-Ветка удаления Nextcloud","man":"DEV-Ветка удаления Nextcloud"},{"svcOperationId":66,"operation":"restart","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/restart/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":67,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nextcloud/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":51}
artifacts/api-meta/dev/services/81.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":77,"svc":{"svcId":81,"svc":"Apache Superset","svcShort":"superset","code":null,"version":"master","orchestratorName":"Superset","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Superset/job/create/job/refactor/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Сервер отчетов","man":"Apache Superset как сервис. <br/>Ресурсная платформа: k8s. <br/>Автоматизация: k8s operator.<br/>Авторизация: 2FA keycloak (для доменного логина @mgmt.nubes.ru)","operations":[{"svcOperationId":13,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Superset/job/delete/job/refactor/buildWithParameters","descr":"DEV-Ветка удаления Superset","man":"DEV-Ветка удаления Superset"},{"svcOperationId":12,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Superset/job/create/job/refactor/buildWithParameters","descr":"DEV-Ветка сборки Superset","man":"DEV-Ветка сборки Superset"}]},"runDurationMs":77}
artifacts/api-meta/dev/services/82.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":50,"svc":{"svcId":82,"svc":"Container Registry","svcShort":"harbor","code":null,"version":"master","orchestratorName":"Registry","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Registry/job/create/job/refactor/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://goharbor.io/img/logos/harbor-icon-color.png","descr":"Реестр для хранения образов контейнеров","man":"Расширенный реестр для управления Docker-образами с enterprise-функциями безопасности, репликации и контроля доступа.<br/>Container Registry позволяет хранить, развертывать и управлять Docker-образами контейнеров в инфраструктуре NGcloud.<br/>Сервис можно использовать в процессе разработки контейнеров. Например, вы можете настроить систему автоматизации на работу с реестром в Container Registry в рамках процесса непрерывной интеграции. Контейнеры идеально подходят для запуска небольших, независимых и легко изменяемых сервисов.<br/>Чтобы начать работу, создайте реестр и загрузите в него Docker-образ<br/>Авторизация: keycloak","operations":[{"svcOperationId":14,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Registry/job/create/job/refactor/buildWithParameters","descr":"DEV-Ветка сборки Harbor","man":"DEV-Ветка сборки Harbor"},{"svcOperationId":15,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Registry/job/delete/job/refactor/buildWithParameters","descr":"DEV-Ветка удаления Harbor","man":"DEV-Ветка удаления Harbor"}]},"runDurationMs":50}
artifacts/api-meta/dev/services/88.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":57,"svc":{"svcId":88,"svc":"k8sZitiController","svcShort":"k8sZitiController","code":null,"version":"master","orchestratorName":"ZitiController","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ZitiController/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Контроллер управления Client to service & service to service Zero trust network<br/>","man":null,"operations":[{"svcOperationId":99,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ZitiController/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":105,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/ZitiController/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":57}
artifacts/api-meta/dev/services/89.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":49,"svc":{"svcId":89,"svc":"Web-сервер с фреймворком Flask","svcShort":"flask","code":"paas.flsk.0","version":"master","orchestratorName":"Flask","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":null,"man":"# Инструкция по развертыванию Web-сервер с фреймворком Flask через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Web-сервер с фреймворком Flask** предназначен для развертывания веб-приложений на базе Flask.<br/><br/>### Доступные операции<br/><br/>create — включить сервис, развернуть веб-приложение с указанными параметрами.<br/>delete — удалить сервис, только после suspend.<br/>modify — изменить настройки сервиса и переразвернуть.<br/>suspend — выключить веб-приложение, остановить обслуживание.<br/>resume — включить веб-приложение после suspend.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Имя домена<br/>Описание: доменное имя для доступа к веб-приложению. Если указан FQDN, происходит проверка DNS на валидность А-записи. А-запись должна указывать на балансировщик ресурсной платформы. Если указано имя в рамках одного октета, оно будет добавлено в публичную DNS-зону.<br/>Пример значения: строка, допустимые FQDN или имя в одном октете. Пример: example.com или myapp.<br/><br/>### Платформа для развертывания<br/>Описание: кластер Kubernetes, в котором будет развернуто приложение.<br/>Пример значения: идентификатор кластера Kubernetes.<br/><br/>### Квота ядра пода<br/>Описание: количество CPU, выделяемое на под, в Milicores.<br/>Пример значения: целое число, например 500 для 0.5 ядра.<br/><br/>### Квота памяти пода<br/>Описание: количество памяти, выделяемое на под, в Megabytes.<br/>Пример значения: целое число, например 512 для 512 MB.<br/><br/>### Кол-во реплик пода<br/>Описание: количество инстансов пода для масштабирования.<br/>Пример значения: целое число, шт, например 2.<br/><br/>### URL Проекта (gitpath)<br/>Описание: полный HTTPS путь до проекта в Git-репозитории.<br/>Пример значения: URL в формате https://github.com/myuser/myproject.git. Доступ к репозиторию должен быть публичным.<br/><br/>### URL HealthCheck<br/>Описание: путь для проверки здоровья приложения внутри пода.<br/>Пример значения: строка, путь, например /api/v1/health.<br/><br/>### Переменные окружения пода<br/>Описание: структура данных, которая будет передана как переменные окружения в под.<br/>Пример значения: ключ-значение, например {&quot;ENV&quot;: &quot;production&quot;}.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Квота ядра пода: 300m (0.3 ядра)<br/>- Квота памяти пода: 256 MB<br/>- Кол-во реплик пода: 1<br/><br/>### Промышленное окружение<br/>- Квота ядра пода: от 1000m (1 ядро) в зависимости от нагрузки<br/>- Квота памяти пода: от 1024 MB (1 GB) с учетом потребностей приложения<br/>- Кол-во реплик пода: от 2 для обеспечения отказоустойчивости<br/><br/>---<br/><br/>## 4. Выходные параметры<br/>Операция create не возвращает явных выходных параметров. Успешное выполнение операции приводит к развертыванию сервиса, доступного по указанному домену.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>- В корне проекта должен находиться файл requirements.txt со списком зависимостей Python.<br/>- Исходный код веб-приложения должен располагаться в директории site.<br/>- Запуск веб-сервера осуществляется командой python app.py.<br/>- Используется версия Python: python:3.12-slim.<br/>- Git-репозиторий должен быть публично доступен для платформы.<br/>- Операция delete возможна только после suspend.<br/>- Операция modify приводит к переразвертыванию с новыми параметрами.","operations":[{"svcOperationId":145,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/","descr":null,"man":null},{"svcOperationId":146,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":89,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/job/delete/job/master/buildWithParameters","descr":null,"man":"Удаление возможно только после остановки сервиса через операцию `suspend`<br/>После выполнения операции необходимо выждать определенное кол-во времени"},{"svcOperationId":125,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/","descr":null,"man":null},{"svcOperationId":88,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Flask/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":49}
artifacts/api-meta/dev/services/90.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":59,"svc":{"svcId":90,"svc":"PostgreSQL","svcShort":"postgres","code":"paas.pg.0","version":"master","orchestratorName":"Pgsql","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg","descr":"Управляемая база данных PostgreSQL","man":"# Инструкция по развертыванию PostgreSQL через платформу<br/><br/>---<br/>## 1. Общая информация<br/><br/>PostgreSQL — это надёжная объектно-реляционная СУБД с открытым исходным кодом, поддерживающая расширенный набор функций, транзакции и хранение сложных типов данных. Развёртывание полностью автоматизировано платформой на базе Zalando Postgres Operator с использованием Kubernetes.<br/><br/>## Доступные операции<br/><br/>- **create** — Создание кластера<br/>- **delete** — Удаление кластера<br/>- **modify** — Модификация кластера<br/>- **suspend** — Остановка кластера<br/>- **resume** — Запуск кластера<br/>- **restart** — Перезапуск кластера<br/>- **recovery** — Восстановление из резервной копии<br/><br/>- **create_user** — Создание пользователя<br/>- **delete_user** — Удаление пользователя<br/><br/>- **create_database** — Создание базы данных<br/>- **delete_database** — Удаление базы данных<br/><br/><br/>---<br/>## 2. Параметры развертывания кластера<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании ресурса PostgreSQL:<br/><br/>* **Платформа для развертывания:**<br/> Платформа для развертывания (среда, в которой будет развернут кластер). Пример: `k8s-3.ext.nubes.ru`.<br/><br/>* **Количество узлов в сети:**<br/> Количество инстансов (реплик) в кластере PostgreSQL. Пример: `2` (master + slave).<br/><br/>* **Квота (megabyte) памяти пода:**<br/> Квота памяти пода в мегабайтах. Пример: `2048`<br/><br/>* **Квота (millicore) ядра пода:**<br/> Квота CPU пода в миликорах (1000 mCPU = 1 vCPU). Пример: `1000`<br/><br/>* **Размер (gigabyte) диска для базы данных:**<br/> Размер диска для хранения данных в гигабайтах. Пример: `20`<br/><br/>* **Выделяет внешний IP для доступа к master:**<br/> Флаг, определяющий, нужно ли выделять внешний IP для доступа к master. Пример: `true` или `false`<br/><br/>* **Имя ipSpace для публикации внешнего IP master:**<br/> Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`<br/><br/>* **Выделяет внешний IP для доступа к slave:**<br/> Флаг для выделения внешнего IP для slave (реплики чтения). Работает, если slave присутствует в кластере.<br/><br/>* **Имя ipSpace для публикации внешнего IP slave:**<br/> Если включен параметр для slave, то поле необходимо заполнить.<br/><br/>* **UUID экземпляра услуги S3:**<br/> UUID экземпляра S3 для хранения резервных копий.<br/><br/>* **Версия PostgreSQL:**<br/> Версия PostgreSQL для развертывания. Пример: `16`<br/><br/>* **Расписание бэкапов (ext_BACKUP_SCHEDULE):**<br/> Необязательный. Cron-выражение для времени запуска бэкапов. По умолчанию: `0 0 * * *` (ежедневно в полночь).<br/><br/>* **Количество сохраняемых бэкапов (ext_BACKUP_NUM_TO_RETAIN):**<br/> Необязательный. Количество сохраняемых бэкапов. По умолчанию: `7`<br/><br/>* **PgPooler (master / slave):**<br/> Флаги включения PgBouncer для подключений на запись и чтение. При включении создаётся отдельный под.<br/><br/>* **Разрешить подключение без SSL (allowNoSSL):**<br/> По умолчанию подключение с sslmode=require. При `true` разрешается подключение без SSL.<br/><br/>* **Автоскейлинг PV (autoScale):**<br/> Включает автоскейлинг тома. Требует настройки autoScalePercentage, autoScaleTechWindow, autoScaleQuotaGb.<br/><br/>* **Дополнительные параметры PostgreSQL (jsonParameters):**<br/> JSON с переменными конфигурации PostgreSQL. Документация: https://www.postgresql.org/docs/current/runtime-config.html<br/><br/>---<br/>## 3. Выходные параметры<br/><br/>После успешного развертывания ресурса PostgreSQL платформа возвращает ряд параметров.<br/><br/>#### externalConnect<br/><br/>Внешние эндпоинты для подключения к кластеру:<br/>- **master** — для операций записи (host: `write.${namespace}`, port: 5432)<br/>- **slave** — для операций чтения (host: `read.${namespace}`, port: 5432)<br/><br/>Пример ответа платформы:<br/><br/>```json<br/>{<br/> &quot;slave&quot;: {<br/> &quot;ip&quot;: &quot;&quot;,<br/> &quot;fqdn&quot;: &quot;&quot;,<br/> &quot;uuid&quot;: &quot;&quot;,<br/> &quot;isExternal&quot;: false<br/> },<br/> &quot;master&quot;: {<br/> &quot;ip&quot;: &quot;&lt;ip&gt;&quot;,<br/> &quot;fqdn&quot;: &quot;write.&lt;namespace&gt;.&lt;cluster-domain&gt;&quot;,<br/> &quot;uuid&quot;: &quot;&lt;uuid&gt;&quot;,<br/> &quot;isExternal&quot;: false<br/> }<br/>}<br/>```<br/><br/>Поля: `ip` — внешний IP; `fqdn` — полное имя хоста; `uuid` — идентификатор; `isExternal` — признак внешнего доступа.<br/><br/>#### internalConnect<br/><br/>Внутренние эндпоинты (FQDN) для подключения из других сервисов внутри той же сети Kubernetes.<br/><br/>Пример ответа платформы:<br/><br/>```json<br/>{<br/> &quot;slave&quot;: &quot;&quot;,<br/> &quot;master&quot;: {<br/> &quot;slave&quot;: &quot;&quot;,<br/> &quot;master&quot;: {<br/> &quot;slave&quot;: &quot;&quot;,<br/> &quot;master&quot;: &quot;postgresqlk8s-master.&lt;namespace&gt;.svc.cluster.local&quot;<br/> }<br/> }<br/>}<br/>```<br/><br/>Для подключения используйте значение `master.master.master` (host для записи) или соответствующее значение slave (host для чтения).<br/><br/>Для подключения используется порт **5432**.<br/><br/>---<br/>## 4. Управление пользователями<br/><br/>### create_user — Создание пользователя<br/><br/>* **Имя пользователя (username):**<br/> Имя создаваемого пользователя. Используется для подключения к базе и настройки прав.<br/> Пример: `myapp_user`<br/><br/>* **Роль (role):**<br/> Тип роли пользователя. Допустимые значения:<br/> - `app_user` — базовые права для DML-операций (SELECT, INSERT, UPDATE, DELETE)<br/> - `ddl_user` — расширенные права: createdb, createrole (управление базами и ролями)<br/><br/>Защищённые имена, которые нельзя использовать: `admin`, `postgres`, `standby`.<br/><br/>### delete_user — Удаление пользователя<br/><br/>* **Имя пользователя (username):**<br/> Имя удаляемого пользователя. Пример: `myapp_user`<br/><br/>Пользователя нельзя удалить, если он является владельцем базы данных. Сначала удалите или передайте владение базами данных другому пользователю.<br/><br/>---<br/>## 5. Управление базами данных<br/><br/>### create_database — Создание базы данных<br/><br/>* **Имя базы данных (dbName):**<br/> Название создаваемой базы данных. Пример: `myapp_db`<br/><br/>* **Владелец базы данных (dbOwner):**<br/> Имя пользователя-владельца базы. Должен существовать в кластере (создан через create_user). Пример: `myapp_user`<br/><br/>### delete_database — Удаление базы данных<br/><br/>* **Имя базы данных (dbName):**<br/> Название удаляемой базы данных. Пример: `myapp_db`<br/>","operations":[{"svcOperationId":241,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/create_user/job/","descr":null,"man":null},{"svcOperationId":244,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/delete_user/job/","descr":null,"man":null},{"svcOperationId":114,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/suspend/job/","descr":null,"man":null},{"svcOperationId":115,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/suspend/job/","descr":null,"man":null},{"svcOperationId":245,"operation":"create_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/create_database/job/","descr":null,"man":null},{"svcOperationId":54,"operation":"restart","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/restart/job/master/buildWithParameters","descr":"ВНИМАНИЕ - Редеплой предполагает УДАЛЕНИЕ подов.<br/>Может быть полная поломка. Крайне осторожно запускать при работе.<br/>Нет возможности нормально мигрировать на другую платформу средствами Redeploy, так как есть привязка к S3. <br/>Поэтому если нужно смигрировать на другой кластер Kubernetes - использовать необходимо Restore","man":"ВНИМАНИЕ - Рестарт предполагает УДАЛЕНИЕ подов.<br/>Может быть полная поломка. Крайне осторожно запускать при работе"},{"svcOperationId":246,"operation":"delete_database","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/delete_database/job/","descr":null,"man":null},{"svcOperationId":19,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/create/job/master/buildWithParameters","descr":"описание","man":"руководство"},{"svcOperationId":20,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":48,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":47,"operation":"recovery","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgsql/job/recovery/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":59}
artifacts/api-meta/dev/services/91.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":48,"svc":{"svcId":91,"svc":"Redis","svcShort":"redis","code":null,"version":"master","orchestratorName":"Redis","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Redis/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://www.svgrepo.com/download/303460/redis-logo.svg","descr":"Управляемая база данных Redis","man":"Redis кластер. Под кеши. <br/>Ресурсная платформа: k8s. <br/>Автоматизация: k8s operator<br/>port 6379","operations":[{"svcOperationId":22,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Redis/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":21,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Redis/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":48}
artifacts/api-meta/dev/services/92.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":92,"svc":"MongoDB","svcShort":"mongodb","code":"paas.mngo.0","version":"master","orchestratorName":"MongoDB","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/create/job/","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Управляемая база данных MongoDB","man":"# Инструкция по развертыванию MongoDB через платформу<br/><br/>## 1. Общая информация<br/><br/>MongoDB — документоориентированная распределённая база данных, обеспечивающая высокую доступность, горизонтальное масштабирование и гибкую модель хранения.<br/><br/>### Доступные операции с кластером<br/><br/>* **create** — создание базы<br/>* **delete** — удаление базы данных<br/>* **suspend** — остановка базы данных<br/>* **resume** — запуск базы данных<br/>* **modify** — изменение базы данных<br/><br/>### Доступные операции с пользователями<br/><br/>* **create_user** — создание пользователя<br/>* **modify_user** — модификация пользователя<br/>* **delete_user** — удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры развертывания базы данных<br/><br/>Эти параметры необходимо указать при создании базы данных.<br/><br/>### Платформа для развертывания<br/><br/>Среда, в которой будет развернут кластер. Выбирается из предложенного списка.<br/><br/>### Количество узлов<br/><br/>Оптимально выбирать нечётное количество узлов в кластере MongoDB, так как это обеспечивает корректный процесс выбора ведущего узла и сохраняет работоспособность базы данных даже при отказе одной из нод.<br/><br/>### Квота памяти пода (MB)<br/><br/>Объём памяти для одного пода в мегабайтах.<br/>Пример: `2048`<br/><br/>### Квота CPU пода (mCPU)<br/><br/>CPU-квота для пода в миликорах (1000 mCPU = 1 vCPU).<br/>Пример: `1000`<br/><br/>### Размер диска для базы данных (GB)<br/><br/>Объём диска для хранения данных в гигабайтах.<br/>Пример: `20`<br/><br/>### Выделение внешнего IP для доступа к master<br/><br/>Флаг, определяющий необходимость выделения внешнего IP.<br/>Допустимые значения: `true` или `false`<br/><br/>### Имя ipSpace для публикации внешнего IP<br/><br/>Указывается только если включено выделение внешнего IP.<br/>Пример: `internet-no-antiddos-v1`<br/><br/>---<br/><br/>## 3. Параметры модификации базы данных<br/><br/>Все параметры, которые вы указываете при модификации, являются необязательными — система автоматически подставит ранее сохранённые значения, и при необходимости вы можете изменить их на нужные.<br/><br/>### Количество узлов<br/><br/>Оптимально выбирать нечётное количество узлов в кластере MongoDB, так как это обеспечивает корректный процесс выбора ведущего узла и сохраняет работоспособность базы данных даже при отказе одной из нод.<br/><br/>### Квота памяти пода (MB)<br/><br/>Объём памяти для одного пода в мегабайтах.<br/>Пример: `2048`<br/><br/>### Квота CPU пода (mCPU)<br/><br/>CPU-квота для пода в миликорах (1000 mCPU = 1 vCPU).<br/>Пример: `1000`<br/><br/>### Размер диска для базы данных (GB)<br/><br/>Объём диска для хранения данных указывается в гигабайтах. Его можно увеличить при необходимости, однако уменьшить уже выделенный размер невозможно.<br/>Пример: `20`<br/><br/>### Выделение внешнего IP для доступа к master<br/><br/>Флаг, определяющий необходимость выделения внешнего IP.<br/>Допустимые значения: `true` или `false`<br/><br/>### Имя ipSpace для публикации внешнего IP<br/><br/>Указывается только если включено выделение внешнего IP.<br/>Пример: `internet-no-antiddos-v1`<br/><br/>---<br/><br/>## 3. Параметры создания пользователя<br/><br/>### Имя пользователя<br/><br/>Указывается имя пользователя (любой регистр).<br/>Пример: `readApp`<br/><br/>### Имя базы данных<br/><br/>Название базы, в которой будет создан пользователь.<br/>Если база отсутствует, она будет создана автоматически.<br/>Пример: `Apps_9392`<br/><br/>### Имя роли<br/><br/>* **read** — доступ только на чтение<br/>* **readWrite** — чтение и изменение данных<br/>* **dbOwner** — полный контроль над базой данных<br/><br/>---<br/><br/>## 4. Параметры модификации пользователя<br/><br/>### Имя пользователя<br/><br/>Необходимо выбрать существующего пользователя.<br/>Если список пуст, требуется предварительно создать пользователя.<br/><br/>### Имя базы данных<br/><br/>База данных, к которой относится пользователь.<br/>Если база отсутствует, она будет создана автоматически.<br/>Пример: `Apps_9392`<br/><br/>### Имя роли<br/><br/>* **read**<br/>* **readWrite**<br/>* **dbOwner**<br/><br/>---<br/><br/>## 5. Параметры удаления пользователя<br/><br/>### Имя пользователя<br/><br/>Выберите пользователя из списка для удаления.<br/><br/>---<br/><br/>## 6. Выходные параметры<br/><br/>После успешного развертывания базы данных платформа возвращает ключевые параметры.<br/><br/>### internalConnect<br/><br/>Внутренний эндпоинт для подключения к кластеру из сервисов, работающих в той же сети.<br/>Используется для внутренних интеграций и системных сервисов.<br/><br/>### externalConnect<br/><br/>Внешний FQDN для подключения к кластеру извне.<br/>Порт подключения — **27017**.<br/><br/>---<br/><br/>## 7. Пример подключения<br/><br/>Перед подключением необходимо установить **mongosh**.<br/><br/>Команда подключения к базе данных:<br/><br/>```<br/>mongosh &quot;mongodb://&lt;username&gt;:&lt;password&gt;@&lt;endpoint_db&gt;:27017/&lt;dbName&gt;&quot;<br/>```<br/><br/>Где:<br/><br/>* `&lt;username&gt;` — имя пользователя<br/>* `&lt;password&gt;` — пароль<br/>* `&lt;endpoint_db&gt;` — internalConnect или externalConnect<br/>* `&lt;dbName&gt;` — имя базы данных<br/><br/>## 8. Дополнительная информация<br/><br/>Сейчас соединение с базой работает без шифрования, и доступ к кластеру осуществляется только по логину и паролю.","operations":[{"svcOperationId":190,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/delete/job/","descr":null,"man":null},{"svcOperationId":198,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/create_user/job/","descr":null,"man":null},{"svcOperationId":37,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/create/job/","descr":null,"man":null},{"svcOperationId":199,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/delete_user/job/","descr":null,"man":null},{"svcOperationId":200,"operation":"modify_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/modify_user/job/","descr":null,"man":null},{"svcOperationId":201,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/modify/job/","descr":null,"man":null},{"svcOperationId":194,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/suspend/job/","descr":null,"man":null},{"svcOperationId":196,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/MongoDB/job/resume/job/","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/93.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":50,"svc":{"svcId":93,"svc":"RabbitMQ","svcShort":"rabbitmq","code":null,"version":"master","orchestratorName":"Rabbitmq","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://www.svgrepo.com/download/354250/rabbitmq-icon.svg","descr":"Сервер очередей","man":"# Инструкция по развертыванию RabbitMQ через платформу<br/><br/>---<br/>## 1. Общая информация<br/>RabbitMQ — это брокер сообщений с открытым исходным кодом, который обеспечивает надёжную доставку сообщений между приложениями.<br/>Позволяет надёжно передавать сообщения между сервисами и системами, интегрироваться с внешними решениями и использовать как внутренние, так и защищённые TLS-подключения. Развёртывание полностью автоматизировано платформой.<br/><br/>## Доступные операции<br/>- **create** — Создание кластера<br/>- **modify** — Изменение параметров кластера<br/>- **delete** — Удаление кластера<br/>- **suspend** — Остановка кластера<br/>- **resume** — Запуск кластера<br/><br/><br/>---<br/>## 2. Параметры развертывания кластера<br/>Ниже перечислены параметры, которые необходимо указать при создании ресурса RabbitMQ:<br/><br/>* **Платформа для развертывания:**<br/> Платформа для развертывания (среда, в которой будет развернут кластер). Пример: `k8s-3.ext.nubes.ru`.<br/><br/>* **Количество узлов в сети:**<br/> Количество реплик в кластере RabbitMQ. При значении больше 1 создаётся кластер с репликацией для обеспечения высокой доступности.<br/> Пример: `1` (single node) или `3` (кластер с репликацией)<br/><br/>* **Квота (megabyte) памяти пода:**<br/> Квота памяти пода в мегабайтах. Пример: `2048`<br/><br/>* **Квота (millicore) ядра пода:**<br/> Квота CPU пода в миликорах (1000 mCPU = 1 vCPU). Пример: `1000`<br/><br/>* **Размер (gigabyte) диска для базы данных:**<br/> Размер диска для хранения данных RabbitMQ в гигабайтах. Пример: `50`<br/><br/>* **Выделяет внешний IP для доступа к master:**<br/> Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-узлу. При включении создаётся Service типа LoadBalancer и настраивается VIP на порту 5672.<br/> Пример: `true` или `false`<br/><br/>* **Имя ipSpace для публикации внешнего IP master:**<br/> Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`<br/><br/><br/>---<br/>## 3. Модификация кластера<br/>Операция **modify** позволяет изменить параметры существующего кластера RabbitMQ.<br/><br/>**Изменяемые параметры:**<br/>* **Квота (megabyte) памяти пода** — можно увеличить или уменьшить<br/>* **Квота (millicore) ядра пода** — можно увеличить или уменьшить<br/>* **Размер (gigabyte) диска для базы данных** — можно только увеличить (уменьшение не поддерживается)<br/>* **Количество узлов в сети** — можно только увеличить (уменьшение не поддерживается)<br/>* **Выделяет внешний IP для доступа к master** — можно включить или выключить<br/>* **Имя ipSpace для публикации внешнего IP master** — можно изменить при включенном внешнем IP<br/><br/>**Ограничения:**<br/>* Уменьшение размера диска не поддерживается<br/>* Уменьшение количества реплик не поддерживается<br/><br/>---<br/>## 4. Выходные параметры<br/>После успешного развертывания ресурса RabbitMQ платформа возвращает ряд параметров в разделе &quot;Поля состояния (сгенерированные значения)&quot;:<br/><br/>**clusterDomain**<br/>Домен кластера Kubernetes, в котором развернут RabbitMQ.<br/>Пример: `cluster.local`<br/><br/>**inernalConnect**<br/>Внутренние эндпоинты для подключения к кластеру RabbitMQ из других сервисов, развернутых внутри той же сети.<br/>Содержит:<br/>* **master** — FQDN для подключения к кластеру. Пример: `rabbitmqk8s.{namespace}.svc.{clusterDomain}`<br/><br/>**externalConnect**<br/>Внешние эндпоинты для подключения к кластеру RabbitMQ извне.<br/>Содержит объекты с полями:<br/>* **admin** — доступ к веб-интерфейсу управления:<br/> * `fqdn` — полное доменное имя для веб-интерфейса. Пример: `admin.{namespace}.{domain}`<br/> * `ip` — IP-адрес<br/>* **master** — доступ к AMQP протоколу (если включен внешний IP):<br/> * `fqdn` — полное доменное имя для AMQP. Пример: `write.{namespace}.{domain}`<br/> * `ip` — IP-адрес<br/><br/>**monitoring**<br/>Информация о дашбордах мониторинга:<br/>* **allDashboards** — URL для доступа ко всем дашбордам Grafana<br/><br/>Для подключения используются следующие порты:<br/><br/>* **5672** — AMQP протокол (внутренний и внешний доступ, если включен внешний IP)<br/>* **15672** — веб-интерфейс управления (доступен через Ingress по HTTPS)<br/><br/>**Учётные данные**<br/>Данные для подключения к RabbitMQ доступны в разделе &quot;Учётные данные&quot;:<br/>* **adminUser** — имя пользователя администратора<br/>* **adminPass** — пароль администратора<br/><br/><br/>---<br/>## 5. Примеры подключения через консоль (rabbitmqadmin)<br/><br/>### Работа с очередями через rabbitmqadmin<br/><br/>Для работы с RabbitMQ через консоль используется утилита `rabbitmqadmin`. Установите её или используйте образ с предустановленной утилитой.<br/><br/>Задайте переменные окружения с учётными данными:<br/><br/>```bash<br/>export RABBITMQ_USERNAME=&lt;adminUser&gt;<br/>export RABBITMQ_PASSWORD=&lt;adminPass&gt;<br/>export RABBIT_HOST=&lt;host&gt;<br/>```<br/><br/>Где:<br/>* `&lt;adminUser&gt;` и `&lt;adminPass&gt;` — учётные данные из раздела &quot;Учётные данные&quot;<br/>* `&lt;host&gt;` — адрес для подключения:<br/> * Для внешнего подключения: `externalConnect.admin.fqdn` или `externalConnect.master.fqdn`<br/><br/>**Создание очереди:**<br/><br/>```bash<br/>rabbitmqadmin \\<br/> -H &quot;$RABBIT_HOST&quot; -P 15672 \\<br/> -u &quot;$RABBITMQ_USERNAME&quot; -p &quot;$RABBITMQ_PASSWORD&quot; \\<br/> declare queue name=healthcheck durable=false<br/>```<br/><br/>**Листинг очередей:**<br/><br/>```bash<br/>rabbitmqadmin \\<br/> -H &quot;$RABBIT_HOST&quot; -P 15672 \\<br/> -u &quot;$RABBITMQ_USERNAME&quot; -p &quot;$RABBITMQ_PASSWORD&quot; \\<br/> list queues<br/>```<br/><br/>**Отправка сообщения:**<br/><br/>```bash<br/>rabbitmqadmin \\<br/> -H &quot;$RABBIT_HOST&quot; -P 15672 \\<br/> -u &quot;$RABBITMQ_USERNAME&quot; -p &quot;$RABBITMQ_PASSWORD&quot; \\<br/> publish exchange=amq.default routing_key=healthcheck payload=&quot;ping-$(date +%s)&quot;<br/>```<br/><br/>**Чтение сообщения:**<br/><br/>```bash<br/>rabbitmqadmin \\<br/> -H &quot;$RABBIT_HOST&quot; -P 15672 \\<br/> -u &quot;$RABBITMQ_USERNAME&quot; -p &quot;$RABBITMQ_PASSWORD&quot; \\<br/> get queue=healthcheck ackmode=ack_requeue_false<br/>```<br/><br/>---<br/>## 6. Дополнительная информация<br/>Для подключения к кластеру RabbitMQ используйте полученные эндпоинты из раздела &quot;Поля состояния (сгенерированные значения)&quot; и учётные данные из раздела &quot;Учётные данные&quot;.<br/><br/>Веб-интерфейс управления доступен по адресу, указанному в параметре `externalConnect.admin.fqdn` через HTTPS.<br/><br/>Для внутреннего подключения используйте адрес из `inernalConnect.master` на порту 5672.<br/><br/>---","operations":[{"svcOperationId":116,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/suspend/job/buildWithParameters","descr":"Остановка сервиса путем применения манифеста с нолевой репликой","man":"Пока не работает из за того что RabbitmqCluster нельзя занулить"},{"svcOperationId":117,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/resume/job/","descr":null,"man":null},{"svcOperationId":38,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":39,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/delete/job/master/buildWithParameters","descr":"Для удаления нужно подождать 15 мин или зайти в состояние suspend и поправить время на 15 мин назад","man":null},{"svcOperationId":106,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Rabbitmq/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":50}
artifacts/api-meta/dev/services/94.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":47,"svc":{"svcId":94,"svc":"Lucee","svcShort":"lucee","code":null,"version":"master","orchestratorName":"Lucee","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Cервер приложений","man":null,"operations":[{"svcOperationId":163,"operation":"restart","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/restart/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":53,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/redeploy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":50,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":49,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":55,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/modify/job/master/buildWithParameters","descr":"Если CFS оставить пустым, то при запуске джобы берётся параметр из instanceData","man":"Если CFS оставить пустым, то при запуске джобы берётся параметр из instanceData"},{"svcOperationId":96,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":95,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Lucee/job/resume/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":48}
artifacts/api-meta/dev/services/95.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":108,"svc":{"svcId":95,"svc":"NodeJS","svcShort":"nodejs","code":null,"version":"master","orchestratorName":"Node","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nodejs/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://icon.icepanel.io/Technology/svg/Node.js.svg","descr":"Cервер приложений","man":"Развертывает контейнер в k8s кластере с node, который можно использовать для запуска своих приложений.<br/>Приложение должно быть доступно по ссылки в git репозитории, которая является входным параметром.","operations":[{"svcOperationId":59,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nodejs/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":58,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nodejs/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":120,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Node/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":121,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Node/job/resume/job/","descr":null,"man":null},{"svcOperationId":61,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nodejs/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":60,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Nodejs/job/redeploy/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":108}
artifacts/api-meta/dev/services/96.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":52,"svc":{"svcId":96,"svc":"pgAdmin","svcShort":"pgadmin","code":null,"version":"master","orchestratorName":"Pgadmin","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Административный интерфейс для PostgreSQL","man":"Инструмент с графическим интерфейсом для управления базами данных PostgreSQL","operations":[{"svcOperationId":122,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/suspend/job/","descr":null,"man":null},{"svcOperationId":123,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/resume/job/","descr":null,"man":null},{"svcOperationId":62,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":63,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":65,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/redeploy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":64,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Pgadmin/job/modify/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":52}
artifacts/api-meta/dev/services/97.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":47,"svc":{"svcId":97,"svc":"NodeRed","svcShort":"nodered","code":null,"version":"master","orchestratorName":"NodeRed","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/NodeRed/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://nodered.org/about/resources/media/node-red-icon.svg","descr":"Low-code платформа для IoT","man":null,"operations":[{"svcOperationId":73,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/NodeRed/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":72,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/NodeRed/job/create/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":47}
artifacts/api-meta/dev/services/98.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":51,"svc":{"svcId":98,"svc":"Простой HTTP контейнер","svcShort":"http","code":null,"version":"master","orchestratorName":"SimpleHttpContainer","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":null,"man":null,"operations":[{"svcOperationId":130,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/resume/job/","descr":null,"man":null},{"svcOperationId":131,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/suspend/job/","descr":null,"man":null},{"svcOperationId":77,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":81,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":79,"operation":"redeploy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/redeploy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":78,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/SimpleHttpContainer/job/delete/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":51}
artifacts/api-meta/dev/services/99.json
+1
View File
@@ -0,0 +1 @@
{"queryDurationMs":115,"svc":{"svcId":99,"svc":"Gitea","svcShort":"gitea","code":null,"version":"master","orchestratorName":"Gitea","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":"https://www.svgrepo.com/download/349372/gitea.svg","descr":"Сервис контроля версий","man":"Развертывает сервис контроля версий Gitea<br/>Зависит от сервиса postgresql который должен быть развернут заранее.","operations":[{"svcOperationId":83,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":91,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":82,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":126,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/suspend/job/","descr":null,"man":null},{"svcOperationId":127,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Gitea/job/resume/job/","descr":null,"man":null}]},"runDurationMs":115}