The OpenStack Command Line Interface (CLI) allows you to manage your Shadow GPU PaaS resources directly from your terminal. This guide explains how to install and configure the OpenStack client.

Prerequisites

  • Python 3.8 or later installed on your system.
  • Access to the Shadow GPU PaaS dashboard.

1. Install the OpenStack Client

We recommend installing the OpenStack client in a virtual environment to avoid conflicts with other Python packages.

# Create a virtual environment
python3 -m venv openstack-cli

# Activate the virtual environment
source openstack-cli/bin/activate

# Install the OpenStack client
pip install python-openstackclient

2. Download clouds.yaml

The clouds.yaml file contains the necessary credentials and endpoints to connect to your Shadow OpenStack project.

  1. Log in to the Shadow GPU PaaS Dashboard.
  2. On the top right of the screen, click on the User Menu (indicated by the 👤 logo).
  3. Click on Get clouds.yaml file and select Password Type to login with your password.
  4. Save the file to ~/.config/openstack/clouds.yaml or the current directory.
  5. Replace “YOUR_PASSWORD_HERE” with your actual password.

[NOTE] For more details on accessing the dashboard, refer to the Skyline Dashboard Overview.

3. Configure the Environment

Once you have the clouds.yaml file, you need to set the OS_CLOUD environment variable The value of this variable is the name of the cloud defined in your clouds.yaml file (usually openstack).

export OS_CLOUD=<your-cloud-name>

4. Verify Access

Run a simple command to verify that you can access your project resources:

openstack image list

If the command returns a list of available images, your CLI is correctly configured.

Next Steps

Now that your CLI is configured, you can start managing your resources: