polygon/site/services/dev/116_kafka.yaml

name: kafka
service_id: 116
service_display_name: ApacheKafka
service_short_name: kafka
service_man: '# Инструкция по развертыванию Организация в Cloud Director через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Организация в Cloud Director** предназначен для управления изолированными
  организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль
  уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.<br/><br/>### Доступные операции<br/><br/>**create**
  — Создание новой организации с заданными характеристиками и типом доступа.<br/>**delete** — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей.<br/>**modify**
  — Изменение параметров внутри организации (на текущий момент поддерживается изменение ipSpaces).<br/>**suspend** — Заморозка организации, ограничение возможности изменения и добавления сущностей.<br/>**resume**
  — Разморозка организации, восстановление функций управления.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание:
  платформа, на которой будет создана организация.<br/>Пример значения: `ngcloud.ru`.<br/><br/>### Тип организации<br/>Описание: тип создаваемой организации.<br/>Варианты:<br/>- `iaas` — организация с прямым
  доступом к облаку и авторизацией через Keycloak.<br/>- `saas` — организация под управлением Nubes, без прямого доступа к облаку.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>###
  Тестовое окружение<br/>- Тип организации: `iaas` для обеспечения полного доступа к облачным ресурсам и самостоятельного управления.<br/><br/>### Промышленное окружение<br/>- Тип организации: `saas` (упрощённая
  модель использования).<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Услуга предоставляет следующие выходные параметры (формируются в процессе операций):<br/><br/>### Идентификатор организации<br/>Уникальный
  идентификатор созданной организации. Используется для всех дальнейших API-операций.<br/><br/>### Статус организации<br/>Отражает текущее состояние: active, suspended, modifying, deleting.<br/><br/>###
  Параметры сети<br/>Выходные данные при наличии ipSpaces: список выделенных внешних IP, имя ip_space, количество IP.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/><br/>- Для конфигурации внешних
  IP внутри организации необходимо предварительно создать:<br/>-- хотя бы один **Виртуальный датацентр (VDC)**;<br/>-- хотя бы один **Сетевой шлюз периметра (Edge Gateway)**, привязанный к этой организации.<br/>-
  Удаление организации возможно только через 14 дней после перевода в состояние suspend.<br/>- Удаление организации приводит к удалению всех связанных сущностей: VDC, Edge Gateway, пулов IP, сетей, ВМок
  и иных объектов.<br/>- Операция suspend не останавливает виртуальные машины, но блокирует любые изменения инфраструктуры внутри организации.<br/>- Для iaas-организаций доступ осуществляется через Keycloak.<br/><br/>'
lifecycle:
  suspendOnDestroyDefault: true
  adoptExistingOnCreateDefault: false
operations:
- svcOperationId: 148
  operation: create
  kind: instance
  action: create
- svcOperationId: 165
  operation: create_topic
  kind: subresource
  action: create
- svcOperationId: 168
  operation: create_user
  kind: subresource
  action: create
- svcOperationId: 149
  operation: delete
  kind: instance
  action: delete
- svcOperationId: 167
  operation: delete_topic
  kind: subresource
  action: delete
- svcOperationId: 170
  operation: delete_user
  kind: subresource
  action: delete
- svcOperationId: 162
  operation: modify
  kind: instance
  action: modify
- svcOperationId: 166
  operation: modify_topic
  kind: subresource
  action: modify
- svcOperationId: 169
  operation: modify_user
  kind: subresource
  action: modify
- svcOperationId: 161
  operation: resume
  kind: instance
  action: resume
- svcOperationId: 160
  operation: suspend
  kind: instance
  action: suspend
stateOut:
  topics: {}
  users: {}
cfsParams:
- svcOperationCfsParamId: 1084
  svcOperationCfsParam: startupConfiguration
  dataType: map-fixed
  isRequired: true
  defaultValue: ''
  isModifiable: false
  dataDescriptor:
    resourceRealm:
      dataType: string
      defaultValue: ''
      isRequired: true
      isModifiable: false
      valueList:
      - k8s-3-sandbox-nubes-ru
      - k8s-4-sandbox-nubes-ru
- svcOperationCfsParamId: 1085
  svcOperationCfsParam: clusterConfiguration
  dataType: map-fixed
  isRequired: true
  defaultValue: ''
  isModifiable: true
  dataDescriptor:
    cpu:
      dataType: integer > 0
      defaultValue: '2000'
      isRequired: true
      isModifiable: false
    memory:
      dataType: integer > 0
      defaultValue: '2048'
      isRequired: true
      isModifiable: false
    replicas:
      dataType: integer > 0
      defaultValue: ''
      isRequired: true
      isModifiable: false
      valueList:
      - '1'
      - '3'
      - '5'
      - '7'
    disk:
      dataType: integer > 0
      defaultValue: '1'
      isRequired: true
      isModifiable: false
