tf_provider/docs/30_registry/resources/all_resources.md

Provider resources (full list)

Auto-generated summary from API/YAML (max detail).

nubes_dummy

• Service ID: 1
• Description: Болванка для тестов
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Болванка для тестов.

А это просто много букв, чтобы посмотреть, как ведет себя текст при переполнении контейнера.


``` json
{
"iamServiceUrl": "https://auth-api-test.ngcloud.ru/api/v1/user",
"idpResponse": {
"prefix": {
"charset": "",
"status_text": "Request Time-out",
"text": true,
"errordetail": "",
"filecontent": "Connection Timeout",
"responseheader": {},
"header": "",
"statuscode": "408 Request Time-out",
&quo...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
198	durationMs	integer	ДА	0	перед завершением подождать (sleep) столько миллисекунд
199	failAtStart	boolean	ДА	false	**Операция не будет завершена** Она будет в постоянном статусе PENDING, однако в Jenkins Job завершится с ошибкой	value_list=false, true
200	failInProgress	boolean	ДА	false	если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb	value_list=false, true
201	whereFail	integer	НЕТ	1	принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write	value_list=1, 2, 3
242	resourceRealm	string	ДА		Наименование ресурсной платформы для подключения	func=getAvailableResourceRealms
286	bodymessage	string	НЕТ		Дата, уходящая в Vault
321	mapExample	map	НЕТ
322	jsonExample	json	НЕТ		Для тестирования интерфейса. Сюда можно писать корректный json
396	nestedRefExample		НЕТ
447	yamlExample	yaml	НЕТ
647	mapFixed	map-fixed	НЕТ		Новый тип поля
654	arrayMapFixedExample	array-map-fixed	НЕТ		Array of map-fixed

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
287	durationMs	integer	ДА	0	перед завершением подождать (sleep) столько миллисекунд
288	failAtStart	boolean	ДА	false	если true, завершить джоб, ничего не записывая в cmdb	value_list=false, true
289	failInProgress	boolean	ДА	false	если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb	value_list=false, true
290	whereFail	integer	НЕТ		принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write	value_list=1, 2, 3
291	bodymessage		НЕТ		Дата, уходящая в Vault
373	mapExample	map	НЕТ	{}
374	jsonExample		НЕТ

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	18	durationMs, failAtStart, failInProgress, whereFail, resourceRealm, bodymessage, mapExample, jsonExample, nestedRefExample, yamlExample, mapFixed, arrayMapFixedExample	Это мануал к операции CREATE сервиса Болванка
delete	instance	delete	``	71
modify	instance	modify	``	92	durationMs, failAtStart, failInProgress, whereFail, bodymessage, mapExample, jsonExample
redeploy	action	redeploy	``	240
resume	instance	resume	``	94
suspend	instance	suspend	``	93

nubes_template

• Service ID: 2
• Description: Болванка для тестирования
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
202	resourceCPU	integer	ДА	100		minvalue=100; maxvalue=4000
203	resourceMemory	integer	ДА	200		minvalue=128; maxvalue=8192
204	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
205	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7
206	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
207	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
208	resourceCPU	integer	НЕТ			minvalue=100; maxvalue=4000
209	resourceMemory	integer	НЕТ			minvalue=128; maxvalue=8192
210	resourceDisk	integer	НЕТ	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
211	resourceInstances	integer	НЕТ		Количество узлов	minvalue=1; maxvalue=7

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	74	resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, domain
delete	instance	delete	``	75
modify	instance	modify	``	76	resourceCPU, resourceMemory, resourceDisk, resourceInstances
resume	instance	resume	``	98
suspend	instance	suspend	``	97

nubes_s3

• Service ID: 12
• Description: Масштабируемое хранилище данных
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Руководство доступно по ссылке:
https://docs.s3.msk-1.ngcloud.ru/s3/s3.description.html

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
163	resourceRealm		ДА		Платформа для развертывания	func=getAvailableResourceRealms
320	displayName	string	ДА		Человеко-читаемое имя (транслит из Elma) - передаётся имя клиента

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
50	maxSizeGbPerUser	integer	НЕТ		maxSizeGb. Передаём руками	minvalue=-1; maxvalue=50000
51	maxObjectsPerBucket	integer	НЕТ		Квота на бакет. Кол-во объектов. Передаём руками	minvalue=1; maxvalue=1e+07
52	maxBucketsPerUser	integer	НЕТ		Квота на пользователя. Количество бакетов пользователя. Передаём руками	minvalue=1; maxvalue=1000

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	1	resourceRealm, displayName
create_sub_user	subresource	create	sub_user	6	subUserName, subUserAccess
delete	instance	delete	``	5
delete_sub_user	subresource	delete	sub_user	7	subUserName
modify	instance	modify	``	4	maxSizeGbPerUser, maxObjectsPerBucket, maxBucketsPerUser	При первичном вызове операции услуга Trial прекращает действие
resume	instance	resume	``	3
suspend	instance	suspend	``	2

nubes_s3bucket

• Service ID: 13
• Description: Бакет в сервисе S3
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
124	s3UserUid	uuid	ДА		UID Корневой услуги S3. На основе него будет создан бакет.	ref_svc_id=12
125	bucketName	string	ДА		Имя бакета s3
126	maxSize		ДА	-1	Максимальный размер бакета s3. Если поставить -1, будет безлимит. Размер указывается в Bytes
127	readAll	boolean	ДА	false	Публичный доступ на чтение позволяет любому пользователю интернета скачивать объекты из бакета.	value_list=false, true
128	listAll	boolean	ДА	false	Публичный доступ к листингу позволяет любому пользователю интернета получить список объектов в бакете.	value_list=false, true
129	corsAll	boolean	ДА	false	Публичный доступ к чтению настроек позволяет любому пользователю интернета читать конфигурации CORS	value_list=false, true
130	placement	string	ДА	HOT	Класс хранилища, который используется по умолчанию при загрузке объектов. Чем холоднее, тем дешевле место, но дороже обращения	value_list=HOT, COLD

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	51	s3UserUid, bucketName, maxSize, readAll, listAll, corsAll, placement
delete	instance	delete	``	52

nubes_vc_org

• Service ID: 19
• Description: Организация в Cloud Director
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Организация в Cloud Director через платформу

## 1. Общая информация

Сервис Организация в Cloud Director предназначен для управления изолированными организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.

### Доступные операции

create — Создание новой организации с заданными характеристиками и типом доступа.
delete — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
418	resourceRealm	string	ДА		Выбрать платформу из списка **Если список не отображается** обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы	func=getAvailableResourceRealms
556	organizationType	string	ДА	iaas	Доступ к организации предоставляется только при выборе `iaas`	value_list=iaas, saas

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
662	vIPConfigure	array-map-fixed	ДА

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	136	resourceRealm, organizationType	IaaS - Доступ в Keycloak предоставляется пользователю, который создаёт услугу SaaS - Без доступа к Keycloak
delete	instance	delete	``	137		Удалить возможно только через 14 дней после выполнения операции suspend ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого тенанта Если существуют инстансы VDC, Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к технической поддержке для удаления инстансов
modify	instance	modify	``	207	vIPConfigure	Для возможности изменения параметров предварительно необходимо создать Виртуальный датацентр (VDC), потом Сетевой шлюз периметра (Edge Gateway) Также при удалении ipSpaces убедитесь, что все внешние IP удалены. В случае если хоть одна привязка vIP есть, данный ipSpace удалён не будет
reconcile	action	reconcile	``	249
resume	instance	resume	``	144
suspend	instance	suspend	``	143		Операция не останавливает ВМки в облаке, но не даёт редактировать все сущности внутри тенанта

nubes_vc_org_saas

• Service ID: 20
• Description: Без интеграции Keycloak
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Верхнеуровневая сущность создаваемая для Заказчика.
Внутри Организация вы можете создать: Виртуальные датацентры, Каталоги.

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
185	resourceRealm	string	ДА		Наименование ресурсной платформы	func=getAvailableResourceRealms

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	8	resourceRealm	Создание организации в Cloud Director Id в клауд директоре создаётся на основе contragentCode
delete	instance	delete	``	23
resume	instance	resume	``	119
suspend	instance	suspend	``	118

nubes_vc_vdc

• Service ID: 21
• Description: Выделение вычислительных ресурсов
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Виртуальный датацентр (vDC) через платформу

## 1. Общая информация

Виртуальный датацентр (vDC) — это логическая изолированная среда в VMware Cloud Director, предназначенная для размещения и управления виртуальными машинами, сетевой инфраструктурой и ресурсами хранения. Сервис обеспечивает выделение вычислительных ресурсов под конкретную организацию и предоставляет гибкие параметры масштабирования, контроля потребления и разделения ресурсов.

### Доступные операции

create — Создание виртуального датацентра (vDC) с заданными параметрами CPU, RAM, Storage и сетевой конфигурацией.
delete — Удаление vDC. Требуется предварительный перевод vDC в состояние suspend. Полное удаление возможно через 14 дней.
**modif...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
30	organizationUid	uuid	ДА		Для создания VDC предварительно необходимо создать организацию через услугу `Организация в Cloud Director`	ref_svc_id=19
335	providerVdc	string	ДА		Приписка `2.8` - Скорость vCPU - 2800MHz И так далее...
361	storageConfig	array-map-fixed	ДА		Первая политика в списке указывается как "По умолчанию"
397	cpuGuaranteed	integer	ДА	20	Свойство нельзя изменить после создания	value_list=20, 50, 80
398	memGuaranteed	integer	ДА	20	После создания нельзя изменить	value_list=20, 50, 80
557	cpuAllocated	integer	ДА	10	шт	minvalue=1; maxvalue=200
558	memAllocated	integer	ДА	20	gb	minvalue=1; maxvalue=4096
746	networkProvider	string	ДА

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
560	cpuAllocated	integer	ДА		шт	minvalue=1; maxvalue=999
561	memAllocated	integer	ДА		gb	minvalue=1; maxvalue=1024
562	storageConfig	array-map-fixed	ДА		Первая политика в списке указывается как "По умолчанию"

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	9	organizationUid, providerVdc, storageConfig, cpuGuaranteed, memGuaranteed, cpuAllocated, memAllocated, networkProvider
delete	instance	delete	``	24		Удалить возможно только через 14 дней после выполнения операции suspend ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого VDC Если существуют инстансы Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к технической поддержке для удаления инстансов
modify	instance	modify	``	112	cpuAllocated, memAllocated, storageConfig
reconcile	action	reconcile	``	250
resume	instance	resume	``	172
suspend	instance	suspend	``	171		Операция не останавливает ВМки в облаке, но не даёт редактировать все сущности внутри VDC

nubes_vc_nsxt

• Service ID: 22
• Description: Обеспечение сетевой доступности в тенанте
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Сетевой шлюз периметра (Edge) через платформу

## 1. Общая информация

Сервис Сетевой шлюз периметра (Edge) предназначен для создания периметрового сетевого шлюза в рамках одного виртуального датацентра (vDC) или группы виртуальных датацентров (groupvDC).
При создании автоматически разворачивается routed-сеть с адресным пространством 10.10.102.0/24.
Сервис обеспечивает сетевую изоляцию, маршрутизацию, а также может включать функциональность балансировщика нагрузки AVI (ALB) для последующей интеграции, включая поддержку кластеров Штурвал.

### Доступные операции

create — Создание нового Edge с привязкой к vDC или groupvDC и развёртыванием routed-сети.
delete — Удаление ранее созданного Edge. Недос...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
8	vdcUid	string	НЕТ		Необходимо, если выбран тип подключаемой VDC: `vdc`	ref_svc_id=21
340	needEnableAVI	boolean	ДА	false	Параметры `Наименование segroup`, `Кол-во VS на AVI` необходимо также указать	value_list=false, true
341	virtualServicesCount	integer	НЕТ	1	Во избежании коллапса пока выделяется до 4 Необходимо указывать, если включён параметр `Включить ALB`	minvalue=1; maxvalue=4
621	vdcType	string	ДА	vdc	При выборе vdc обеспечивает сетевую доступность только в рамках этого vdc При выборе groupvdc обеспечивает сетевую доступность между всеми vdc, которые включены в groupvdc	value_list=vdc, vdcGroup
622	vdcGroupUid	string	НЕТ		Необходимо, если выбран тип подключаемой VDC: `groupvdc`	ref_svc_id=29

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
368	needEnableAVI	boolean	НЕТ		Параметры `Наименование segroup`, `Кол-во VS на AVI` необходимо также указать	value_list=false, true
369	virtualServicesCount	integer	НЕТ		Во избежании коллапса пока выделяется до 4 Необходимо указывать, если включён параметр `Включить ALB`	minvalue=1; maxvalue=4
371	needExternalAddressSNAT	boolean	НЕТ		Параметр `ip Space для VIP` станет обязательным, если указан `true`	value_list=false, true
372	ipSpaceName	string	НЕТ		Имя ip Space для внешнего IP getKeyListFromStruct(getInstanceState(getValueFromStruct(getInstanceState(getValueFromStruct(getInstanceState(), "params.vdcUid")), "params.organizationUid")), "params.vIPConfigure")

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	10	vdcUid, needEnableAVI, virtualServicesCount, vdcType, vdcGroupUid
delete	instance	delete	``	25		Невозможно удалить если routed-сеть в Edge связана с: - vApp - VM - Kubernetes-кластер Штурвал Запустить операцию возможно, но будет ошибка
modify	instance	modify	``	111	needEnableAVI, virtualServicesCount, needExternalAddressSNAT, ipSpaceName	Для создания SNAT Правила убедитесь, что в организации есть свободные IP Редактировать кол-во свободных IP можно в услуге Организация в Cloud Director -> modify
reconcile	action	reconcile	``	252

nubes_vc_vm

• Service ID: 23
• Description: Виртуальная машина без каких-либо особенностей.
  Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Виртуальная машина без каких-либо особенностей.
Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
33	vappUid	uuid	ДА		InstanceUid vApp. vApp должен быть создан	ref_svc_id=26
35	vmName	string	ДА	vm0001	Имя ВМ. Не поддерживает спец-символы	regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
36	vmCpu	string	ДА	2	CPU
37	vmRam	string	ДА	2	RAM (GB)
38	vmDisksize	string	ДА	10	Размер диска под сервис (GB)
176	templateName	string	ДА	RockyLinux_9-16G	ОС	value_list=RockyLinux_9-16G, OracleLinux_9-16G, Ubuntu_24-20G, Ubuntu_22-20G
177	accessIpList	string	ДА	79.111.119.78/32 185.247.187.1/32	Вставить содержимое из 'curl ifconfig.io' IP адреса в CIDR формате через пробел для настройки аксес листов
406	ipSpaceName	string	ДА		Брать из свойств ресурсной платформы .vcd.ipSpace Имя IP-space для выделения внешнего IP (IP выделяется обязательно)

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
186	vmCpu	integer	НЕТ		CPU
187	vmRam	integer	НЕТ		RAM
188	vmDisksize	integer	НЕТ		Размер диска под сервис (GB)
189	accessIpList	string	НЕТ		IP адреса в CIDR формате через пробел для настройки аксес листов

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	26	vappUid, vmName, vmCpu, vmRam, vmDisksize, templateName, accessIpList, ipSpaceName
delete	instance	delete	``	29
modify	instance	modify	``	68	vmCpu, vmRam, vmDisksize, accessIpList	Операция автоматически останавливает ВМ.
resume	instance	resume	``	28
suspend	instance	suspend	``	27

nubes_vcexternalip

• Service ID: 25
• Description: Резервирование IP адреса
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Обычно эта услуга разворачивается автоматически при развёртывании более сложных услуг
Вручную создавать можно, однако услуга требует много параметров, о которых можно просто не знать

Резервировать публичные IP адреса можно только после создания NGcloud Organization, NGcloud Виртуальный датацентр, NGcloud Каталог, Сетевой шлюз периметра.
Вы можете назначить IP адрес для существующего экземпляра сервиса.

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
140	serviceUid	string	ДА
141	dnatCreate	boolean	ДА	true	Необходимо создать DNAT-правило.
142	internalPortAccess	string	ДА	5432	Порт для связки ната с адресом. Несколько значений можно передавать через пробел. Если передать all, то dnat будет на все порты. Требует dnatCreate=true
143	snatCreate	boolean	НЕТ		Необходимо создать SNAT-правило.
144	internalAddrAccess	string	ДА		Внутренний адрес для связки ната. Требует dnatCreate=true или snatCreate=true
324	fromServiceNamespace	string	ДА		Namespace составной услуги (для отображения правил FW)
325	fromServiceCloudEdgeName	string	НЕТ		Edge составной услуги (указывать, если resourceRealm связан с CloudDirector)
326	fromServiceCloudVdcName		НЕТ		Vdc составной услуги (указывать, если resourceRealm связан с CloudDirector)
327	fromServiceCloudOrgName	string	НЕТ		Org составной услуги (указывать, если resourceRealm связан с CloudDirector)
328	fromServiceCloudVmwareUrl	string	НЕТ		Api-Url составной услуги (указывать, если resourceRealm связан с CloudDirector)
336	ipSpaceName	string	ДА		Тип ip Space (internet-ipv4-v1 / internet-antiddos-v1 / internet-no-antiddos-v1)
488	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
624	fromServiceCloudEdgeScope	string	НЕТ
626	fromServiceVdcGroupName	string	НЕТ

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
627	serviceUid	string	ДА
628	ipSpaceName	string	ДА
629	dnatCreate	boolean	ДА
630	snatCreate	boolean	ДА
631	internalPortAccess	string	ДА
632	internalAddrAccess	string	ДА

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	56	serviceUid, dnatCreate, internalPortAccess, snatCreate, internalAddrAccess, fromServiceNamespace, fromServiceCloudEdgeName, fromServiceCloudVdcName, fromServiceCloudOrgName, fromServiceCloudVmwareUrl, ipSpaceName, resourceRealm, fromServiceCloudEdgeScope, fromServiceVdcGroupName
delete	instance	delete	``	57
modify	instance	modify	``	197	serviceUid, ipSpaceName, dnatCreate, snatCreate, internalPortAccess, internalAddrAccess

nubes_vapp

• Service ID: 26
• Description: Группировка виртуальных машин
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Виртуальный каталог ВМ (vApp) через платформу

## 1. Общая информация

Виртуальный каталог ВМ (vApp) — это логическая каталог, объединённая в единый управляемый объект. Сервис предназначен для совместного развертывания, управления жизненным циклом и сетевого взаимодействия набора связанных ВМ. Основные функции включают:
- централизованное управление включением, выключением и приостановкой группы ВМ;
- унифицированный сетевой доступ через привязанный Edge-шлюз;

### Доступные операции

create — Создание нового vApp с привязкой к заданным услугам VDC и Edge
delete — Удаление существующего vApp. Требуется предварительный перевод vApp в состояние suspend. Полное удаление возможно через 14 дней.
**suspen...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
190	nsxtUid	uuid	ДА		К какой сети может быть подключен виртуальный каталог	ref_svc_id=22
191	vappName	string	ДА		Имеет строгую маску `^[a-z0-9][a-z0-9.-]{3,61}[a-z0-9]$` Используется в формировании DNS-Имени (для виртуальных машин)	regex=^[a-z0-9][a-z0-9.-]{3,61}[a-z0-9]$; minlength=3
623	vdcUid	uuid	ДА		В каких ресурсах будет создан виртуальный каталог	ref_svc_id=21

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	69	nsxtUid, vappName, vdcUid
delete	instance	delete	``	70
resume	instance	resume	``	209
suspend	instance	suspend	``	208

nubes_vc_vm_v2

• Service ID: 27
• Description: Виртуальная машина с возможностью настройки Cloud Init
  Можно развернуть в услуге несколько ВМ
  В зависимости от настроек можно выдавать на ВМ vip + dns
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
301	serverListJson	json	ДА	[{}]	Необходимо изменить vappUid и ipSpaceName Пример конфигурации взять по ссылке ниже Объект серверов вида [{}] (Map(Object)) Более подробнее смотреть в README.md (https://gitea.mgmt.nubes.ru/cloudServices/vcVmV2)	maxlength=65536; minlength=10

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
302	serverListJson	json	ДА	[{}]	Объект серверов вида [{}] (Map(Object)) Более подробнее смотреть в README.md (https://gitea.mgmt.nubes.ru/cloudServices/vcVmV2)	maxlength=65536; minlength=10

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	100	serverListJson
delete	instance	delete	``	101
modify	instance	modify	``	104	serverListJson
resume	instance	resume	``	102
suspend	instance	suspend	``	103

nubes_vc_vm_v3

• Service ID: 28
• Description: Создание виртуальной машины
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Документация по разворачиванию ВМ в Личном кабинете

Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК).

## Доступные операции
- create — Создание виртуальной машины
- delete — Удаление виртуальной машины
- resume — Запуск виртуальной машины
- suspend — Остановка виртуальной машины

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
407	vappUid	uuid	ДА			ref_svc_id=26
408	vmName	string	ДА	web01		regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
409	vmCpu	integer	ДА	1	шт	minvalue=1; maxvalue=64
410	vmRam	integer	ДА	1	Gb	minvalue=1; maxvalue=256
411	vmDisk	integer	НЕТ		Основной диск у vm зависит от образа (см. документацию) Если необходимо дополнительное место для vm, введите колличество Gb в эту форму	regex=^(?:$|(?:0|[1-9]\d{0,2}|1\d{3}|20(?:[0-3]\d|4[0-8])))$
412	ipSpaceName	string	ДА
413	accessIpList	json	НЕТ		Формат массива Каким адресам будет предоставлен доступ до вм Требует выделенного внешнего IP Если ничего не передано, то выставлено ["0.0.0.0/0"]	regex=^(?:$|\[\s*(?:"(?:\d{1,3}\.){3}\d{1,3}(?:\/\d{1,2})?"(?:\s*,\s*"(?:\d{1,3}\.){3}\d{1,3}(?:\/\d{1,2})?")*)\s*\])$
414	imageVm	string	ДА
415	cloudInit	yaml	НЕТ		Можно передать создание дополнительных пользователей. На текущий момент не реализовано выполнения в cloud-init, установки пакетов, выполнения команд и записи файлов.
416	userLogin		ДА	myuser	Учётка SSH
417	userPublicKey	string	ДА		Публичная часть SSH-Ключа для пользователя
448	accessPortList	string	ДА	["22"]	По каким портам открыть доступ к ВМ. Порты 22, 10050 проставляются автоматически Пока доступно: 22 - SSH, 80 - HTTP, 443 - HTTPS, 10050 - ZABBIX

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
493	vmCpu	integer	НЕТ		шт	minvalue=1; maxvalue=64
494	vmRam	integer	НЕТ		Gb	minvalue=1; maxvalue=256
495	vmDisk	integer	НЕТ		Основной диск у vm зависит от образа (см. документацию) Если необходимо дополнительное место для vm, введите колличество Gb в эту форму	regex=^(?:$|(?:0|[1-9]\d{0,2}|1\d{3}|20(?:[0-3]\d|4[0-8])))$
496	ipSpaceName	string	НЕТ		no-needed, без внешнего ip internet-antiddos-v1, с функцией защиты от ddos атак internet-no-antiddos-v1, с функцией защиты от ddos атак internet-ipv4-v1 тестовое простанство dev	value_list=no-needed, internet-antiddos-v1, internet-no-antiddos-v1
497	accessIpList	json	НЕТ		Формат массива Каким адресам будет предоставлен доступ до вм Требует выделенного внешнего IP Если ничего не передано, то выставлено ["0.0.0.0/0"]
498	accessPortList	json	НЕТ		Формат массива По каким портам открыть доступ к ВМ. Пока доступно: 22 - SSH, 80 - HTTP, 443 - HTTPS

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	132	vappUid, vmName, vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, imageVm, cloudInit, userLogin, userPublicKey, accessPortList	# Документация по использованию услуги развёртывания ВМ в Личном кабинете Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК). ## Доступные операции - create — Создание виртуальной машины - delete — Удаление виртуальной машины - resume — Запуск виртуальной машины - suspend — Остановка виртуальной машины --- ## Параметры для развёртывания ВМ ### Обязательные параметры: vappUid UUID vApp, в которой будет создаваться виртуальная машина. Пример: WZ00400 vmName Уникальное имя виртуальной машины. Пример: test-vm vmCpu Количество ядер процессора. Должно быть больше 0. Пример: 1 vmRam Объем оперативной памяти в гигабайтах. Должно быть больше 0. Пример: 1 accessPortList Белый список портов для доступа к виртуальной машине извне в формате JSON. Пример: ["22","10050] imageVm Образ операционной системы для развёртывания. Доступные значения: RockyLinux_9-16G-cloudinit, Ubuntu_22-20G, Debian_13-20G userLogin Логин пользователя для SSH-доступа. По умолчанию: myuser userPublicKey Публичный SSH-ключ пользователя в формате OpenSSH. Пример: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC... needAddZabbixTemplate Значение истина\лож определяющее будет ли добавлен хост в zabbix. Пример: true ### Опциональные параметры: accessIpList Белый список IP-адресов для доступа к виртуальной машине в формате JSON. Если оставить пустым, вм будет доступена со всех адресов. Пример: ["192.168.1.1", "10.0.0.5"] vmDisk Размер дополнительного диска в гигабайтах. Должно быть больше 0. Пример: 50 ipSpaceName Внешний IP-адрес. Если не требуется — укажите значение "no-needed". cloudInit YAML-скрипт для кастомизации системы через cloud-init. --- ## Доступные образы операционных систем ### RockyLinux_9-16G-cloudinit Базовый образ на основе Rocky Linux 9 (Rocky-9.6-x86_64-minimal) для серверных задач. - Размер системного диска: 16 ГБ - Поддержка cloud-init - Минимальные требования: 1 vCPU, 1 ГБ RAM ### Ubuntu_22-20G Образ на основе Ubuntu Server 22.04 LTS для облачного окружения. - Размер системного диска: 20 ГБ - Поддержка cloud-init - Минимальные требования: 1 vCPU, 1 ГБ RAM ### Debian_13-20G Образ на основе Debian 13 (Trixie) для стабильной серверной работы. - Размер системного диска: 20 ГБ - Поддержка cloud-init - Минимальные требования: 1 vCPU, 1 ГБ RAM --- ## Пример использования Cloud-init 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/> --- ## Результат выполнения После успешного развёртывания в Личном кабинете появится новая виртуальная машина с заданными характеристиками. SSH-доступ осуществляется с использованием указанных логина и публичного ключа. --- ## Важные примечания ### Особенности работы: - Для отключения внешнего IP укажите значение "no-needed" в параметре ipSpaceName - Параметр cloudInit является опциональным ### Ограничения: - Не рекомендуется использовать продолжительные инструкции в cloud-init (таймаут 5 минут) - Не поддерживается запись файлов через cloud-init - Не реализовано создание резервных копий ВМ --- ## Диагностика проблем с cloud-init ### Основной лог-файл: bash<br/>/var/log/cloud-init.log<br/> ### Пакет не устанавливается: - Проверьте доступность пакета в репозитории - Убедитесь в правильности написания имени пакета - Попробуйте установить вручную: apt install &lt;имя_пакета&gt; (Debian/Ubuntu) или dnf install &lt;имя_пакета&gt; (Rocky Linux) ### Команда не выполняется: - Проверьте наличие требуемой утилиты в системе - Убедитесь в правильности синтаксиса команды - Попробуйте выполнить команду вручную для диагностики
delete	instance	delete	``	133
modify	instance	modify	``	159	vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, accessPortList
redeploy	action	redeploy	``	164	vmName, vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, imageVm, userLogin, userPublicKey, cloudInit, accessPortList
resume	instance	resume	``	135
suspend	instance	suspend	``	134

nubes_vc_vdc_group

• Service ID: 29
• Description: Обеспечение сетевой доступности между датацентрами
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Группа виртуальных датацентров (groupvDC) через платформу

## 1. Общая информация

Сервис Группа виртуальных датацентров (groupvDC) предназначен для логического объединения нескольких виртуальных датацентров (vDC) в единую группу. Это позволяет растягивать SDN между разными vDC и централизованно управлять сетевой связностью. Управление инфраструктурой осуществляется через Cloud Director.
Сервис применяется в случаях, когда требуется обеспечить единое сетевое пространство для распределенных виртуальных датацентров.

### Доступные операции

create — Создание новой группы виртуальных датацентров.
delete — Удаление существующей группы vDC.
add_vdc — Добавление дополнительного виртуального датацентра в гру...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
618	vdcUid	uuid	ДА			ref_svc_id=21

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
add_vdc	action	add_vdc	``	192	vdcUid	Не нужно выбирать UUID VDC, который уже был добавлен в группу
create	instance	create	``	191	vdcUid	VDC Группа нужна для объединения всех VDC в организации в одну логическую группу. Это позволит, к примеру, создать общую сеть для всех VDC в организации - Для создания группы VDC необходимо указать инстанс услуги VDC (Виртуальный датацентр) - Важный момент - удалить эту VDC из группы нельзя. Если такая потребность появится, необходимо будет ПОЛНОСТЬЮ удалить группу VDC и уже потом создать новую
delete	instance	delete	``	195
reconcile	action	reconcile	``	251
remove_vdc	action	remove_vdc	``	193	vdcName

nubes_vmpostgre

• Service ID: 32
• Description: Сервис настройки PostgreSQL для виртуальной машины.
  Требует наличия ВМ
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Сервис настройки PostgreSQL для виртуальной машины.
Требует наличия ВМ

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
43	vdcUid	uuid	ДА		InstanceUid vdc. Vdc должен быть создан	ref_svc_id=21
44	nsxtUid	uuid	ДА		InstanceUid nsxt. Nsxt должен быть создан	ref_svc_id=22
45	vmUid	uuid	ДА		InstanceUid ВМ. ВМ должна быть создана	ref_svc_id=23
46	userDb	string	ДА	servicedb	Наименование Базы данных
47	userLogin	string	ДА	serviceuser	Пользователь базы данных
48	userPassword	string	ДА	fj29gm48fm!d374mc9	Пароль от доступа к Базе данных
859	resourceRealm	string	ДА		Ресурсная платформа	func=getAvailableResourceRealms

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	32	vdcUid, nsxtUid, vmUid, userDb, userLogin, userPassword, resourceRealm
delete	instance	delete	``	33

nubes_nextcloud

• Service ID: 50
• Description: Платформа совместной работы
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Ресурсная платформа: k8s. Автоматизация: helm chart

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
21	domain	string	ДА	web01	Наименование домена. Если будет указан FQDN, то происходят проверки DNS. Если указан поддомен, то будет добавлен в зону services.ngcloud.ru Можно указать клиентскую DNS-Запись. Важно, чтобы запись смотрела на Ingress кластера	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
99	resourceCPU	integer	ДА	1000	Квота ядра пода (Указывается в mili). 1 ядро = 1000 Mili	minvalue=100; maxvalue=4000
100	resourceMemory	integer	ДА	1024	Квота памяти пода (Указывается в Megabytes)	minvalue=1024; maxvalue=8192
101	resourceDisk	integer	ДА	2	Квота диска (Указывается в GIGAbytes) Диск не может быть меньше 2G (!)	minvalue=2; maxvalue=999
192	documentServer	string	ДА	collabora	Выбор сервера документов (onlyoffice)/(collabora). onlyoffice пока не доступен Размер пода collabora: 1.8 ядра. 2Gi ОЗУ	value_list=collabora
470	resourceInstances	integer	ДА	1	Количество узлов Не может пока быть больше одного, так как нужны SC под RWMany	minvalue=1; maxvalue=7; value_list=1
564	psqlUid	uuid	ДА			ref_svc_id=90
569	appVersion		ДА	32.0.1		value_list=32.0.1
570	redisUid	uuid	ДА			ref_svc_id=91

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
178	resourceCPU	integer	НЕТ		Квота ядра пода (Указывается в mili)	minvalue=100; maxvalue=4000
179	resourceMemory	integer	НЕТ		Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
180	resourceDisk	integer	НЕТ		Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
547	resourceInstances	integer	НЕТ		Количество узлов. Не может пока быть больше одного, так как нужны SC под RWMany	minvalue=1; maxvalue=7; value_list=1
571	appVersion	string	ДА		Нельзя обновляться сразу через несколько версий сразу	value_list=32.0.1

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	16	domain, resourceCPU, resourceMemory, resourceDisk, documentServer, resourceInstances, psqlUid, appVersion, redisUid	DEV-Ветка сборки Nextcloud
delete	instance	delete	``	17		DEV-Ветка удаления Nextcloud
modify	instance	modify	``	67	resourceCPU, resourceMemory, resourceDisk, resourceInstances, appVersion
restart	action	restart	``	66
resume	instance	resume	``	129
suspend	instance	suspend	``	128

nubes_superset

• Service ID: 81
• Description: Сервер отчетов
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Apache Superset как сервис.
Ресурсная платформа: k8s.
Автоматизация: k8s operator.
Авторизация: 2FA keycloak (для доменного логина @mgmt.nubes.ru)

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
14	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
20	emails	string	ДА	testuser1	Учётная запись, которой будут выданы админские права. В формате email [ну не совсем. Для доменных учетных записей - без доменного суффикса]. Обязана находиться в Keycloak. Можно передавать несколько через пробел
96	resourceCPU	integer	ДА	500	Квота ядра пода (Указывается в mili). 1000 Mili = 1 ядро	minvalue=100; maxvalue=4000
97	resourceMemory	integer	ДА	512	Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
98	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
109	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
227	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	12	domain, emails, resourceCPU, resourceMemory, resourceDisk, resourceRealm, resourceInstances	DEV-Ветка сборки Superset
delete	instance	delete	``	13		DEV-Ветка удаления Superset

nubes_harbor

• Service ID: 82
• Description: Реестр для хранения образов контейнеров
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Расширенный реестр для управления Docker-образами с enterprise-функциями безопасности, репликации и контроля доступа.
Container Registry позволяет хранить, развертывать и управлять Docker-образами контейнеров в инфраструктуре NGcloud.
Сервис можно использовать в процессе разработки контейнеров. Например, вы можете настроить систему автоматизации на работу с реестром в Container Registry в рамках процесса непрерывной интеграции. Контейнеры идеально подходят для запуска небольших, независимых и легко изменяемых сервисов.
Чтобы начать работу, создайте реестр и загрузите в него Docker-образ
Авторизация: keycloak

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
16	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
17	emails	string	ДА	testuser1	Учётная запись, которой будут выданы админские права. Обязана находиться в Keycloak. Можно передавать несколько через пробел
110	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
228	resourceCPU	integer	ДА	100	Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро	minvalue=100; maxvalue=4000
229	resourceMemory	integer	ДА	200	Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
230	resourceInstances	integer	ДА	1	Количество узлов в сети	minvalue=1; maxvalue=7
231	s3Uid	uuid	ДА		UUID экземпляра услуги S3	ref_svc_id=12

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	14	domain, emails, resourceRealm, resourceCPU, resourceMemory, resourceInstances, s3Uid	DEV-Ветка сборки Harbor
delete	instance	delete	``	15		DEV-Ветка удаления Harbor

nubes_k8s_ziti_controller

• Service ID: 88
• Description: Контроллер управления Client to service & service to service Zero trust network
  
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
294	resourceCPU	integer	ДА	300	Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
295	resourceMemory	integer	ДА	512	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
296	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
297	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7
298	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
299	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	99	resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, domain
delete	instance	delete	``	105

nubes_flask

• Service ID: 89
• Description: Flask
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
248	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
249	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
250	resourceCPU	integer	ДА	300	Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
251	resourceMemory	integer	ДА	256	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
252	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7
253	gitPath	string	ДА	https://github.com/Foxyhhd/Baldurs-Gate-test.git	Путь до Git, который будет webroot для сайта
254	jsonEnv	string	НЕТ	{ "param": "value" }	Массив переменных, будут переданы в env приложения
255	healthPath	string	НЕТ		Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
451	resourceCPU	integer	ДА		Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
452	resourceMemory	integer	ДА		Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
453	resourceInstances	integer	ДА		Количество узлов	minvalue=1; maxvalue=7
454	gitPath		ДА		Путь до Git, который будет webroot для сайта
455	jsonEnv	json	ДА	{ "param": "value" }	Массив переменных, будут переданы в env приложения

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	88	domain, resourceRealm, resourceCPU, resourceMemory, resourceInstances, gitPath, jsonEnv, healthPath
delete	instance	delete	``	89
modify	instance	modify	``	146	resourceCPU, resourceMemory, resourceInstances, gitPath, jsonEnv
resume	instance	resume	``	145
suspend	instance	suspend	``	125

nubes_postgres

• Service ID: 90
• Description: Управляемая база данных PostgreSQL
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию PostgreSQL через платформу

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
23	s3Uid	uuid	ДА		Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно	ref_svc_id=12
80	resourceInstances	integer	ДА	1	Количество узлов в кластере. 1,3,5,7	minvalue=1; maxvalue=7; regex=^[1357]$
81	resourceMemory	integer	ДА	512	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
82	resourceCPU	integer	ДА	500	Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
83	resourceDisk		ДА	10	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
102	resourceRealm	string	ДА		Кластер Kubernetes, на котором будет развернут экземпляр	func=getAvailableResourceRealms
145	needExternalAddressMaster	boolean	НЕТ	false	Выделяет внешний (белый) IP для доступа к master	value_list=false, true
146	needExternalAddressSlave	boolean	НЕТ	false	Выделяет внешний (белый) IP для доступа к slave. Будет работать, если slave в принципе есть	value_list=false, true
265	ext_BACKUP_SCHEDULE	string	НЕТ	0 0 * * *	Не обязательный. Время запуска бекапа	regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$
266	ext_BACKUP_NUM_TO_RETAIN	integer	НЕТ	7	Не обязательный. Количество сохраняемых бекапов	minvalue=1; maxvalue=99
310	appVersion	string	ДА	17	Версия PostgreSQL	value_list=17, 16, 15, 14, 13
311	jsonParameters	json	ДА	{ "log_connections": "off", "log_disconnections": "off" }	Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html	maxlength=2048
312	enablePgPoolerMaster	boolean	ДА	false	Включает pgPooler (на запись). Будет создан новый под	value_list=false, true
313	enablePgPoolerSlave	boolean	ДА	false	Включает pgPooler (на чтение). Будет создан новый под	value_list=false, true
314	allowNoSSL	boolean	ДА	false	По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр	value_list=false, true
329	autoScale	boolean	ДА	false	Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги	value_list=false, true
330	autoScalePercentage	integer	ДА	10	Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема	value_list=10, 15, 20
331	autoScaleTechWindow	integer	ДА	0	Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)	value_list=0, 5, 12, 23
337	ipSpaceNameMaster	string	НЕТ		Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster. Пример: `internet-no-antiddos-v1`
338	ipSpaceNameSlave	string	НЕТ		Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave
339	autoScaleQuotaGb	string	ДА	1	Квота для autoScale

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
91	resourceInstances	integer	НЕТ		Количество узлов в сети	minvalue=1; maxvalue=7
92	resourceMemory	integer	НЕТ		Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
93	resourceCPU	integer	НЕТ		Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
94	resourceDisk	integer	НЕТ		Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
147	needExternalAddressMaster	boolean	ДА		Выделяет внешний IP для доступа к master	value_list=false, true
148	needExternalAddressSlave	boolean	ДА		Выделяет внешний IP для доступа к slave. Действует, если slave в принципе есть	value_list=false, true
267	ext_BACKUP_SCHEDULE	string	НЕТ		Не обязательный. Время запуска бекапа	regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$
268	ext_BACKUP_NUM_TO_RETAIN	integer	НЕТ		Не обязательный. Количество сохраняемых бекапов	minvalue=1; maxvalue=99
315	appVersion	string	ДА		Версия PostgreSQL. Нельзя опускать вниз	value_list=17, 16, 15, 14, 13
316	jsonParameters	json	НЕТ		Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html	maxlength=2048
317	enablePgPoolerMaster	boolean	ДА	false	Включает pgPooler (на запись). Будет создан новый под	value_list=false, true
318	enablePgPoolerSlave	boolean	ДА	false	Включает pgPooler (на чтение). Будет создан новый под	value_list=false, true
319	allowNoSSL	boolean	ДА	false	По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр	value_list=false, true
541	ipSpaceNameMaster	string	НЕТ		Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster. Пример: `internet-no-antiddos-v1`
542	ipSpaceNameSlave	string	НЕТ		Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	19	s3Uid, resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm, needExternalAddressMaster, needExternalAddressSlave, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN, appVersion, jsonParameters, enablePgPoolerMaster, enablePgPoolerSlave, allowNoSSL, autoScale, autoScalePercentage, autoScaleTechWindow, ipSpaceNameMaster, ipSpaceNameSlave, autoScaleQuotaGb	руководство
delete	instance	delete	``	20	deleteS3Bucket
modify	instance	modify	``	48	resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, needExternalAddressSlave, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN, appVersion, jsonParameters, enablePgPoolerMaster, enablePgPoolerSlave, allowNoSSL, ipSpaceNameMaster, ipSpaceNameSlave
recovery	action	recovery	``	47	resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm
restart	action	restart	``	54		ВНИМАНИЕ - Рестарт предполагает УДАЛЕНИЕ подов. Может быть полная поломка. Крайне осторожно запускать при работе
resume	instance	resume	``	114
suspend	instance	suspend	``	115

nubes_redis

• Service ID: 91
• Description: Управляемая база данных Redis
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Redis кластер. Под кеши.
Ресурсная платформа: k8s.
Автоматизация: k8s operator
port 6379

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
112	resourceCPU	integer	ДА	1000	Квота ядра пода (Указывается в mili)	minvalue=500; maxvalue=4000
113	resourceMemory	integer	ДА	1024	Квота памяти пода (Указывается в Megabytes)	minvalue=512; maxvalue=8192
114	resourceDisk	integer	ДА	30	Квота диска (Указывается в GIGAbytes)	minvalue=10; maxvalue=999
181	resourceInstances	integer	ДА	1	Количество узлов в сети. Если выделить больше 1 ноды, будет добавлено дополнительно 3 Sentinel ноды	minvalue=1; maxvalue=7
182	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
183	needExternalAddressMaster	boolean	ДА	false	Выделяет внешний IP для доступа к master	value_list=false, true
184	needExternalAddressSlave	boolean	ДА	false	Выделяет внешний IP для доступа к slave. Будет работать если slave в целом есть	value_list=false, true
548	ipSpaceNameMaster	string	НЕТ		Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster
549	ipSpaceNameSlave	string	НЕТ		Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	21	resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, needExternalAddressMaster, needExternalAddressSlave, ipSpaceNameMaster, ipSpaceNameSlave
delete	instance	delete	``	22

nubes_mongodb

• Service ID: 92
• Description: Управляемая база данных MongoDB
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию MongoDB через платформу

## 1. Общая информация

MongoDB — документоориентированная распределённая база данных, обеспечивающая высокую доступность, горизонтальное масштабирование и гибкую модель хранения.

### Доступные операции с кластером

* create — создание кластера
* delete — удаление кластера
* suspend — остановка кластера
* resume — запуск кластера

### Доступные операции с пользователями

* create_user — создание пользователя
* modify_user — модификация пользователя
* delete_user — удаление пользователя

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
487	resourceInstances	integer	ДА		Пример: `2`	minvalue=1; maxvalue=7
588	resourceMemory	integer	ДА		Пример: `2048`	minvalue=1000
589	resourceCPU	integer	ДА		Пример: `1000`
590	resourceDisk	integer	ДА		Пример: `20`
595	resourceRealm	string	ДА		Выбрать платформу из списка	func=getAvailableResourceRealms
645	needExternalAddressMaster	string	ДА	false	Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`	value_list=false, true
646	ipSpaceNameMaster	string	НЕТ		Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	37	resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm, needExternalAddressMaster, ipSpaceNameMaster
create_user	subresource	create	user	198	username, dbName, role
delete	instance	delete	``	190
delete_user	subresource	delete	user	199	username
modify_user	subresource	modify	user	200	username, dbName, role
resume	instance	resume	``	196
suspend	instance	suspend	``	194

