OpenStack CLI

Последнее изменение: 02 октября 2024

OpenStack CLI

OpenStack CLI — это консольный клиент для работы с OpenStack API. Через OpenStack CLI в Selectel можно управлять облачной инфраструктурой: серверами, группами размещения, сетевыми дисками, сетями, образами и балансировщиками нагрузки.

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

Актуальные версии компонентов, которые поддерживаются в Selectel, можно посмотреть в таблице Версии компонентов OpenStack.

OpenStack CLI можно установить в локальной системе.

1. Установите OpenStack CLI и дополнительные пакеты. Если для работы с OpenStack CLI вы хотите использовать Docker-контейнер, этот шаг выполнять не нужно.
2. Создайте сервисного пользователя для авторизации в OpenStack API.
3. Настройте авторизацию в OpenStack API.

Версии компонентов OpenStack⁠

	Версия релиза	Версия API
Keystone	Zed	3.14
Placement	Zed	1.0 (максимальная микроверсия — 1.39)
Nova	Zed	2.1 (максимальная микроверсия — 2.93)
Neutron	Ussuri	2.0
Cinder	Wallaby	3.0 (максимальная микроверсия — 3.64)
Glance	Zed	2.16
Karbor	Wallaby	1.0
Manila	Zed	2.0 (максимальная микроверсия — 2.75)
Heat	Zed	1.0
Octavia	2023.1	2.26
Gnocchi	4.5	1.0

Установить OpenStack CLI⁠

Ubuntu, Debian

1. Откройте CLI.

2. Установите Python 3:

   sudo apt update
   sudo apt install python3

3. Установите pip3:

   sudo apt install python3-pip

4. Установите OpenStack CLI:

   pip3 install python-openstackclient

5. Проверьте, что OpenStack CLI установлен:

   openstack --version

   В ответе появится номер версии.

6. Опционально: установите компонент Octavia для работы с облачными балансировщиками нагрузки — для совместимости с версией релиза Yoga требуется версия 3.4.0:

   pip3 install python-octaviaclient===3.4.0

7. Опционально: установите компонент Glance для работы с образами:

   pip3 install python-glanceclient

CentOS

1. Откройте CLI.

2. Установите Python 3:

   sudo dnf update -y
   sudo dnf install python3 -y

3. Установите pip3:

   sudo dnf install python3-pip -y

4. Установите OpenStack CLI:

   pip3 install python-openstackclient

5. Проверьте, что OpenStack CLI установлен:

   openstack --version

   В ответе появится номер версии.

6. Опционально: установите компонент Octavia для работы с облачными балансировщиками нагрузки — для совместимости с версией релиза Yoga требуется версия 3.4.0:

   pip3 install python-octaviaclient===3.4.0

7. Опционально: установите компонент Glance для работы с образами:

   pip3 install python-glanceclient

macOS

1. Откройте CLI.

2. Установите Python 3 и pip3:

   brew install python3

3. Установите OpenStack CLI:

   brew install openstackclient

4. Проверьте, что OpenStack CLI установлен:

   openstack --version

   В ответе появится номер версии.

5. Опционально: установите компонент Octavia для работы с облачными балансировщиками нагрузки — для совместимости с версией релиза Yoga требуется версия 3.4.0:

   pip3 install python-octaviaclient===3.4.0

6. Опционально: установите компонент Glance для работы с образами:

   pip3 install python-glanceclient

Windows

1. Загрузите и установите Python, например, версию Python 3.12.0. При запуске установки отметьте чекбокс Add python.exe to PATH.

2. Загрузите и установите Microsoft C++ Build Tools. При запуске установки в разделе Workloads в блоке Desktop & Mobile отметьте чекбокс Desktop development with C++.

3. Откройте cmd.

4. Установите OpenStack CLI:

   pip3 install python-openstackclient

5. Проверьте, что OpenStack CLI установлен:

   openstack --version

   В ответе появится номер версии.

6. Опционально: установите компонент Octavia для работы с облачными балансировщиками нагрузки — для совместимости с версией релиза Yoga требуется версия 3.4.0:

   pip3 install python-octaviaclient===3.4.0

7. Опционально: установите компонент Glance для работы с образами:

   pip3 install python-glanceclient

Создать сервисного пользователя⁠

Для авторизации в OpenStack API нужно создать сервисного пользователя с ролью Администратор проекта или Наблюдатель проекта и добавить его в проект.

1. В панели управления перейдите в раздел Управление доступом → Управление пользователями.

2. Нажмите Добавить пользователя.

3. Выберите тип Сервисный пользователь.

4. Введите имя пользователя. Оно будет использоваться при авторизации.

5. Введите пароль для пользователя или сгенерируйте его.

6. Сохраните пароль — после создания пользователя посмотреть пароль нельзя, только изменить.

7. Выберите роль пользователя:

   • Администратор проекта — может создавать, редактировать и удалять ресурсы проекта;
   • Наблюдатель проекта — может просматривать ресурсы проекта.

8. Отметьте проекты, в которые нужно добавить пользователя.

9. Нажмите Добавить пользователя.

Настроить авторизацию⁠

Для авторизации в OpenStack API нужно добавить переменные окружения. В Unix-системах (Ubuntu, Debian, CentOS и macOS) для этого нужно запустить скрипт из RС-файла, который можно скачать в панели управления, в Windows — добавить переменные вручную.

осторожно

Авторизацию в OpenStack API можно настроить только для одного сервисного пользователя, проекта и пула. При необходимости можно изменить данные для авторизации.

Ubuntu, Debian, CentOS, macOS

1. В панели управления перейдите в раздел Облачная платформа → Доступ.

2. Откройте вкладку Внешний доступ.

