Настройка организации с нуля

Получить демо

Инструкция описывает последовательность действий по созданию организации, настройке окружения и подготовке организации для дальнейшей работы.

Этапы настройки организации с нуля:

Создание новой организации
Создание среды
Создание информационной системы
Создание дата-центра, сегмента сети для организации и платформы
Создание страницы справочника
Обновление управляющего хоста
Настройка структуры организации
Настройка сети для виртуальных машин

Этапы взаимосвязаны, поэтому рекомендуется соблюдать приведенную последовательность.

Создавать новую среду, информационную систему, дата-центр, сегмент сети и структуру организации необязательно: можно использовать уже готовые решения.

1. Создание организации

Пользователь с правами администратора может создавать отдельные организации в Control Panel Cloudlink.

Чтобы создать новую организацию:

Перейдите в раздел Доступ → Организации.
Нажмите Создать.
Введите параметры:
- Название — название вашей организации.
- Email владельца — email-адрес владельца организации.
- (Опционально) Описание — кратко опишите организацию.
- Тарифные планы — выберите ранее созданный тарифный план.
- DNS-серверы — укажите адрес DNS-сервера или серверов через запятую.
Нажмите Далее.
Настройте Бюджет организации:
- Чтобы создать организацию без назначения бюджета, нажмите Далее без бюджета.
- Чтобы задать бюджет:
  - Укажите сумму в рублях (допускается только положительное число).
  - (Опционально) Включите параметр Отправлять уведомление Администратору, чтобы получать уведомления при превышении заданного порога использования бюджета.
    
    После включения параметра укажите процент от 1 до 100, при достижении которого будет отправлено уведомление администратору Портала.
    
    Подробнее — в инструкции об Уведомлениях о бюджете.
Нажмите Далее.
Настройте Квоты организации:
- Чтобы создать организацию без ресурсных квот, нажмите Далее без квот. Вы можете задать квоты после создания организации.
- Чтобы задать квоты для организации:
  - Выберите платформу для подключения из списка.
  - Активируйте поля для квот по CPU, RAM, Диск и RAM(GPU) и задайте значения для них.
Нажмите Далее.
Проверьте параметры и нажмите Создать организацию.

После завершения настройки организация будет создана с указанными параметрами и станет доступна для дальнейшей работы.

2. Создание среды

Среда назначается проекту и связывает его с определёнными сетями. К этим сетям подключаются платформы виртуализации. В зависимости от того, какие сети входят в среду, проект получает доступ к разным платформам, если их несколько.

Чтобы создать среду:

Перейдите в сервис Portal Manager по адресу https://portal-manager.sample.box/admin, где portal-manager — имя хоста (конкретный сервер или сервис), sample.box — домен (в этом примере тестовый), а /admin — путь, ведущий в административный раздел сервиса.
В верхнем меню выберите вкладку Среда.
Нажмите Создать Среда.
В разделе Создать Среда заполните поля:
- Тип — выберите тип среды из значений по умолчанию: TEST, DEV или PROD.
- Название — укажите название заглавными латинскими буквами.
- Назначение среды — укажите назначение среды.
- Организация — в выпадающем списке выберите название созданной организации.
Нажмите Создать.

3. Создание информационной системы

Информационная система закрепляется за конкретной папкой организации. При создании папки в соответствующем проекте автоматически выбирается среда, привязанная к указанной информационной системе.

Чтобы создать информационную систему:

Перейдите в сервис Portal Manager по адресу https://portal-manager.sample.box/admin.
На вкладке Информационные системы нажмите Создать Информационная система.
В верхнем меню выберите вкладку Информационные системы.
Нажмите Создать Информационная система.
- Название — укажите название информационной системы
- (Опционально) Короткое название — укажите короткое название информационной системы.
- Код ИС — укажите 4 латинские строчные буквы.
  
  Длина и регистр зафиксированы: значение поля — 4 строчные буквы.
- (Опционально) Короткий код — укажите короткий код информационной системы.
- (Опционально) Тип — укажите тип информационной системы.
- (Опционально) Владелец ИС — укажите владельца информационной системы.
- (Опционально) Статус — укажите статус информационной системы.
- Приоритет — по умолчанию 2.
- Организация — выберите созданную ранее организацию.
- Окружения организации — на данном этапе в списке отсутствуют значения.
  
  Окружение организации указывается после создания информационной системы.
Нажмите Создать.

