OpenStack CLI

Last update: December 16 2024

OpenStack CLI

OpenStack CLI is a console client for working with the OpenStack API. You can manage your cloud infrastructure in Selectel through the OpenStack CLI: servers, placement groups, network volumes, networks, images and load balancers.

Documentation on working with products through the OpenStack CLI can be found on the tab OpenStack In the instructions, for example, Create a cloud server or Attach the volume.

The current versions of the components that are supported in Selectel can be viewed in the table below OpenStack component versions.

The OpenStack CLI can be installed on your local system.

1. Install the OpenStack CLI and additional packages. If you want to use a Docker container to work with the OpenStack CLI, you do not need to perform this step.
2. Create a service user for authorization in the OpenStack API.
3. Configure authorization in the OpenStack API.

OpenStack component versions⁠

	Release version	API version
Keystone	Zed	3.14
Placement	Zed	1.0 (maximum microversion is 1.39)
Nova	Zed	2.1 (maximum microversion is 2.93)
Neutron	Ussuri	2.0
Cinder	Wallaby	3.0 (maximum microversion is 3.64)
Glance	Zed	2.16
Karbor	Wallaby	1.0
Manila	Zed	2.0 (maximum microversion is 2.75)
Heat	Zed	1.0
Octavia	2023.1	2.26
Gnocchi	4.5	1.0

Install the OpenStack CLI⁠

Ubuntu, Debian

1. Open the CLI.

2. Install Python 3:

   sudo apt update
   sudo apt install python3

3. Install pip3:

   sudo apt install python3-pip

4. Install the OpenStack CLI:

   pip3 install python-openstackclient

5. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

6. Optional: install Octavia component to work with cloud load balancers — Yoga release version 3.4.0 is required for compatibility with the Yoga release version:

   pip3 install python-octaviaclient===3.4.0

7. Optional: install the Glance component to work with the images:

   pip3 install python-glanceclient

CentOS

1. Open the CLI.

2. Install Python 3:

   sudo dnf update -y
   sudo dnf install python3 -y

3. Install pip3:

   sudo dnf install python3-pip -y

4. Install the OpenStack CLI:

   pip3 install python-openstackclient

5. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

6. Optional: install Octavia component to work with cloud load balancers — Yoga release version 3.4.0 is required for compatibility with the Yoga release version:

   pip3 install python-octaviaclient===3.4.0

7. Optional: install the Glance component to work with the images:

   pip3 install python-glanceclient

macOS

1. Open the CLI.

2. Install Python 3 and pip3:

   brew install python3

3. Install the OpenStack CLI:

   brew install openstackclient

4. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

5. Optional: Install Octavia component to work with cloud load balancers — Yoga release version 3.4.0 is required for compatibility with the Yoga release version:

   pip3 install python-octaviaclient===3.4.0

6. Optional: install the Glance component to work with the images:

   pip3 install python-glanceclient

Windows

1. Download and install Python, for example, Python 3.12.0. Check the checkbox when starting the installation Add python.exe to PATH.

2. Download and install Microsoft C++ Build Tools. When starting the installation in the Workloads en bloc Desktop & Mobile check the box Desktop development with C++.

3. Open cmd.

4. Install the OpenStack CLI:

   pip3 install python-openstackclient

5. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

6. Optional: Install Octavia component to work with cloud load balancers — Yoga release version 3.4.0 is required for compatibility with the Yoga release version:

   pip3 install python-octaviaclient===3.4.0

7. Optional: install the Glance component to work with the images:

   pip3 install python-glanceclient

Create a service user⁠

To authorize in OpenStack API you need to create service user with the role Project Administrator or Project Supervisor and add it to the project.

1. In the control panel go to Access control → User management.

2. Click Add user.

3. Select type Service user.

4. Enter a user name. This will be used for authorization.

5. Enter a password for the user or generate one.

6. Save password — once a user is created, you cannot view the password, only change it.

7. Select user role:

   • Project administrator — can create, edit, and delete project resources;
   • Project viewer — can view project resources.

8. Check the projects to which you want to add the user.

9. Click Add user.

Set up authorization⁠