nubes_rabbitmq

• Service ID: 93
• Description: Сервер очередей
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию RabbitMQ через платформу

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
116	resourceCPU	integer	ДА	1000	Пример: `2000`	minvalue=500; maxvalue=4000
117	resourceMemory	integer	ДА	1124	Пример: `2048`	minvalue=512; maxvalue=8192
118	resourceDisk	integer	ДА	30	Пример: `20`	minvalue=5; maxvalue=999
119	resourceRealm	string	ДА		Выбрать платформу из списка	func=getAvailableResourceRealms
224	resourceInstances	integer	ДА	1	Пример: `1`	minvalue=1; maxvalue=7
225	needExternalAddressMaster	boolean	ДА	false	Флаг, определяющий, нужно ли выделять внешний IP для доступа к master. Пример: `true` или `false`	value_list=false, true
543	ipSpaceNameMaster	string	НЕТ		Пример: `internet-no-antiddos-v1`

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
304	resourceCPU	integer	ДА		Пример: `2000`	minvalue=500; maxvalue=4000
305	resourceMemory	integer	ДА		Пример: `2048`	minvalue=512; maxvalue=8192
306	resourceDisk	integer	ДА		Пример: `20`	minvalue=1; maxvalue=999
307	resourceInstances	integer	ДА		Пример: `1`	minvalue=1; maxvalue=7
308	needExternalAddressMaster	boolean	ДА	false	Выделяет внешний (белый) IP для доступа к master	value_list=false, true
309	needExternalAddressSlave	boolean	ДА	false	Выделяет внешний (белый) IP для доступа к slave	value_list=false, true
545	ipSpaceNameMaster	string	НЕТ		Пример: `internet-no-antiddos-v1`
546	ipSpaceNameSlave	string	НЕТ		Пример: `internet-no-antiddos-v1`

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	38	resourceCPU, resourceMemory, resourceDisk, resourceRealm, resourceInstances, needExternalAddressMaster, ipSpaceNameMaster
delete	instance	delete	``	39
modify	instance	modify	``	106	resourceCPU, resourceMemory, resourceDisk, resourceInstances, needExternalAddressMaster, needExternalAddressSlave, ipSpaceNameMaster, ipSpaceNameSlave
resume	instance	resume	``	117
suspend	instance	suspend	``	116		Пока не работает из за того что RabbitmqCluster нельзя занулить