3. Выберите созданного сервисного пользователя с ролью Администратор проекта или Наблюдатель проекта.

4. Выберите пул. Управлять инфраструктурой проекта можно будет только в этом пуле.

5. Нажмите Скачать.

6. В локальной системе перейдите в директорию со скачанным RC-файлом:

   cd <directory_name>

   Укажите <directory_name> — имя директории с RC-файлом.

7. Запустите скрипт из RC-файла:

   source <file_name.sh>

   Укажите <file_name.sh> — имя RC-файла, по умолчанию rc.sh.

8. Введите пароль OpenStack — пароль сервисного пользователя, для которого создан RC-файл.

9. Проверьте работу OpenStack CLI, например, откройте список облачных серверов:

   openstack server list

   Если в пуле и проекте, которые указаны в RC-файле, созданы облачные серверы, то в выводе команды появится их список. Если серверы пока не созданы, в выводе команды будет пустая строка.

Windows

1. Откройте cmd или PowerShell.

2. Добавьте переменные окружения:

   <set> OS_AUTH_URL=https://cloud.api.selcloud.ru/identity/v3
   set OS_IDENTITY_API_VERSION=3
   set OS_VOLUME_API_VERSION=3
   set CLIFF_FIT_WIDTH=1
   set OS_PROJECT_DOMAIN_NAME=<account_id>
   set OS_PROJECT_ID=<project_id>
   set OS_TENANT_ID=<project_id>
   set OS_TENANT_NAME=<project_name>
   set OS_REGION_NAME=<pool>
   set OS_USER_DOMAIN_NAME=<account_id>
   set OS_USERNAME=<user_name>
   set OS_PASSWORD=<user_password>

   Укажите:

   • <set> — команда для добавления переменных окружения. Если вы работаете в cmd, используйте команду set, если в PowerShell — env;
   • OS_AUTH_URL — адрес (URL) зависит от региона и пула, можно посмотреть в списке URL;
   • <account_id> — номер аккаунта панели управления. Можно посмотреть в панели управления в правом верхнем углу;
   • <project_id> — ID проекта. В панели управления перейдите в раздел Облачная платформа → откройте меню проектов (название текущего проекта) → в строке нужного проекта нажмите ;
   • <project_name> — имя проекта. Можно посмотреть в панели управления в разделе Облачная платформа → меню проектов;
   • <pool> — пул, например ru-2. Управлять инфраструктурой проекта можно будет только в этом пуле;
   • <user_name> — имя созданного сервисного пользователя с ролью Администратор проекта или Наблюдатель проекта.;
   • <user_password> — пароль сервисного пользователя.

3. Проверьте работу OpenStack CLI, например, откройте список облачных серверов:

   openstack server list

   Если в пуле и проекте, которые указаны в RC-файле, созданы облачные серверы, то в выводе команды появится их список. Если серверы пока не созданы, в выводе команды будет пустая строка.

Docker

Для работы с OpenStack CLI можно использовать Docker-контейнер.

1. В панели управления перейдите в раздел Облачная платформа → Доступ.

2. Откройте вкладку Внешний доступ.

3. Выберите созданного сервисного пользователя с ролью Администратор проекта или Наблюдатель проекта.

4. Выберите пул. Управлять инфраструктурой проекта можно будет только в этом пуле.

5. Нажмите Скачать.

6. В локальной системе установите Docker. Подробнее в инструкции Установить Docker в документации Docker.

7. Откройте CLI.

8. Создайте директорию для работы с Docker:

   mkdir <docker_directory>

   Укажите <docker_directory> — имя директории, в которой будет создан Dockerfile.

9. Переместите RC-файл, который вы скачали на шаге 5, в директорию с Dockerfile.

10. Создайте в этой директории пустой файл для Dockerfile:

    nano <dockerfile_name>

    Укажите <dockerfile_name> — имя Dockerfile.

11. Добавьте в Dockerfile команды для установки OpenStack CLI:

    FROM alpine:3.17
    
    RUN apk add --update --no-cache python3 python3-dev libffi libffi-dev \
        git openssl openssl-dev cargo build-base iputils curl linux-headers \
        py3-pip py3-cffi py3-tz py3-pbr py3-setuptools && \
        pip3 install -UI git+https://github.com/openstack/python-openstackclient.git@stable/2023.1 \
                        git+https://github.com/openstack/python-glanceclient.git@stable/2023.1 \
                        git+https://github.com/openstack/python-octaviaclient.git@stable/2023.1 \
        && apk del build-base linux-headers python3-dev libffi-dev openssl-dev git cargo iputils curl && rm -rf /var/cache
    
    CMD ["sh"]

12. Соберите Docker-контейнер:

    docker build -t osc:antelope .

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

    docker run -ti --rm -v $(pwd):/workspace osc:antelope

14. Перейдите в директорию workspace:

    cd workspace

15. Запустите скрипт из RC-файла:

    source <file_name.sh>

    Укажите <file_name.sh> — имя RC-файла, который вы переместили в директорию с Dockerfile на шаге 9.

16. Проверьте работу OpenStack CLI, например, откройте список облачных серверов:

    openstack server list

    Если в пуле и проекте, которые указаны в RC-файле, созданы облачные серверы, то в выводе команды появится их список. Если серверы пока не созданы, в выводе команды будет пустая строка.

Изменить данные для авторизации⁠

Чтобы изменить данные для авторизации:

• задайте новые значения переменных окружения. Для Ubuntu, Debian, CentOS и macOS — измените переменные в RC-файле; для Windows — задайте значения напрямую;
• передайте новые значения в командах OpenStack CLI ключами. Например, для изменения пула используйте ключ --os-region-name. Список всех опций и примеры можно посмотреть в разделе Options документации OpenStack.