Предварительная настройка сервера управления

  1. Проверить на управляющем сервере или лидере кластера, что он доступен по протоколу XML-RPC командой:

    sudo cat /etc/one/one.d/base.conf | grep -E "LISTEN_ADDRESS|PORT = "
    Пример вывода после выполнения команды: 

    # LISTEN_ADDRESS: Host IP to listen on for xmlrpc calls (default: all IPs).
PORT = 2633
LISTEN_ADDRESS = "0.0.0.0"
    CODE
  2. В веб-интерфейсе ПК СВ в меню слева выбрать пункт меню Настройки.
  3. На открывшейся странице Настройки во вкладке Аутентификация нажать кнопку Управление токенами входа.
  4. На открывшейся странице Токен входа необходимо:
    • в поле Истечение в секундах задать значение срока действия токена. Если необходимо получить бессрочный токен, то нужно указать значение -1 (допустимо только для административных групп ПК СВ);
    • в выпадающем списке Группа выбрать необходимую группу пользователей;
    • нажать на кнопку Получить новый токен.
  5. На странице Токен входа появится новый добавленный токен. 

Работа с интерфейсом командной строки на клиентской машине

  1. В конфигурационный файл /etc/apt/sources.list добавить сетевой или локальный репозиторий ПК СВ "Брест".

  2. Установить необходимые пакеты командой:

    sudo apt install -y opennebula-tools

  3. В терминале запустить выполнение команд от пользователя, от имени которого планируется выполнять удаленные команды в ПК СВ.

    При входе в ОС под именем пользователя, от которого планируется выполнение команд в ПК СВ, этот шаг следует пропустить.

    Для этого использовать команду:

    su - <имя_пользователя>
    где <имя_пользователя> — имя пользователя, от имени которого планируется выполнять удаленные команды в ПК СВ.

  4. Ввести команду вида:

    <команда> --endpoint <идентификатор_сервера>/RPC2 --user <имя_пользователя> --password <токен>
    где 

    • <команда> — обозначение команды, которую необходимо выполнить;
    • <идентификатор_сервера> — адрес сервера управления или лидера кластера (состоит из IP-адреса или доменного имени и порта, использующегося для прослушивания XML-RPC запросов на этом сервере);
    • <имя_пользователя> — имя пользователя для подключения и исполнения команды;
    • <токен> — токен назначенный пользователю.

Пример вида команды при использовании незащищенного соединения http://:

onehost list --endpoint http://192.168.70.172:2633/RPC2 --user brestadmin --password c1ed52ce40359fd622947667f3d5c1120d450e569cb60fd14d0915eea349c32a

Переменные окружения

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

Для того, чтобы задать значение переменной необходимо воспользоваться командой:

<имя_переменной>="<значение_переменной>"

Для просмотра значения переменной необходимо воспользоваться командой:

export <имя_переменной>

  • ONE_XMLRPC — URL-адрес прослушивая XML-RPC запросов. По умолчанию установлен http://<идентификатор_сервера>:2633/RPC2;
  • ONE_XMLRPC_TIMEOUT — время ожидания выполнения XML-RPC запроса (в секундах);
  • ONE_ZMQ — URL-адрес прослушивания очереди сообщений (ZeroMQ). По умолчанию установлен адрес tcp://<идентификатор_сервера>:2101;

  • ONE_AUTH — файл, содержащий ключ аутентификации. Если переменная не задана, то по умолчанию будет использоваться файл /.one/one_auth. Содержание аутентификационного файла должно иметь вид:

    <имя_пользователя>:<токен>
    CODE

    где

    • <имя_пользователя> — имя пользователя для подключения и исполнения команды;

    • <токен> — токен назначенный пользователю.
      Пример вида файла:

      brestadmin:c1ed52ce40359fd622947667f3d5c1120d450e569cb60fd14d0915eea349c32a
      CODE

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

      При использовании незащищенного соединения http://:

      onehost list --endpoint http://192.168.70.172:2633/RPC2

  • ONE_POOL_PAGE_SIZE — число результатов в ответе API ПК СВ на странице. API ПК СВ поддерживает постраничное отображение результатов запросов (пагинацию). По умолчанию установлено значение 300 результатов на страницу. Для отключения можно установить нечисловое значение (например disable);

  • ONE_PAGER —определяет способ постраничного отображения вывода команд при работе в интерактивной сессии оболочки. По умолчанию используется утилита отображения текста less. При необходимости пользователь может назначить другую утилиту отображения текста.

    Для отключения постраничного отображения необходимо установить значение переменной --no-pager. Этот параметр установит в значение переменной ONE_PAGER команду cat.

  • ONE_LISTCONF — параметр определяющий вид макета отображения выводов команд. Позволяет пользователю использовать альтернативный макет для отображения выводов. Макеты определены в /etc/one/cli/onevm.yaml;

    Пример стандартного макета при использовании команды onevm list:

        ID USER     GROUP    NAME            STAT UCPU    UMEM HOST             TIME
    20 oneadmin oneadmin tty-20          fail    0      0K localhost    0d 00h32
    21 oneadmin oneadmin tty-21          fail    0      0K localhost    0d 00h23
    22 oneadmin oneadmin tty-22          runn  0.0  104.7M localhost    0d 00h22
    CODE

    Пример пользовательского макета при использовании команды onevm list:

        ID NAME            IP              STAT UCPU    UMEM HOST             TIME
    20 tty-20          10.3.4.20       fail    0      0K localhost    0d 00h32
    21 tty-21          10.3.4.21       fail    0      0K localhost    0d 00h23
    22 tty-22          10.3.4.22       runn  0.0  104.7M localhost    0d 00h23
    CODE

  • ONE_CERT_DIR — дополнительный каталог доверенных сертификатов;

    Перед добавлением сертификата необходимо привести его обозначение к виду <хэш_сумма>.0.

    Для того, чтобы узнать хэш сумму сертификата можно воспользоваться командой: 

    openssl x509 -in <обозначение_сертификата> -hash

  • ONE_DISABLE_SSL_VERIFY — перемененная, которая позволяет отключить проверку SSL-сертификатов, для этого необходимо указать в ней любое значение;

    Не рекомендуется использовать переменную ONE_DISABLE_SSL_VERIFY на объектах эксплуатации.

  • ONE_SUNSTONE — URL-адрес, используемый для загрузки приложений. Если эта переменная не определена, то она будет выведена из значения переменной ONE_XMLRPC (путем изменения порта XML-RPC на порт 9869). В случае, если переменная ONE_XMLRPC не определена, то будет использовано значение по умолчанию — http://<идентификатор_сервера>:9869;
  • ONEFLOW_URL — URL-адрес службы OneFlow. Если переменная не определена, то по умолчанию будет использоваться значение http://<идентификатор_сервера>:2474;
  • ONEFLOW_USER — имя пользователя службы OneFlow, если переменная не задана, то будет использоваться имя пользователя из аутентификационного файла, определенного в переменной ONE_AUTH;
  • ONEFLOW_PASSWORD — пароль пользователя службы OneFlow, если переменная не задана, то будет использоваться пароль пользователя из аутентификационного файла, определенного в переменной ONE_AUTH.