nubes_lucee

• Service ID: 94
• Description: Cервер приложений
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
103	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider
104	gitPath	string	ДА	https://github.com/xahys/testlucee	Путь до Git, который будет webroot для сайта
105	jsonEnv	json	НЕТ	{ "param": "value" }	Здесь вы можете задать переменные среды в формате KEY=VALUE. Они будут доступны внутри вашего приложения.	maxlength=2048
106	resourceCPU	integer	ДА	300	Квота ядра пода (milicores)	minvalue=100; maxvalue=4000
107	resourceMemory	integer	ДА	512	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
108	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
132	healthPath	string	НЕТ		Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код
139	resourceInstances	integer	ДА	1	Количество узлов в сети	minvalue=1; maxvalue=7
263	appVersion	string	ДА	5.4	Версия Lucee	regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
133	gitPath	string	НЕТ		Путь до Git, который будет webroot для сайта
134	healthPath	string	НЕТ		Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код.
135	jsonEnv	json	НЕТ		Массив переменных, будут переданы в env приложения	maxlength=2048
136	resourceCPU	integer	НЕТ		Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро	minvalue=100; maxvalue=4000
137	resourceMemory	integer	НЕТ		Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
138	resourceInstances	integer	НЕТ		Количество узлов в сети	minvalue=1; maxvalue=7
264	appVersion	string	ДА	5.4		regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	49	domain, gitPath, jsonEnv, resourceCPU, resourceMemory, resourceRealm, healthPath, resourceInstances, appVersion
delete	instance	delete	``	50
modify	instance	modify	``	55	gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, appVersion	Если CFS оставить пустым, то при запуске джобы берётся параметр из instanceData
redeploy	action	redeploy	``	53	resourceRealm
restart	action	restart	``	163
resume	instance	resume	``	95
suspend	instance	suspend	``	96

