OpenStack CLI

Last update: April 04 2024

OpenStack CLI

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

Product documentation via the OpenStack CLI can be found under the OpenStack tab in instructions such as Create cloud server or Connect disk.

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

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 to authorize to the OpenStack API.
3. Configure OpenStack API authorization.

OpenStack component versions⁠

	Release version	API version
Keystone	Zed	3.14
Nova	Zed	2.1 (maximum microversion is 2.93)
Neutron	Ussuri	2.0
Cinder	Wallaby	3.0 (maximum microversion is 3.64)
Glance	Wallaby	2.12
Karbor	Wallaby	1.0
Heat	Zed	1.0
Octavia	Yoga	2.25
Gnocchi	4.5	1.0

Install OpenStack CLI⁠

Ubuntu, Debian

1. Open the CLI.

2. Install the OpenStack CLI:

   sudo apt update
   sudo apt install python3-openstackclient

3. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

4. Optional: Install additional packages for OpenStack components:

   apt install python3-<compoment>client

   Specify <compoment> is the name of the component:

   • octavia — to work with load balancers;
   • glance is for working with images.

CentOS

1. Open the CLI.

2. Install pip for Python3:

   sudo yum update
   sudo yum install python3-pip

3. Install the OpenStack CLI:

   pip3 install python-openstackclient

4. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

5. Optional: Install additional packages for OpenStack components:

   apt install python3-<compoment>client

   Specify <compoment> is the name of the component:

   • octavia — to work with load balancers;
   • glance is for working with images.

macOS

1. Open the CLI.

2. Install Python3:

   brew install python

3. Install the OpenStack CLI:

   pip3 install python-openstackclient

4. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

5. Optional: Install additional packages for OpenStack components:

   apt install python3-<compoment>client

   Specify <compoment> is the name of the component:

   • octavia — to work with load balancers;
   • glance is for working with images.

Windows

1. Download and install Python, such as version Python 3.12.0. When running the installation, check the Add python.exe to PATH checkbox.

2. Download and install Microsoft C++ Build Tools. When starting the installation, under Workloads in the Desktop & Mobile block, check the Desktop development with C++ checkbox.

3. Open cmd.

4. Install the OpenStack CLI:

   pip install -U buildtools
   pip install python-openstackclient

5. Verify that the OpenStack CLI is installed:

   openstack --version

   The version number will appear in the response.

6. Optional: Install additional packages for OpenStack components:

   pip install python-<compoment>client

   Specify <compoment> is the name of the component:

   • octavia — to work with load balancers;
   • glance is for working with images.

Create a service user⁠

To authorize in the OpenStack API, you need to create a service user with the role Project Administrator or Project Viewer and add it to cloud platform project.

1. From the control panel in the upper right corner, open the menu (account number) and select Profile & Settings.

2. Go to User Management.

3. Click Add User.

4. Select the Service User type.

5. Enter a username. It will be used during authorization.

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

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

8. Select user role:

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

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

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

Authorization in the OpenStack API can only be configured for a single service user, cloud platform project, and pool. If necessary, you can change the authorization data.

Ubuntu, Debian, CentOS, macOS

1. In Control Panel, go to Cloud Platform → Access.

2. Open the External Access tab.

3. Select created service user with the role of Project Administrator or Project Supervisor.

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

5. Click Download.

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

   cd <directory_name>

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

7. Run the script from the RC file:

   source <file_name.sh>

   Specify <file_name.sh> is the name of the RC file, the default is rc.sh.

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

9. Check the OpenStack CLI operation, for example, open the list of cloud servers:

   openstack server list

   If cloud servers have been created in the pool and project that are specified in the RC file, a list of them will appear in the command output. If no servers have been created yet, the output of the command will be an empty string.

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 set command, if in PowerShell use env;
   • OS_AUTH_URL — the address (URL) is region and pool dependent, can be viewed in the URL list;
   • <account_id> — control panel account number. You can look in control panel in the upper right corner;
   • <project_id> — cloud platform project ID. In Control Panel, go to Cloud Platform → open the projects menu (name of the current project) → in the row of the desired project, click ;
   • <project_name> is the name of the cloud platform project. Can be viewed in dashboard under Cloud Platform → projects menu;
   • <pool> — pool, such as ru-2. Only this pool will be able to manage the infrastructure of the project;
   • <user_name> is the name of the created service user with the Project Administrator or Project Watcher role;
   • <user_password> — service user password.

3. Test the OpenStack CLI, for example, by opening the list of cloud servers:

   openstack server list

   If cloud servers have been created in the pool and project that are specified in the RC file, a list of them will appear in the command output. If no servers have been created yet, the output of the command will be an empty string.

Docker

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

1. In Control Panel, go to Cloud Platform → Access.

2. Open the External Access tab.

3. Select created service user with the role of Project Administrator or Project Supervisor.

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

5. Click Download.

6. On the local system, install Docker. For more information, see the Install Docker instructions in the Docker documentation.

7. Open the CLI.

8. Create a directory to work with Docker:

   mkdir <docker_directory>

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

9. Move the RC file you downloaded in step 5 to the directory with the Dockerfile.

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

    nano <dockerfile_name>

    Specify <dockerfile_name> as the name of the Dockerfile.

11. 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"]

12. Build a Docker container:

    docker build -t osc:antelope .

13. Start the Docker container:

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

14. Navigate to the workspace directory:

    cd workspace

15. Run the script from the RC file:

    source <file_name.sh>

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

16. Test the OpenStack CLI, for example, by opening the list of cloud servers:

    openstack server list

    If cloud servers have been created in the pool and project that are specified in the RC file, a list of them will appear in the command output. If no servers have been created yet, the output of the command will be an empty string.

Change authorization data⁠

To change the authorization details:

• set new values for the 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, use the --os-region-name key to change the pool. A list of all options and examples can be found in the Options section of the OpenStack documentation.