To authorize in the OpenStack API, you need to add environment variables. In Unix systems (Ubuntu, Debian, CentOS, and macOS), you need to run a script from an RC file that can be downloaded from the control panel; in Windows, you need to add variables manually.

carefully

Authorization in the OpenStack API can be configured for only one service user, projects and pool. If necessary, you can change the authorization data.

Ubuntu, Debian, CentOS, macOS

1. In the control panel go to Access control → User management.

2. Open the tab Service users.

3. Open the page created service user with the role of Project Administrator or Project Supervisor → tab Access.

4. In the block RC files:

   4.1 Select project.

   4.2 Select region.

   4.3. Select pool. Only this pool will be able to manage the project infrastructure.

   4.4. Press Download.

5. On the local system, navigate to the directory with the downloaded RC file:

   cd <directory_name>

   Specify <directory_name> — name of the directory with the RC file.

6. Run the script from the RC file:

   source <file_name.sh>

   Specify <file_name.sh> — RC file name, default rc.sh.

7. Enter the OpenStack password — the password of the service user for which the RC file was created.

8. Verify the OpenStack CLI is working, for example, by opening the list of cloud servers:

   openstack server list

   If cloud servers have been created in the pool and project specified in the RC file, their list will appear in the command output. If no servers have been created yet, the command output will be empty.

Windows

1. Open cmd or PowerShell.

2. Add environment variables:

   <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>

   Specify:

   • <set> — command to add environment variables. If you are working in cmd, use the command setif PowerShell env;
   • OS_AUTH_URL — address (URL) depends on the region and pool, you can look in the URL list;
   • <account_id> — control panel account number. You can look in control panels in the upper right-hand corner;
   • <project_id> — Project ID. В control panels go to Cloud platform → open the project menu (name of the current project) → in the line of the desired project, click ;
   • <project_name> — project name. You can look in control panels under Cloud platform → project menu;
   • <pool> — pool for example ru-2. Only this pool will be able to manage the project infrastructure;
   • <user_name> — name created service user with the role of project administrator or project monitor;
   • <user_password> — service user password.

3. Verify the OpenStack CLI is working, for example, by opening the list of cloud servers:

   openstack server list

   If cloud servers have been created in the pool and project specified in the RC file, their list will appear in the command output. If no servers have been created yet, the command output will be empty.

Docker

You can use a Docker container to work with the OpenStack CLI.

1. В control panels go to Access control → User management.

2. Open the tab Service users.

3. Open the page created service user with the role of Project Administrator or Project Supervisor → tab Access.

4. In the block RC files:

   4.1 Select project.

   4.2 Select region.

   4.3. Select pool. Only this pool will be able to manage the project infrastructure.

   4.4. Press Download.

5. On your local system, install Docker. More details in the instructions Install Docker in the Docker documentation.

6. Open the CLI.

7. Create a directory to work with Docker:

   mkdir <docker_directory>

   Specify <docker_directory> — name of the directory where the Dockerfile will be created.

8. Move the RC file you downloaded in step 4.4 to the directory with the Dockerfile.

9. Create an empty file for the Dockerfile in this directory:

   nano <dockerfile_name>

   Specify <dockerfile_name> — Dockerfile name.

10. Add commands to the Dockerfile to install the 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"]

11. Build a Docker container:

    docker build -t osc:antelope .

12. Start the Docker container:

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

13. Go to the directory workspace:

    cd workspace

14. Run the script from the RC file:

    source <file_name.sh>

    Specify <file_name.sh> — name of the RC file that you moved to the directory with the Dockerfile in step 9.

15. Verify the OpenStack CLI is working, for example, by opening the list of cloud servers:

    openstack server list

    If cloud servers have been created in the pool and project specified in the RC file, their list will appear in the command output. If no servers have been created yet, the command output will be empty.

Change authorization data⁠

To change the authorization details:

• set new values for environment variables. For Ubuntu, Debian, CentOS and macOS, change the variables in the RC file; for Windows, set the values directly;
• pass the new values in OpenStack CLI commands with keys. For example, to change the pool, use the key --os-region-name. A list of all options and examples can be found in the section Options OpenStack documentation.