nubes_nodejs

• Service ID: 95
• Description: Cервер приложений
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Развертывает контейнер в k8s кластере с node:16, который можно использовать для запуска своих приложений.
Приложение должно быть доступно по ссылки в git репозитории, которая является входным параметром.

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
149	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
150	gitPath	string	ДА	https://github.com/xahys/testnode.git	Путь до Git, который будет webroot для сайта
151	healthPath	string	НЕТ		Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. Если оставить пустым, healtcheck'а не будет
152	jsonEnv	json	НЕТ		Массив переменных, будут переданы в env приложения
153	resourceCPU	integer	ДА	500	Квота ядра пода (milicores). 1000Mili = 1 Ядро	minvalue=100; maxvalue=4000
154	resourceMemory	integer	ДА	1024	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
155	resourceInstances	integer	ДА	1	Количество узлов в сети	minvalue=1; maxvalue=7
156	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
270	appVersion	string	ДА	23	Версия приложения	regex=^(\d){2}$; value_list=18, 20, 22, 23

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
157	gitPath	string	НЕТ		Путь до Git, который будет webroot для сайта
158	healthPath	string	НЕТ		Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код.
159	jsonEnv	json	НЕТ		Массив переменных, будут переданы в env приложения	maxlength=2048
160	resourceCPU	integer	НЕТ		Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро	minvalue=100; maxvalue=4000
161	resourceMemory	integer	НЕТ		Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
162	resourceInstances	integer	НЕТ		Количество узлов в сети	minvalue=1; maxvalue=7
271	appVersion	string	ДА	23	Версия приложения	regex=^(\d){2}$; value_list=18, 20, 22, 23

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	58	domain, gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, resourceRealm, appVersion
delete	instance	delete	``	61
modify	instance	modify	``	59	gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, appVersion
redeploy	action	redeploy	``	60	resourceRealm
resume	instance	resume	``	121
suspend	instance	suspend	``	120