Откроется раздел с именем созданной информационной системы.
Нажмите Изменить Информационная система.
В поле Окружения организации выберите созданную ранее среду.
Нажмите Обновить.

К информационной системе может быть привязано несколько сред. Чтобы добавить новую среду — повторите действия, аналогичные добавлению первой.

4. Создание дата-центра

Чтобы создать дата-центр:

В Control Panel Cloudlink перейдите в раздел Инфраструктура → Дата-центры.
Нажмите Создать дата-центр.
В окне Создать дата-центр:
1. Заполните поля:
  - Код — укажите код дата-центра.
  - Обозначение латиницей — укажите обозначение дата-центра (может совпадать с кодом).
  - Организация — выберите созданную ранее организацию.
  - (Опционально) Вес — выберите вес. Вес определяет приоритет созданной сущности в списке: чем значение меньше, тем выше приоритет.
  - (Опционально) Сегменты сети — на этом этапе не задаются.
2. Включите опцию Доступен на форме заказа.
3. Нажмите Создать.

Если сегмент сети создается до дата-центра, он будет доступен для выбора в поле Сегменты сети.

5. Создание сегмента сети

Чтобы создать сегмент сети:

В Control Panel Cloudlink перейдите в раздел Инфраструктура → Сегменты сети и нажмите Создать сегмент сети.
В окне Создать сегмент сети:
1. Заполните поля:
  - Название — укажите название сегмента сети.
  - Код — укажите код сегмента сети (может совпадать с названием).
  - Организация — выберите созданную ранее организацию.
  - (Опционально) Вес — выберите вес. Вес определяет приоритет созданной сущности в списке: чем значение меньше, тем выше приоритет.
  - Дата-центры — выберите созданный ранее дата-центр.
  - Среды — выберите одну или несколько созданных ранее сред.
  - (Опционально) Домены — оставьте поле пустым.
2. Нажмите Создать.

Чтобы проверить привязку сегмента сети к дата-центру:

Перейдите в Инфраструктура → Дата-центры.
Напротив нужного дата-центра нажмите ⋮ и выберите Редактировать.
Убедитесь, что в поле Сегменты сети указан созданный сегмент сети.

6. Создание платформы

Чтобы создать платформу:

В Control Panel Cloudlink перейдите в раздел Инфраструктура → Платформы.
Нажмите Создать платформу.
1. Заполните поля:
  - Название — укажите название платформы.
  - Код — укажите код платформы (может совпадать с названием).
  - Организация — выберите созданную ранее организацию.
  - (Опционально) Вес — выберите вес.Вес определяет приоритет созданной сущности в списке: чем значение меньше, тем выше приоритет.
2. Нажмите Создать.

Чтобы добавить сегменты сети и дата-центры к платформе:

Нажмите ⋮ напротив созданной платформы и выберите Редактировать.
1. В поле Сегменты сети выберите созданный ранее сегмент сети.
2. В поле Дата-центры выберите созданный ранее дата-центр.
3. Нажмите Сохранить.

7. Создание страницы справочника

Чтобы создать страницу в справочнике:

В Control Panel Cloudlink перейдите в раздел Конструктор → Справочники.
В списке выберите resource_pool.
В разделе resource_pool нажмите Добавить страницу.
Заполните поля:
- Имя — имя справочника, соответствующее имени платформы.
- Теги — добавьте тег с именем страницы и тег vm.
- Степень важности — оставьте по умолчанию.
- PageData — заполните поле JSON‑описанием ресурсов платформы.
  { "data": { "resource_pool": { "name": "zvirt-test", "uuid": "e5e264e4-000-0000-0000000", "domain": "zVirt-test-data", "endpoint": "https://zvirt-test.cloudlink.box", "platform": "zvirt", "provider_name": "zvirt" } }, "category": "vm", "platform": "zvirt" }
- resource_pool — описывает пул ресурсов для создания платформы:
  - name — название кластера хранения из системы виртуализации.
  - uuid — идентификатор кластера хранения.
  - domain — название домена хранения, который будет доступен для заказа ресурсов на платформе Cloudlink.
  - endpoint — FQDN системы виртуализации.
- category — описывает категорию использования. Например, "category": "vm" обозначает, что платформа используется для размещения виртуальных машин.
- platform — описывает тип платформы, который в большинстве случаев зависит от используемой системы виртуализации.
Нажмите Сохранить.

8. Обновление управляющего хоста

8.1. Обновление конфигурационного файла