- svcOperationCfsParamId: 1086
  svcOperationCfsParam: accessConfiguration
  dataType: map-fixed
  isRequired: true
  defaultValue: ''
  isModifiable: true
  dataDescriptor:
    allocationExternal:
      dataType: boolean
      defaultValue: 'false'
      isRequired: true
      isModifiable: false
      valueList:
      - 'false'
      - 'true'
    masterAccessList:
      dataType: json
      defaultValue: '[]'
      isRequired: true
      isModifiable: false
- svcOperationCfsParamId: 523
  svcOperationCfsParam: nameTopic
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 524
  svcOperationCfsParam: partitions
  dataType: integer > 0
  isRequired: true
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 525
  svcOperationCfsParam: replicas
  dataType: integer > 0
  isRequired: true
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 530
  svcOperationCfsParam: username
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 531
  svcOperationCfsParam: nameTopic
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: false
- svcOperationCfsParamId: 532
  svcOperationCfsParam: operations
  dataType: array
  isRequired: true
  defaultValue: ''
  isModifiable: false
  valueList:
  - Create
  - Describe
  - Read
  - Write
- svcOperationCfsParamId: 533
  svcOperationCfsParam: group
  dataType: string
  isRequired: true
  defaultValue: '*'
  isModifiable: false
- svcOperationCfsParamId: 534
  svcOperationCfsParam: accessHosts
  dataType: string
  isRequired: true
  defaultValue: '*'
  isModifiable: false
- svcOperationCfsParamId: 529
  svcOperationCfsParam: nameTopic
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 540
  svcOperationCfsParam: username
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 1087
  svcOperationCfsParam: clusterConfiguration
  dataType: map-fixed
  isRequired: true
  defaultValue: ''
  isModifiable: true
  dataDescriptor:
    cpu:
      dataType: integer > 0
      defaultValue: '2000'
      isRequired: true
      isModifiable: false
    memory:
      dataType: integer > 0
      defaultValue: '2048'
      isRequired: true
      isModifiable: false
    replicas:
      dataType: integer > 0
      defaultValue: '1'
      isRequired: true
      isModifiable: false
      valueList:
      - '1'
      - '3'
      - '5'
      - '7'
    disk:
      dataType: integer > 0
      defaultValue: '1'
      isRequired: true
      isModifiable: false
- svcOperationCfsParamId: 1088
  svcOperationCfsParam: accessConfiguration
  dataType: map-fixed
  isRequired: true
  defaultValue: ''
  isModifiable: true
  dataDescriptor:
    allocationExternal:
      dataType: boolean
      defaultValue: 'false'
      isRequired: true
      isModifiable: false
      valueList:
      - 'false'
      - 'true'
    masterAccessList:
      dataType: json
      defaultValue: '[]'
      isRequired: true
      isModifiable: false
- svcOperationCfsParamId: 526
  svcOperationCfsParam: nameTopic
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 527
  svcOperationCfsParam: partitions
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 528
  svcOperationCfsParam: replicas
  dataType: string
  isRequired: false
  defaultValue: ''
  isModifiable: true
- svcOperationCfsParamId: 535
  svcOperationCfsParam: nameTopic
  dataType: string
  isRequired: false
  defaultValue: '*'
  isModifiable: true
- svcOperationCfsParamId: 536
  svcOperationCfsParam: operations
  dataType: array
  isRequired: false
  defaultValue: ''
  isModifiable: true
  valueList:
  - Create
  - Describe
  - Read
  - Write
- svcOperationCfsParamId: 537
  svcOperationCfsParam: group
  dataType: string
  isRequired: false
  defaultValue: '*'
  isModifiable: true
- svcOperationCfsParamId: 538
  svcOperationCfsParam: accessHosts
  dataType: string
  isRequired: false
  defaultValue: '*'
  isModifiable: true
- svcOperationCfsParamId: 539
  svcOperationCfsParam: username
  dataType: string
  isRequired: true
  defaultValue: ''
  isModifiable: true
cfsParamsByOp:
  148:
  - 1084
  - 1085
  - 1086
  165:
  - 523
  - 524
  - 525
  168:
  - 530
  - 531
  - 532
  - 533
  - 534
  149: []
  167:
  - 529
  170:
  - 540
  162:
  - 1087
  - 1088
  166:
  - 526
  - 527
  - 528
  169:
  - 535
  - 536
  - 537
  - 538
  - 539
  161: []
  160: []
stateParams:
  startupConfiguration: '{"resourceRealm": ""}'
  clusterConfiguration: '{"cpu": 2000, "memory": 2048, "replicas": 0, "disk": 1}'
  accessConfiguration: '{"allocationExternal": false, "masterAccessList": "[]"}'