nubes_pgadmin

• Service ID: 96
• Description: Административный интерфейс для PostgreSQL
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструмент с графическим интерфейсом для управления базами данных PostgreSQL

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
164	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider
165	resourceCPU	integer	ДА	200	Квота ядра пода (milicores). 1000Mili = 1 Ядро	minvalue=100; maxvalue=4000
166	resourceMemory	integer	ДА	256	Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
167	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
169	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
170	login	string	ДА		Логин для подключения к pgAdmin, в формате email (login@email.net)	regex=^([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\.[a-zA-Z0-9_-]+)$; maxlength=255; minlength=3
171	password	string	ДА		Пароль для подключения к pgAdmin

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
172	resourceCPU	integer	НЕТ		Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро	minvalue=100; maxvalue=4000
173	resourceMemory	integer	НЕТ		Квота памяти пода (MBytes)	minvalue=128; maxvalue=8192
174	resourceDisk	integer	НЕТ	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	62	domain, resourceCPU, resourceMemory, resourceDisk, resourceRealm, login, password
delete	instance	delete	``	63
modify	instance	modify	``	64	resourceCPU, resourceMemory, resourceDisk
redeploy	action	redeploy	``	65	resourceRealm
resume	instance	resume	``	123
suspend	instance	suspend	``	122

nubes_nodered

• Service ID: 97
• Description: Low-code платформа для IoT
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
193	resourceCPU	integer	ДА	500	Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро	minvalue=100; maxvalue=4000
194	resourceMemory	integer	ДА	512	Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
195	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
196	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
197	domain	string	ДА		Наименование поддомена, будет добавлено в k8stemplate.dev.nubes.ru	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider
323	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	72	resourceCPU, resourceMemory, resourceDisk, resourceRealm, domain, resourceInstances
delete	instance	delete	``	73

nubes_http

• Service ID: 98
• Description: Простой HTTP контейнер
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
212	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider
213	resourceCPU	integer	ДА	100	Квота ядра пода (Указывается в mili)	minvalue=100; maxvalue=4000
214	resourceMemory	integer	ДА	200	Квота памяти пода (Указывается в Megabytes)	minvalue=128; maxvalue=8192
215	resourceInstances	integer	ДА	1	Количество реплик приложения. Трафик будет распределяться между подами в режиме Round-Robin	minvalue=1; maxvalue=7
216	resourceRealm	string	ДА		Наименование кластера Kubernetes для подключения	func=getAvailableResourceRealms
217	registryPath	string	ДА	nexus-sa.tst.nubes.ru/docker-nubes/jolt	Путь до image, который будет установлен как deployment
241	jsonEnv	json	НЕТ	{"param": "value"}	Массив переменных, будут переданы в env приложения

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
218	resourceCPU	integer	ДА			minvalue=100; maxvalue=4000
219	resourceMemory	integer	ДА			minvalue=128; maxvalue=8192
220	resourceInstances	integer	ДА		Количество узлов	minvalue=1; maxvalue=7

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	77	domain, resourceCPU, resourceMemory, resourceInstances, resourceRealm, registryPath, jsonEnv
delete	instance	delete	``	78
modify	instance	modify	``	81	resourceCPU, resourceMemory, resourceInstances
redeploy	action	redeploy	``	79	resourceRealm
resume	instance	resume	``	130
suspend	instance	suspend	``	131

nubes_gitea

• Service ID: 99
• Description: Сервис контроля версий
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Развертывает сервис контроля версий Gitea
Зависит от сервиса postgresql который должен быть развернут заранее.

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
232	resourceCPU	integer	ДА	500	Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро	minvalue=300; maxvalue=4000
233	resourceMemory	integer	ДА	512	Квота памяти пода (Указывается в Megabytes)	minvalue=256; maxvalue=8192
234	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
235	resourceInstances	integer	ДА	1	Количество узлов в сети	minvalue=1; maxvalue=7
237	domain	string	ДА	web01	Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider
238	psqlUid	uuid	ДА		UUID Услуги k8sPgsql. Пользователя techGitea, базу данных gitea создаёт автоматически	ref_svc_id=90

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
259	resourceCPU	integer	ДА	100	Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро	minvalue=500; maxvalue=4000
260	resourceMemory	integer	ДА	128	Квота памяти пода (Указывается в Megabytes)	minvalue=256; maxvalue=8192
261	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
262	resourceInstances	integer	ДА	1	Количество узлов в сети	minvalue=1; maxvalue=7

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	82	resourceCPU, resourceMemory, resourceDisk, resourceInstances, domain, psqlUid
delete	instance	delete	``	83
modify	instance	modify	``	91	resourceCPU, resourceMemory, resourceDisk, resourceInstances
resume	instance	resume	``	127
suspend	instance	suspend	``	126

nubes_openwhisk

• Service ID: 100
• Description: Добавление и удаления пользователя (учетной записи, тенанта) для работы с Openwhisk
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Добавление и удаления пользователя для работы с Openwhisk

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
64	username	string	ДА		Имя пользователя Openwhisk
863	resourceRealm	string	ДА		Ресурсная платформа	func=getAvailableResourceRealms

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	41	username, resourceRealm
delete	instance	delete	``	42	username

nubes_dnszone

• Service ID: 110
• Description: Хостинг DNS зоны
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Необходимо делегировать зону у регистратора на Авторитетные DNS (Сервера зон)

ns3.ngcloud.ru
bash<br/>185.247.187.83<br/>2a10:aa80:0:5::3<br/>

ns4.ngcloud.ru
bash<br/>81.22.46.43<br/>2a10:aa80:0:6::3<br/>

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
66	zoneEmail	string	ДА		Контактный e-mail
67	zoneName	string	ДА		Имя зоны	regex=^([a-z0-9-]+\.)+[a-z0-9-]+$
68	zoneKind	string	ДА	NATIVE	Тип зоны	value_list=NATIVE, SLAVE
69	zoneMastersForSlave	string	НЕТ		Использовать если выбран тип SLAVE. IP адреса в формате через пробел для настройки Master-серверов
70	zoneTimeToRefresh	string	ДА	86400	Время ожидания ответа вторичного DNS перед запросом SOA-записи с первичных серверов
71	zoneTimeToRetry	string	ДА	7200	Время в течение которого сервер повторно попробует синхронизировать информацию с первичных DNS-серверов
72	zoneTimeToExpire	string	ДА	3600000	Время в течение которого вторичный DNS будет пытаться завершить синхронизацию зоны с первичным
73	zoneTimeToLive	string	ДА	86400	Время, в течение которого информация будет кешироваться другими DNS-серверами
284	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	43	zoneEmail, zoneName, zoneKind, zoneMastersForSlave, zoneTimeToRefresh, zoneTimeToRetry, zoneTimeToExpire, zoneTimeToLive, resourceRealm
delete	instance	delete	``	44

nubes_dnsrecord

• Service ID: 111
• Description: DNS запись в созданной зоне
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Необходима DNS зона, в которой будет создана DNS запись.
Выберите
* Зону в которой будет создана запись
* Тип записи
* Имя записи
* Значение записи

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
75	zoneUid	uuid	ДА		UUID экземпляра услуги DNS-зоны	ref_svc_id=110
76	recordType	string	ДА		Тип DNS-записи	value_list=A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT, LUA, NS, SSHFP
77	recordName	string	ДА		Имя записи. Имя зоны в конце проставляется автоматически	unique_scope=parent
78	recordInput	string	ДА		Значение. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP
450	recordTTL	integer	ДА	3600	Time-to-Leave записи. Раз в какое время запись будет обновлена	minvalue=30; maxvalue=604800

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
256	recordInput	string	ДА		Запись. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	45	zoneUid, recordType, recordName, recordInput, recordTTL
delete	instance	delete	``	46
modify	instance	modify	``	90	recordInput

nubes_tenant

• Service ID: 112
• Description: Организация доступов к мониторингу
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
239	grafanaOrgName	string	ДА		WZ-Код клиента	regex=^WZ[\d]+$
240	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	84	grafanaOrgName, resourceRealm
delete	instance	delete	``	86
modify	instance	modify	``	87		Просто удаляет все текущие датасоурсы и ставит их заново Полезно, когда нужно "ресетнуть" / "добавить"

nubes_vc_complex

• Service ID: 113
• Description: Создание готовой иерархии ресурсов
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Создает окружение для ВМ.

## Создает сервисы:
Организация
Виртуальный датацентр
Каталог
Сетевой шлюз периметра

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
332	resourceRealm	string	ДА		Наименование ресурсной платформы	func=getAvailableResourceRealms
334	vappName	string	ДА		Имя vApp	regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
358	vdcProviderGateway	string	ДА	sandbox-v1cl1-pvdc	Взять из свойств ресурсной платформы. Путь .vcd.providerVdc - взять KEY providerGateway Cloud Director. Влияет ресурсы будут предоставлены. Является полем (List<String>) в свойствах рес. платформы ЛК, но сам параметр передаётся только как один String
359	virtualServicesCount		ДА	1	Кол-во виртуальных сервисов, которые выделяются на AVI. Во избежании коллапса пока выделяется до 4	minvalue=1; maxvalue=4
360	ipSpaceName	string	НЕТ	internet-ipv4-v1	Имя ip Space для внешнего IP. Целесообразнее брать самый дешёвый, так как это vip для исходящего трафика. Необходимо задавать если включен needExternalAddressSNAT
399	storageConfig	json	ДА	[{"name": "", "size": 1024}]	Описывается как массив объектов, где описывается имя политики и её размер
400	vdcNetworkPool	string	ДА	nsxt-sandbox-geneve-np
401	cpuGuaranteed	integer	ДА	20		value_list=20, 50, 80
402	memGuaranteed	integer	ДА	20		value_list=20, 50, 80
403	segroupName	string	НЕТ	SEGROUP-SANDBOX-CL1-SHARED-01	Наименование segroup, в котором будут выделяться пулы на AVI
404	needExternalAddressSNAT	boolean	ДА	true	Выделяет внешний IP на Edge. Используется для SNAT всего трафика	value_list=false, true
405	needEnableAVI	boolean	ДА	false	Включает AVI в Cloud Director	value_list=false, true
566	cpuAllocated	string	ДА	1	шт	minvalue=1
567	memAllocated	integer	ДА	10	gb	minvalue=1
568	vIPCount	integer	ДА	0	ш	minvalue=0; maxvalue=20

Modify parameters

None.

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	107	resourceRealm, vappName, vdcProviderGateway, virtualServicesCount, ipSpaceName, storageConfig, vdcNetworkPool, cpuGuaranteed, memGuaranteed, segroupName, needExternalAddressSNAT, needEnableAVI, cpuAllocated, memAllocated, vIPCount

nubes_gitea_complex

• Service ID: 114
• Description: Комплексная услуга из ["gittea", "postgres"]
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Комплексная услуга из ["gittea", "postgres"]

Create parameters

None.

Modify parameters

None.

Operations

None.

nubes_mariadb

• Service ID: 115
• Description: Управляемая база данных MySQL
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Mariadb кластер. Ресурсная платформа: k8s. Автоматизация: k8s operator.
Автоматическое резервное копирование, ручное восстановление.

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
422	resourceRealm	string	ДА		Платформа для развертывания	func=getAvailableResourceRealms
424	resourceCPU	integer	ДА	500	Квота ядра пода (milicores)	minvalue=500; maxvalue=4000
425	resourceMemory	integer	ДА	1024	Квота памяти пода (MBytes)	minvalue=1024; maxvalue=8192
426	resourceDisk	integer	ДА	1	Квота диска (Указывается в GIGAbytes)	minvalue=1; maxvalue=999
427	resourceInstances	integer	ДА	1	Количество узлов	minvalue=1; maxvalue=7
428	needExternalAddressMaster	boolean	ДА	false	Выделяет внешний (белый) IP для доступа к master	value_list=false, true
429	ipSpaceNameMaster	string	НЕТ		Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster
430	ext_BACKUP_SCHEDULE	string	НЕТ	0 * * * *	Не обязательный. Время запуска бекапа	regex=^(\*|(\d+|\*\/\d+|\d+(,\d+)*))\s\*\s\*\s\*\s\*$
431	appVersion	string	ДА	9.4.0	Версия MySQL	value_list=8.4.0, 9.4.0
432	autoScale	boolean	ДА	false	Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги	value_list=false, true
433	autoScalePercentage	integer	НЕТ	10	Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема	value_list=10, 15, 20
434	autoScaleTechWindow	integer	НЕТ	0	Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)	value_list=0, 5, 12, 23
435	autoScaleQuotaGb	integer	НЕТ	1	Квота для autoScale
459	s3Uid	uuid	ДА		Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно	ref_svc_id=12

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
436	resourceCPU	integer	НЕТ
437	resourceMemory	integer	НЕТ
438	resourceInstances	integer	НЕТ
439	resourceDisk	integer	НЕТ
440	needExternalAddressMaster	boolean	НЕТ			value_list=false, true
441	ipSpaceNameMaster		НЕТ
442	ext_BACKUP_SCHEDULE	string	НЕТ
443	autoScale	boolean	НЕТ			value_list=false, true
444	autoScalePercentage	integer	НЕТ
445	autoScaleTechWindow	integer	НЕТ
446	autoScaleQuotaGb	integer	НЕТ

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	138	resourceRealm, resourceCPU, resourceMemory, resourceDisk, resourceInstances, needExternalAddressMaster, ipSpaceNameMaster, ext_BACKUP_SCHEDULE, appVersion, autoScale, autoScalePercentage, autoScaleTechWindow, autoScaleQuotaGb, s3Uid
delete	instance	delete	``	139	deleteS3Bucket
modify	instance	modify	``	142	resourceCPU, resourceMemory, resourceInstances, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, ext_BACKUP_SCHEDULE, autoScale, autoScalePercentage, autoScaleTechWindow, autoScaleQuotaGb
resume	instance	resume	``	141
suspend	instance	suspend	``	140

