Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 3.17 KB

guide.en-ie.md

File metadata and controls

78 lines (49 loc) · 3.17 KB
title excerpt updated
Setting OpenStack environment variables
Find out how to set your environment variables to use the OpenStack API
2024-07-15

Objective

By setting OpenStack environment variables on your desktop, you can use the OpenStack API to manage your infrastructure.

Requirements

Instructions

Step 1: Retrieve the variables

To retrieve your environment variables, you can download the OpenRC file from the OpenStack user account you have created.

Log in to the OVHcloud Control Panel and switch to the Public Cloud{.action} section. Select your Public Cloud project at the top of the left-hand sidebar.

Click on Users & Roles{.action}, then click on the ...{.action} to the right of your user, then select Download OpenStack's RC file{.action}.

openstack-variables{.thumbnail}

An OpenRC file corresponds to a specific user and zone. You cannot manage multiple zones in the same file.

Step 2: Set the variables

On Linux

  • Open a terminal, or connect via the user who will be making the OpenStack API calls.
  • Load the file’s contents in the current environment. You will then be prompted to enter the Horizon user password.
admin@vpsxxxxxx:~$ source openrc.sh
Please enter your OpenStack Password:

As outlined in this guide, the password is only visible once — when it is created.

If you forget your password, you will need to reset it.

If the CLIs are already installed, check if they are working properly:

(env)$ openstack server list
+--------------------------------------+------------+--------+-----------------------------------------------+-----------+--------+
| ID                                   | Name       | Status | Networks                                      | Image     | Flavor |
+--------------------------------------+------------+--------+-----------------------------------------------+-----------+--------+
| 8d7c67c0-38e1-4091-88d5-c14844c1f455 | b2-7-gra11 | ACTIVE | Ext-Net=2001:xxxx:xxx:xxx::xxxx, xx.xxx.xx.xx | Debian 12 | b2-7   |
+--------------------------------------+------------+--------+-----------------------------------------------+-----------+--------+

On Windows

The OpenRC file is not designed to be launched on Windows.

There are two ways of setting environment variables:

  • You will need to adapt the file by changing certain commands. The export part can be replaced with set:
set OS_PASSWORD="Your Horizon user password"
  • You can set the variables directly via the system settings: Control Panel > System > Advanced System Properties > Environment Variables:

public-cloud{.thumbnail}

Go further

To learn how to use OpenStack: OpenStack documentation{.external}

Join our community of users.