Основные интерфейсы

Для работы с Платформой используются следующие типы интерфейсов:

• Графические интерфейсы (GUI).
• Командные строки (CLI).
• Программные интерфейсы (API).

В данном разделе будут рассмотрены основные интерфейсы, доступные для взаимодействия со стороны пользователей и администраторов Платформы.

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

Условное обозначение: VK CP UI (или MCS UI, устаревшее).

Доступ к Порталу самообслуживания Платформы осуществляется при помощи веб-браузера по следующему адресу:

 
vkc.your_domain_name.ru

, где your_domain_name.ru — это доменное имя Заказчика Платформы.

Для входа в Портал самообслуживания используется любая персональная учётная запись пользователя Платформы.

Портал администратора является основным графическим интерфейсом администраторов Платформы и используется для управления основными настройками и административными функциями Платформы, а также ролями групп пользователей в проектах.

Вместо Портала администратора возможно использовать OpenStack CLI.

Доступ к Порталу администратора Платформы осуществляется при помощи веб-браузера по следующему адресу:

 
admin.your_domain_name.ru

, где your_domain_name.ru — это доменное имя Заказчика Платформы.

Для входа в Портал администратора используется учётная запись Платформы, для которой был выставлены роли с префиксом sa_. При настроенной интеграции с Active Directory (AD) может быть использована учётная запись из AD. Выдачу ролей для пользователей из AD можно автоматизировать штатными средствами Keycloak.

Портал мониторинга является основным графическим интерфейсом для мониторинга Платформы.

Условное обозначение: Zabbix.

Доступ к Порталу мониторинга Платформы осуществляется при помощи веб-браузера по следующему адресу:

 
monitoring.your_domain_name.ru

, где your_domain_name.ru — это доменное имя Заказчика Платформы.

В случае наличия интеграции с AD для входа в Портал мониторинга используется учётная запись Администратора Платформы из AD. В противном случае используется отдельная учётная запись администратора Zabbix.

Портал логирования является основным графическим интерфейсом для просмотра журналов событий Платформы.

Условное обозначение: OpenSearch.

Доступ к Порталу логирования Платформы осуществляется при помощи веб-браузера по следующему адресу:

 
logs.your_domain_name.ru

, где your_domain_name.ru — это доменное имя Заказчика Платформы.

В случае наличия интеграции с AD для входа в Портал логирования может использоваться учётная запись Администратора Платформы из AD. В противном случае используется отдельная учётная запись администратора для доступа к Порталу логирования.

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

Условное обозначение: Keycloak.

Стандартные учетные записи Платформы создаются, удаляются и настраиваются именно через этот интерфейс (либо через API Keycloak). Кроме того, через данный интерфейс могут настраиваться различные аспекты доступа к Платформе, например, интеграция Платформы с AD в части учётных записей пользователей.

Доступ к Порталу управления доступом Платформы осуществляется при помощи веб-браузера по следующему адресу:

 
idm.your_domain_name.ru

, где your_domain_name.ru — это доменное имя Заказчика Платформы.

Для входа в Портал управления доступом используется стандартная учётная запись Платформы, имеющая соответствующие права доступа.

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

Для администрирования Платформы может потребоваться использование следующих интерфейсов командной строки:

• SSH и Bash (выполнение команд после подключения к узлам Платформы).
• OpenStack CLI.
• Ansible.
• cURL.

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

Базовый синтаксис для подключения к узлу Платформы (см. раздел Вход на деплой-ноду по SSH):

 
ssh <ИМЯ_ПОЛЬЗОВАТЕЛЯ><IP_ХОСТА>

Описание параметров можно найти в документации на ОС, в которой будет использоваться SSH (см. пример для Ubuntu).

Интерфейс командной строки для API-интерфейсов OpenStack.

По умолчанию OpenStack CLI развёрнут на узлах Платформы и не требует дополнительной настройки. При использовании локального OpenStack CLI может понадобиться установка зависимостей, см. раздел ПО для подключения к OpenStack CLI.

Базовый синтаксис см. в Справочник команд OpenStack.

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

Базовый синтаксис см. в официальной документации.

Инструмент командной строки, часто используемый для отправки HTTP-запросов. Поддерживает большое количество протоколов, в том числе HTTP-запросов к RESTful API.

 
curl [options / URLs]

Описание параметров см. в официальной документации.

Пример использования см. в разделе Использование REST API для управления Платформой.

Инструмент командной строки для управления Docker-контейнерами.

 
docker [options] <COMMAND> [<ARGUMENTS>]

Описание параметров см. в официальной документации.

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

 
kubectl [command] [<TYPE>] [<NAME>] [flags]

Описание параметров см. в официальной документации.