nubes_kafka

• Service ID: 116
• Description: Сервис создания кластера Apache Kafka
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Apache Kafka через платформу

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
461	resourceInstances	integer	ДА		Пример: `2`	minvalue=1; value_list=1, 2, 3, 4, 5
462	resourceMemory	integer	ДА		Пример: `2048`	minvalue=1000
463	resourceCPU	integer	ДА		Пример: `2000`	minvalue=1000
464	resourceDisk	integer	ДА		Пример: `20`
465	needExternalAddressMaster	boolean	ДА	false	Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`	value_list=false, true
466	ipSpaceNameMaster	string	НЕТ		Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`
469	resourceRealm	string	ДА		Выбрать платформу из списка	func=getAvailableResourceRealms

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
501	resourceInstances	integer	НЕТ		Пример: `2`	value_list=1, 2, 3, 4, 5
502	resourceMemory	integer	НЕТ		Пример: `2048`	minvalue=1000
503	resourceCPU		НЕТ		Пример: `2000`	minvalue=1000
504	resourceDisk	integer	НЕТ		Пример: `20`
505	needExternalAddressMaster	boolean	НЕТ	false	Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`	value_list=false, true
506	ipSpaceNameMaster	string	НЕТ		Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	148	resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, resourceRealm
create_topic	subresource	create	topic	165	nameTopic, partitions, replicas	# Инструкция по управлению топиками Apache Kafka через платформу ## 1. Общая информация --- Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам. Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API. --- ## Доступные операции - create_topic — Создание топика - modify_topic — Модификация топика - delete_topic — Удаление топика --- ## 2. Параметры создания топика Ниже перечислены параметры, которые необходимо указать при создании нового топика: * Имя топика Название топика. Должно быть уникальным в пределах кластера. Пример: orders-events. * Партиции Количество партиций топика. Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки. Пример: 6. Здесь важно рассказать о том как происходит расчет оптимального количества Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки. * Реплики Количество реплик для каждой партиции. Обычно равно количеству доступных брокеров или меньше. Пример: 3. --- ## 4. Параметры модификации топика Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными: * Имя топика Название топика. Пример: orders-events. * Партиции Новое количество партиций. Пример: 12. * Реплики Новое количество реплик. Пример: 2. --- ## 5. Рекомендации * Планируйте количество партиций с запасом — уменьшение их числа невозможно. * Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров. * Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки. ---
create_user	subresource	create	user	168	username, nameTopic, operations, group, accessHosts	# Инструкция по управлению пользователями Apache Kafka. --- ## 1. Общая информация Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру. Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам. Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka. --- ## Доступные операции - create_user — Создание пользователя - modify_user — Модификация пользователя - delete_user — Удаление пользователя --- ## 2. Параметры создания пользователя Ниже перечислены параметры, которые необходимо указать при создании нового пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 3. Параметры модификации пользователя Ниже перечислены параметры, которые необходимо указать при модификации пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 4. Параметры удалении пользователя Ниже перечислены параметры, которые необходимо указать при удалении пользователя: * Имя пользователя Имя удаляемого пользователя. Пример: username-admin ## 5. Выходные параметры После успешного создания пользователя платформа возвращает параметры, необходимые для подключения: * ca.crt Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении. Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>'
delete	instance	delete	``	149
delete_topic	subresource	delete	topic	167	nameTopic
delete_user	subresource	delete	user	170	username	# Инструкция по управлению пользователями Apache Kafka. --- ## 1. Общая информация Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру. Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам. Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka. --- ## Доступные операции - create_user — Создание пользователя - modify_user — Модификация пользователя - delete_user — Удаление пользователя --- ## 2. Параметры создания пользователя Ниже перечислены параметры, которые необходимо указать при создании нового пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 3. Параметры модификации пользователя Ниже перечислены параметры, которые необходимо указать при модификации пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 4. Параметры удалении пользователя Ниже перечислены параметры, которые необходимо указать при удалении пользователя: * Имя пользователя Имя удаляемого пользователя. Пример: username-admin ## 5. Выходные параметры После успешного создания пользователя платформа возвращает параметры, необходимые для подключения: * ca.crt Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении. Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>'
modify	instance	modify	``	162	resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster
modify_topic	subresource	modify	topic	166	nameTopic, partitions, replicas	# Инструкция по управлению топиками Apache Kafka через платформу ## 1. Общая информация --- Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам. Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API. --- ## Доступные операции - create_topic — Создание топика - modify_topic — Модификация топика - delete_topic — Удаление топика --- ## 2. Параметры создания топика Ниже перечислены параметры, которые необходимо указать при создании нового топика: * Имя топика Название топика. Должно быть уникальным в пределах кластера. Пример: orders-events. * Партиции Количество партиций топика. Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки. Пример: 6. Здесь важно рассказать о том как происходит расчет оптимального количества Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки. * Реплики Количество реплик для каждой партиции. Обычно равно количеству доступных брокеров или меньше. Пример: 3. --- ## 4. Параметры модификации топика Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными: * Имя топика Название топика. Пример: orders-events. * Партиции Новое количество партиций. Пример: 12. * Реплики Новое количество реплик. Пример: 2. --- ## 5. Рекомендации * Планируйте количество партиций с запасом — уменьшение их числа невозможно. * Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров. * Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки. ---
modify_user	subresource	modify	user	169	nameTopic, operations, group, accessHosts, username	# Инструкция по управлению пользователями Apache Kafka. --- ## 1. Общая информация Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру. Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам. Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka. --- ## Доступные операции - create_user — Создание пользователя - modify_user — Модификация пользователя - delete_user — Удаление пользователя --- ## 2. Параметры создания пользователя Ниже перечислены параметры, которые необходимо указать при создании нового пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 3. Параметры модификации пользователя Ниже перечислены параметры, которые необходимо указать при модификации пользователя: * Имя пользователя Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав. Пример: username-admin * Топик Название топика, к которому будут назначены права для данного пользователя. Пример: orders-events. Использовать маску нельзя (orders*), только полное название или *. * Операции Список разрешённых операций на указанном топике. Пример: Describe, Read, Write * Группа Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп. Пример: order-consumers. * Разрешённые хосты Список хостов или подсетей, с которых разрешено подключение пользователя. Пример: 192.168.1.0/24 или *. --- ## 4. Параметры удалении пользователя Ниже перечислены параметры, которые необходимо указать при удалении пользователя: * Имя пользователя Имя удаляемого пользователя. Пример: username-admin ## 5. Выходные параметры После успешного создания пользователя платформа возвращает параметры, необходимые для подключения: * ca.crt Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении. Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду ```bash echo '<содержание поля>'
resume	instance	resume	``	161
suspend	instance	suspend	``	160