После добавления страницы справочника необходимо обновить конфигурацию на управляющем хосте.

Добавьте описание нового подключения в файл config.yml, расположенном в каталоге inventories/box/group_vars/{}.

platforms:
  zvirt-test:
    type: zvirt
    label: zvirt-test
    scheme: https
    host: zvirt-test.cloudlink.box
    port: 443
    username: 'user@internal'
    password: '12345'
    params:
      weight: 100
      cluster_id: e5e264e4-000-0000-0000000
      cluster_name: cluster_name
      storage_name: domain_name

Значения параметров соответствуют значениям ранее созданной страницы справочника resource_pool.

Описание всех параметров для разных платформ — в инструкции по установке CloudLink — Настройки файла config.yml.

8.2. Обновление компонента Cloud Mate

После обновления конфигурационного файла на управляющем хосте необходимо обновить компонент Cloud Mate.

Запустите Docker-контейнер командой:

docker run -it --network host --pids-limit=131072 --rm \
    -v /$HOME/portal-box:/apps \
    -v ~/.ssh/id_rsa:/root/.ssh/id_rsa \
    -v ~/.kube/cloudlink:/root/.kube/cloudlink \
    deploy-manager:1.9.1 \
    -i inventories/box/hosts \
    -u $USER \
    deploy.yml \
    --ask-vault-pass \
    --tags helmfile-remote,kubeconfig,netbox -e '{"helmfile_remote_extra_args": "-l name=cloud-mate"}'

Строка с тегами --tags helmfile-remote,kubeconfig -e '{"helmfile_remote_extra_args": "-l name=cloud-mate"}' необходима, чтобы запустить обновление только компонента Cloud Mate.

Команда без тега запустит проверку всех этапов установки, что замедлит процесс обновления.

Параметры команды:

-v /$HOME/portal-box:/apps — маппинг директории в которой находится разархивированный архив. Cлева указан путь до директории на manager хосте, справа указан путь до директории в образе docker - неизменяемый, разделителем является ':')
-v ~/.ssh/id_rsa:/root/.ssh/id_rsa — маппинг файла с закрытым ключом.
-v ~/.kube/cloudlink:/root/.kube/cloudlink — маппинг файл, в котором после будет находится kubeconfig для подключения к кластеру.
deploy-manager:1.9.1 — название docker-образа.
-i inventories/box/hosts — путь до файла inventory.
-u $USER — пользователь, с помощью которого будет производиться подключение на удаленный хост.
deploy.yml — файл, находящийся в portal-box директории.

После запуска docker-контейнера, введите пароль для установки:

Vault password:

Пароль находится в репозитории с дистрибутивом в файле с расширением txt.

9. Настройка структуры организации

Перейдите пользовательский Портал Cloulink в раздел меню Управление доступом → Организация.
Нажмите на ⋮ напротив организации или папки.
Нажмите Создать папку или Создать проект.
Введите данные:
1. Для новой папки:
  - Название — введите название папки.
  - Информационные системы — нажмите на поле и выберите одну систему или более.
  - При необходимости активируйте опцию Создать собственный счет
  - Нажмите Создать.
2. Для нового проекта:
  - Название — введите название проекта.
  - Информационные системы — выберите информационную систему.
  - Из списка выберите нужную Среду.
  - Нажмите Создать

Созданная папка/проект отобразится в Организационной структуре.

10. Настройка сети в сервисе NetBox

Чтобы виртуальные машины стали доступны для заказов, настройте сеть в сервисе NetBox, расположенном по адресу netbox.sample.box.

Для входа в NetBox используйте авторизацию через Keycloak, нажмите кнопку Keycloak на странице входа.

10.1. Создать площадку (дата-центр)

Перейдите в раздел Организация → Площадки.
Нажмите + Добавить и заполните поля:
- Имя — название площадки, которое должно совпадать с кодом дата-центра.
- Подстрока — совпадает с кодом дата-центра.
Нажмите Создать.

10.2. Создать сегмент сети

Перейдите в раздел IPAM → VLAN-ы.
Нажмите + Добавить и заполните поля:
- VLAN ID — укажите произвольное значение.
- Имя — название VLAN должно совпадать с кодом сегмента сети.
- В блоке Задание выберите вкладку Площадка:
  - Площадка — выберите из списка созданную ранее площадку (дата-центр).
- В блоке Настраиваемые поля в поле Custom virt subnet uuid укажите идентификатор профиля vNIC.

Нажмите Создать.

