polygon/site/services/22_vc_nsxt.yaml

name: vc_nsxt
service_id: 22
service_display_name: Сетевой шлюз периметра (Edge)
service_short_name: vc_nsxt
service_man: '# Инструкция по развертыванию Сетевой шлюз периметра (Edge) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Сетевой шлюз периметра (Edge)** предназначен для создания периметрового
  сетевого шлюза в рамках одного виртуального датацентра (vDC) или группы виртуальных датацентров (groupvDC).  <br/>При создании автоматически разворачивается routed-сеть с адресным пространством `10.10.102.0/24`.  <br/>Сервис
  обеспечивает сетевую изоляцию, маршрутизацию, а также может включать функциональность балансировщика нагрузки AVI (ALB) для последующей интеграции, включая поддержку кластеров Штурвал.<br/><br/>### Доступные
  операции<br/><br/>**create** — Создание нового Edge с привязкой к vDC или groupvDC и развёртыванием routed-сети.  <br/>**delete** — Удаление ранее созданного Edge. Недоступно при наличии зависимых услуг
  (vApp, VM, Кластер Штурвал).  <br/>**modify** — Изменение параметров и сетевых настроек существующего Edge.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Ниже приведены параметры операции
  **create**.<br/><br/>### Тип родительской услуги<br/>Определяет контекст размещения Edge.  <br/>Допустимые значения: `vdc`, `groupvdc`.  <br/>Использование:<br/>- При выборе `vdc` обязателен параметр
  **UUID VDC**.<br/>- При выборе `groupvdc` обязателен параметр **UUID Группы VDC**.<br/><br/>### UUID VDC<br/>Идентификатор виртуального датацентра.  <br/>Необходимо предварительно создать vDC через услугу
  «Виртуальный датацентр (vDC)».  <br/>Указывается только при выборе родительского типа `vdc`.<br/><br/>### UUID Группы VDC<br/>Идентификатор группы виртуальных датацентров.  <br/>Создаётся через услугу
  «Группа виртуальных датацентров (groupvDC)».  <br/>Используется при выборе родительского типа `groupvdc`.<br/><br/>### Включить ALB<br/>Флаг активации AVI Load Balancer в Cloud Director.  <br/>Пример
  значения: `true`/`false`.  <br/>Нужен для развёртывания кластера Штурвал и возможности создания Virtual Services.<br/><br/>### Наименование segroup<br/>Имя сервиса групп (segroup) на уровне ресурсной
  платформы.  <br/>Обязательно при включённом ALB.  <br/>Определяет группу, в которой будут выделяться пулы AVI для Virtual Services.<br/><br/>### virtualServicesCount<br/>Количество резервируемых виртуальных
  сервисов (Virtual Services) на AVI.  <br/>Типичное значение: 1–10 в зависимости от нагрузки.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение (Test)<br/><br/>-
  Тип родительской услуги: `vdc`  <br/>- virtualServicesCount: 1–2  <br/>- ALB: выключен по умолчанию (включать только при необходимости тестирования Штурвала)  <br/>- segroup: задаётся только при включённом
  ALB  <br/>- VDC гарантии CPU/RAM: минимальные (поскольку изменить их после создания нельзя)<br/><br/>### Промышленное окружение (Production)<br/><br/>- Тип родительской услуги: `groupvdc` при работе с
  распределёнными нагрузками или `vdc` для локализованных проектов  <br/>- virtualServicesCount: 3–10, исходя из предполагаемого количества публикаций  <br/>- ALB: включён, если требуется высокая доступность
  сервисов или используется кластер Штурвал  <br/>- segroup: рекомендуется использовать выделенную группу под проект  <br/>- VDC гарантии CPU/RAM: повышенные, с учётом того, что изменить их после создания
  невозможно без пересоздания vDC<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>### Имя Edge<br/>Уникальное название созданного сетевого шлюза, используется для ссылок и дальнейших операций.<br/><br/>###
  Имя routed-сети<br/>Автоматически созданная routed-сеть с подсетью `10.10.102.0/24`, используется для подключения ресурсов.<br/><br/>### Параметры Edge<br/>Набор параметров, указанных пользователем при
  создании: тип услуги, ALB, segroup, virtualServicesCount и др.  <br/>Используются в операциях modify и для анализа состояния сервиса.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- В
  рамках сервиса **один раз при создании задаётся гарантированная доля CPU/RAM vDC**. Изменить её невозможно — требуется пересоздание vDC.  <br/>- Удаление Edge недоступно при наличии зависимых ресурсов
  (vApp, VM, кластер Штурвал).  <br/>- При использовании ALB необходимо корректно указывать segroup, чтобы обеспечить корректное выделение пулов AVI.  <br/>- При выборе режима `groupvdc` следует учитывать
  распределение нагрузки между несколькими vDC.  <br/>- SNAT для всех ресурсов внутри Edge можно активировать через операцию modify (параметры выделения VIP и ipSpace).<br/><br/>'
lifecycle:
  suspendOnDestroyDefault: false
  adoptExistingOnCreateDefault: false
operations:
- svcOperationId: 10
  operation: create
  kind: instance
  action: create
- svcOperationId: 25
  operation: delete
  kind: instance
  action: delete
- svcOperationId: 111
  operation: modify
  kind: instance
  action: modify
- svcOperationId: 252
  operation: reconcile
  kind: action
  action: reconcile
stateOut: {}
cfsParams:
- svcOperationCfsParamId: 8
  svcOperationCfsParam: vdcUid
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 340
  svcOperationCfsParam: needEnableAVI
  dataType: boolean
  isRequired: true
  defaultValue: 'false'
  isModifiable: true
  valueList:
  - 'false'
  - 'true'
- svcOperationCfsParamId: 341
  svcOperationCfsParam: virtualServicesCount
  dataType: integer > 0
  isRequired: false
  defaultValue: '1'
  isModifiable: true
- svcOperationCfsParamId: 621
  svcOperationCfsParam: vdcType
  dataType: string
  isRequired: true
  defaultValue: vdc
  isModifiable: false
  valueList:
  - vdc
  - vdcGroup
- svcOperationCfsParamId: 622
  svcOperationCfsParam: vdcGroupUid
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 825
  svcOperationCfsParam: qosProfile
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 368
  svcOperationCfsParam: needEnableAVI
  dataType: boolean
  isRequired: false
  defaultValue: ''
  isModifiable: true
  valueList:
  - 'false'
  - 'true'
- svcOperationCfsParamId: 369
  svcOperationCfsParam: virtualServicesCount
  dataType: integer > 0
  isRequired: false
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 372
  svcOperationCfsParam: ipSpaceName
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 856
  svcOperationCfsParam: qosProfile
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: true
cfsParamsByOp:
  10:
  - 8
  - 340
  - 341
  - 621
  - 622
  - 825
  25: []
  111:
  - 368
  - 369
  - 372
  - 856
  252: []
stateParams:
  vdcUid: ''
  needEnableAVI: 'false'
  virtualServicesCount: '1'
  vdcType: vdc
  vdcGroupUid: ''
  qosProfile: ''