nubes_nifi

• Service ID: 117
• Description: ETL-система
• MAN: embedded in resource page
• Operations: embedded in resource page

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
471	kafkaUid	uuid	ДА		Выбрать кластер из списка	ref_svc_id=116
472	partitions	integer	ДА		Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.
473	replicas	integer	ДА		Количество партиций ≤ (число брокеров). Пример `2`
474	nameTopic	string	ДА		Пример: `orders-events`

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
477	partitions	integer	НЕТ		Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.
478	replicas	integer	НЕТ		Количество партиций ≤ (число брокеров). Пример `2`

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	150	kafkaUid, partitions, replicas, nameTopic
delete	instance	delete	``	151
modify	instance	modify	``	154	partitions, replicas

nubes_akhq

• Service ID: 119
• Description: Web интерфейс Akhq для работы с Apache Kafka
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Apache Kafka через платформу

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
550	resourceRealm	string	ДА		Выбрать платформу из списка	func=getAvailableResourceRealms
551	resourceMemory	integer	ДА	512	Пример: `1024`	minvalue=512
552	resourceCPU	integer	ДА	500	Пример: `1000`	minvalue=500
553	domain	string	ДА		Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm	regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
554	resourceInstances	integer	ДА	1		minvalue=1
555	kafkaUid	uuid	ДА		Выбрать кластер из списка	ref_svc_id=116

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
565	kafkaUid	uuid	ДА		Выбрать кластер из списка	ref_svc_id=116

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	175	resourceRealm, resourceMemory, resourceCPU, domain, resourceInstances, kafkaUid
delete	instance	delete	``	176
modify	instance	modify	``	180	kafkaUid
resume	instance	resume	``	178
suspend	instance	suspend	``	177

nubes_clickhouse