Получение идентификатора профиля vNIC:

Для zVirt:

На портале администрирования zVirt перейдите в раздел меню Сеть → Профили vNIC и скопируйте ID.
Для vSphere:

В интерфейсе vSphere Client перейдите на вкладку Networks и нажмите на название нужной группы портов (PortGroup). после этого в строке URL скопируйте uuid PortGroup (общий вид uuid — dvportgroup-1111).

Пример создания VLAN для Zvirt

VLAN ID = 2302
# Имя ресурса vNIC Profile
Имя = test_vlan2302
Статус = Активный
Арендатор = BOX
Площадка = Test-site
# Идентификатор vNIC Profile, который можно получить запросом к api (значение "id" нужной сети)
Custom virt subnet uuid = 00000000a-000a-000a-00000000398

Пример создания VLAN для vSphere

ID = 1
# Имя ресурса DistributedVirtualPortgroup
Name = DPortGroup
Status = Active
Tenant = BOX
Site = COD-A
# Идентификатор ресурса DistributedVirtualPortgroup, например:
# urn:urn:vmomi:DistributedVirtualPortgroup:dvportgroup-3027:a6ba13a8-a1a8-4e9f-963a-7418f86ff77c/summary
Custom virt subnet uuid = dvportgroup-3027

10.3. Создать таблицу маршрутизации

Перейдите в раздел IPAM → VRFs.
Нажмите + Добавить и заполните поля:
- Имя — совпадает с кодом сегмента сети.
- RD — совпадает с кодом сегмента сети.
Нажмите Создать.

10.4. Создать подсеть

Перейдите в раздел IPAM → Префиксы.
Нажмите + Добавить и заполните поля:
- Префикс — укажите префикс виртуальной подсети.
- VRF — выберите имя созданного ранее домена маршрутизации.
- Tags — выберите теги платформы виртуализации (например, zvirt), тег cloud, а также идентификатор кластера, которому будет доступна созданная подсеть.
- В блоке Область применения:
  - Тип прицела — выберите DCIM > Площадка.
  - Площадка — выберите имя ранее созданной площадки (дата-центра).
- VLAN — выберите созданную ранее виртуальную локальную сеть.
- Default gw — укажите IP-адрес шлюза по умолчанию для виртуальных машин. Например, 10.248.7.254.
- Nameservers — укажите DNS-серверы для подсети в формате JSON.
Нажмите Создать.

10.5. Создать диапазон запрещенных IP-адресов

При необходимости можно исключить отдельные IP-адреса из выдачи, создав диапазон IP-адресов (IP Range). Таким образом исключается IP-адрес шлюза, так как он используется как шлюз по умолчанию (default gateway) и не должен выдаваться виртуальным машинам. Его исключение предотвращает IP-конфликты и проблемы с маршрутизацией в подсети.

Чтобы запретить выдачу IP-адреса шлюза:

Перейдите в раздел IPAM → IP-адреса.
Нажмите + Добавить и заполните поля:
- Адрес — укажите IP-адрес шлюза с маской (сокращённый вид маски /24), который вы ранее указали в поле Default gw при создании префикса. Например, 10.248.7.254/24.
- Статус — установите значение Зарезервировано.
- VRF — выберите ранее созданный домен маршрутизации (VRF).
Нажмите Создать.

Чтобы создать диапазон запрещенных IP-адресов:

Перейдите в раздел IPAM → Диапазоны IP-адресов.

Нажмите + Добавить и заполните поля:

VRF — выберите ранее созданный домен маршрутизации (VRF), к которому будет относиться диапазон.
Начальный адрес — укажите начальный IP-адрес диапазона с маской (сокращённый вид маски /24). Например, 10.248.7.1/24.
Конечный адрес — укажите конечный IP-адрес диапазона (с маской). Например, 10.248.7.99

В примере задан диапазон адресов с 1 по 99, поэтому первым доступным адресом для выдачи станет 10.248.7.100/24.
Статус — установите значение Зарезервировано.
Активируйте опцию Отметка заполнена (Mark populated), чтобы запретить создание IP-адресов внутри данного диапазона.

Активируйте опцию Использованная марка (Mark utilized), чтобы отметить диапазон IP-адресов как полностью занятый.

Обязательно активируйте опцию Использованная марка (Mark utilized), иначе диапазон будет считаться доступным и его IP-адреса, включая адрес шлюза, могут быть назначены виртуальным машинам.

Нажмите Создать.