• Service ID: 120
• Description: Управляемая база данных ClickHouse
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по управлению кластерами и пользователями ClickHouse

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
572	resourceRealm	string	ДА		Выбрать платформу из списка **Если список не отображается** обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы	func=getAvailableResourceRealms
573	s3Uid	uuid	ДА		**Если список не отображается** перейдите в раздел `S3 Object Storage` операция `create`	ref_svc_id=12
574	resourceInstances	integer	ДА	1	**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`	minvalue=1; maxvalue=7
575	resourceInstancesShards	integer	ДА	1	**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. **Реплика** - это точная копия данных внутри одного шарда	minvalue=1; maxvalue=7
576	resourceCPU	integer	ДА	1000	Указывается в Milicores `1000` Mili == `1` Ядро	minvalue=1000; maxvalue=8000
577	resourceMemory	integer	ДА	1536	Указывается в Megabytes	minvalue=1536; maxvalue=8192
578	appVersion	string	ДА	25.10	Версия `clickhouse-server`	value_list=25.10
579	resourceDisk	integer	ДА	10	Указывается в Gigabytes	minvalue=1; maxvalue=999
580	needExternalAddressMaster	boolean	ДА	false	Для выделения IP также необходимо указать имя Ip-space. Его можно получить из свойств ресурсной платформы	value_list=false, true
581	ipSpaceNameMaster	string	НЕТ		Имя ipSpace для публикации внешнего адреса Не может быть пустым, если включен `Выделение белого ip для master ноды`
582	needCreateKeeper	boolean	ДА	true	Аналог `Zookeeper`, представленный от ClickHouse	value_list=false, true
583	resourceCPUKeeper	integer	ДА	50	Указывается в Milicores `1000` Mili == `1` Ядро	minvalue=50; maxvalue=8000
584	resourceMemoryKeeper	integer	ДА	152	Указывается в Megabytes	minvalue=152; maxvalue=8192
585	resourceInstancesKeeper	integer	ДА	1	Для **теста** - 1 нода. Для **продуктива** - 3 ноды	minvalue=1; maxvalue=3; value_list=1, 3
586	ext_BACKUP_SCHEDULE	string	ДА	0 0 * * *	Принимает формат `CRON`	regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$
587	ext_BACKUP_NUM_TO_RETAIN	integer	ДА	7	Кол-во **полных** резервных копий Кол-во инкрементов - неограничено Полная резервная копия выполняется раз в неделю *Если изначально полной резервной копии нет* выполняется полный бекап В остальные дни по крону выполняются **инкременты**	minvalue=3; maxvalue=60

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
603	resourceInstances	integer	ДА		**Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper`	minvalue=1; maxvalue=7
604	resourceInstancesShards	integer	ДА		**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. **Реплика** - это точная копия данных внутри одного шарда	minvalue=1; maxvalue=7
605	resourceCPU	integer	ДА		Указывается в Milicores `1000` Mili == `1` Ядро	minvalue=1000; maxvalue=8000
606	resourceMemory	integer	ДА		Указывается в Megabytes	minvalue=1536; maxvalue=8192
607	appVersion	string	ДА	25.10	Версия `clickhouse-server`
608	resourceDisk	integer	ДА		Указывается в Gigabytes **Нельзя** выставлять меньше текущего значения	minvalue=1; maxvalue=999
609	needExternalAddressMaster	boolean	ДА		Для выделения IP также необходимо указать имя Ip-space. Его можно получить из свойств ресурсной платформы	value_list=false, true
610	ipSpaceNameMaster	string	ДА		Имя ipSpace для публикации внешнего адреса Не может быть пустым, если включен `Выделение белого ip для master ноды`
611	needCreateKeeper	boolean	ДА		Аналог `Zookeeper`, представленный от ClickHouse	value_list=false, true
612	resourceCPUKeeper	integer	ДА		Указывается в Milicores `1000` Mili == `1` Ядро	minvalue=50; maxvalue=8000
613	resourceMemoryKeeper	integer	ДА		Указывается в Megabytes	minvalue=152; maxvalue=8192
614	resourceInstancesKeeper	integer	ДА		Для **теста** - 1 нода. Для **продуктива** - 3 ноды	minvalue=1; maxvalue=3; value_list=1, 3
615	ext_BACKUP_SCHEDULE	string	ДА	0 0 * * *	Принимает формат `CRON`	regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$
616	ext_BACKUP_NUM_TO_RETAIN	integer	ДА		Кол-во **полных** резервных копий Кол-во инкрементов - неограничено Полная резервная копия выполняется раз в неделю *Если изначально полной резервной копии нет* выполняется полный бекап В остальные дни по крону выполняются **инкременты**	minvalue=3; maxvalue=60

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	181	resourceRealm, s3Uid, resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN	Операция создания кластера ClickHouse Для подключения к кластеру также необходимо создать базу данных через операцию create_database и создание пользователя через операцию create_user
create_database	subresource	create	database	186	databaseName	База данных создаётся на всех репликах кластера ClickHouse
create_user	subresource	create	user	185	username, databaseName, accessHosts
delete	instance	delete	``	184		Удаление возможно только после остановки сервиса через операцию suspend После выполнения операции необходимо выждать определенное кол-во времени
delete_database	subresource	delete	database	188	databaseName	Необратимое действие!!! Трижды подумай, заблокируй телефон тимлида и не выполняй это действие
delete_user	subresource	delete	user	187	username
modify	instance	modify	``	189	resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN
resume	instance	resume	``	183
suspend	instance	suspend	``	182		Операция приводит к удалению всех подов Persistent Volume остаются нетронутыми

nubes_valo_tenant

• Service ID: 149
• Description: Корпоративная система обмена и синхронизации файлов
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Инструкция по развертыванию Тенант Valo через платформу

## 1. Общая информация
Тенант Valo — логический изолированный экземпляр сервиса VALO Cloud, предоставляющий защищённое облачное хранилище, синхронизацию данных и доступ к документам с различных устройств. При создании тенант автоматически разворачивается в тестовом режиме сроком на 2 месяца. Перевод в промышленную эксплуатацию выполняется отдельной операцией.

### Доступные операции

* create — создание нового тенанта в тестовом режиме сроком на 2 месяца.
* modify — изменение настроек тенанта, включая перевод из ТЕСТ в ПРОД.
* suspend — выключение (приостановка работы) тенанта.
* resume — включение ранее приостановленного тенанта.
* delete — удаление тенанта; доступно...

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
655	resourceRealm	string	ДА			func=getAvailableResourceRealms
656	domain	string	ДА		Будет добавлено в зону valo.ngcloud.ru	regex=^[a-z0-9](?:[a-z0-9-]{3,61}[a-z0-9])?$; maxlength=61; minlength=3
657	valoOptions	map-fixed	ДА	{}
658	s3Storage	integer	ДА	10	Данные хранятся в отдельном экземпляре S3	minvalue=1; maxvalue=999

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
659	valoOptions	map-fixed	ДА
660	s3Storage	integer	ДА		Данные хранятся в отдельном экземпляре S3

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	202	resourceRealm, domain, valoOptions, s3Storage
delete	instance	delete	``	206
modify	instance	modify	``	203	valoOptions, s3Storage
resume	instance	resume	``	205
suspend	instance	suspend	``	204

nubes_k8s_sthutrval_cluster

• Service ID: 150
• Description: Платформа управления K8s
  
• MAN: embedded in resource page
• Operations: embedded in resource page

Summary

Перед разворачиванием убедиться, что в облаке есть 2 свободных невыделенных IP в пуле

Create parameters

ID	Code	Type	Required	Default	Description	Constraints
344	nsxtUid	uuid	ДА		InstanceUid nsxt. Nsxt должен быть создан	ref_svc_id=22
345	clusterName	string	ДА	example1	Наименование кластера Kubernetes. Имя будет использоваться в fqdn (svc.$CLUSTER_NAME)	regex=(?=^.{1,63}$)^[a-z0-9]([a-z0-9-]*[a-z0-9])?$; unique_scope=provider
346	controlPlaneSizingPolicy	string	ДА		Настройка Control Plane. CPU (шт) / MEM (gb). Наверное, должна подтягиваться из свойств ресурсной платформы
347	controlPlaneSizingDisk	integer	ДА	30	Настройка Control Plane. Disk (Gb)	minvalue=20; maxvalue=999
348	controlPlaneCount	integer	ДА	1		minvalue=1; maxvalue=9
349	workersSizingPolicy	string	ДА		Настройка workers. CPU (шт) / MEM (gb)
350	workersSizingDisk	integer	ДА	40	Настройка workers. Disk (Gb)	minvalue=20; maxvalue=999
351	workersCount	integer	ДА	2	Настройка workers. Кол-во нод	minvalue=1; maxvalue=99
352	appVersion	string	ДА	2.12.1	Версия Штурвал (не является версией Kubernetes)	value_list=2.12.1, 2.11.0
353	needExternalAddressAPI	boolean	ДА	true	Выделяет внешний IP для доступа к kubernetes API. Пока нельзя выставить false	value_list=true
354	accessIpListAPI	json	ДА	[]	Access IP List для подключения к Kubernetes API. Указывается массив. Если передан пустой массив, доступ выделяется всем
355	needExternalAddressIngress	boolean	ДА	true	Выделяет внешний IP для доступа к Ingress	value_list=true
356	accessIpListIngress	json	ДА	[]	Access IP List для подключения к Ingress. Указывается массив. Если передан пустой массив, доступ выделяется всем
747	vdcUid	uuid	ДА			ref_svc_id=21

Modify parameters

ID	Code	Type	Required	Default	Description	Constraints
362	controlPlaneCount	integer	НЕТ		Кол-во нод Control Plane	minvalue=1; maxvalue=9
363	workersCount	integer	НЕТ		Кол-во нод Workers	minvalue=1; maxvalue=99
364	accessIpListAPI	json	НЕТ		Access IP List для подключения к Kubernetes API. Указывается массив. Если передан пустой массив, доступ выделяется всем
365	accessIpListIngress	json	НЕТ		Access IP List для подключения к Ingress. Указывается массив. Если передан пустой массив, доступ выделяется всем
563	appVersion	string	НЕТ		Версия Штурвал (не является версией Kubernetes) Понижать версию нельзя Обновиться на несколько минорных нельзя Невозможно перепрыгнуть не с последней минорной на мажорную Можно обновиться на несколько патчей	value_list=2.11.0, 2.12.1
637	controlPlaneSizingDisk	integer	ДА
638	workersSizingDisk	integer	ДА

Operations

Operation	Kind	Action	Subresource	ID	Params	Description
create	instance	create	``	108	nsxtUid, clusterName, controlPlaneSizingPolicy, controlPlaneSizingDisk, controlPlaneCount, workersSizingPolicy, workersSizingDisk, workersCount, appVersion, needExternalAddressAPI, accessIpListAPI, needExternalAddressIngress, accessIpListIngress, vdcUid
delete	instance	delete	``	109
modify	instance	modify	``	110	controlPlaneCount, workersCount, accessIpListAPI, accessIpListIngress, appVersion, controlPlaneSizingDisk, workersSizingDisk
reconcile	action	reconcile	``	253
resume	instance	resume	``	174
suspend	instance	suspend	``	173
update_secrets	action	update_secrets	``	179