Much of the power of Openstack OpenStack is in the suite of application program interfaces (APIs), allowing the same functionality of the dashboard with the advantage of automating much of the provisioning process with only a few commands. Using the API means that all the actions can be  added added to a script that can be called to automatically and repeatedly build instances. You can also create template-like scripts so that with only minor modification to instance name, image and volume size, it is possible to build other instances and volumes quickly and without the need for clicking through the dashboard.

...

Before the tools are installed, you will want an environment that can use Python, as all of the Openstack OpenStack command-line tools are written in that language. This can be your local desktop or it could be a virtual machine in the Rapid Access Cloud. The instructions outlined below will assume a Ubuntu 14.04 instance in the Rapid Access Cloud, a virtual machine running on your desktop or a native Ubuntu desktop.

From an Ubuntu 14.04 command-line:

1. Install Python package management (pip) and required packages: 

   Code Block
   $ sudo apt-get install pythonpython3-pip pythonpython3-dev

   
   

2. Install Openstack command-line tools using pip: 

   Code Block
   $ sudo pippip3 install python-openstackclient

Openrc file

The ‘rc’ in rc file stands for any or all of the following:

• run commands

• resource control

• run control

• runtime configuration

Installing command-line tools (macOS)

1. Ensure you have the Developer Tools (Xcode) with the Command Line Tools for macOS:

   Code Block
   $ sudo xcode-select --install $ sudo pip3 install --upgrade pip

   
   

2. Open the Terminal application.

3. Install the openstack command line tool: 

   Code Block
   $ pip3 install --user python-openstackclient

   Note: We recommend installing this as a user to avoid running into issues with system updates.

4. Add the following to .zshrc:

   Code Block
   export PATH=/Users/<username>/Library/Python/3.8/bin:$PATH export PYTHONPATH=/Users/<username>/Library/Python/3.8/lib/python/site-packages

   
   

Openrc file

The "rc" in rc file stands for any or all of the following:

• run commands

• resource control

• run control

• runtime configuration

Using an rc file to outline your Rapid Access Cloud credentials allows you to pass your credentials to the cloud without needing to include them in your scripts. In fact, the rc file Using an rc file to outline your Rapid Access Cloud credentials allows you to pass your credentials to the cloud without needing to include them in your scripts. In fact, the rc file is a simple bash script that creates environment variables in your shell to be used by the openstack command (the ‘open’ 'open' in openrc). The environment variables, once set, exist only for the current session. If you open another concurrent session on the computer or log-out and back in, you will need to source the openrc file again.

...

1. Log-in to the Rapid Access Cloud dashboard at https://cloud.cybera.ca.

2. In the left-hand panel under “Compute”, click “Access & Security”.

3. Click the “API Access” tab at the top then click the “Download Openstack RC file” file v3” on the right.

4. The file downloaded will be named after your account name, e.g. <email>@<domain>-openrc.sh. This can be renamed to openrc if you like, or you can copy it and modify it so you can have one for the Calgary region and one for the Edmonton region. The rc file downloaded will be keyed for the region you are signed into in the dashboard.

5. Add this line to the downloaded openrc file: 

   Code Block
   export OS_VOLUME_API_VERSION=2

Create openrc

You can use the downloaded rc file as a template or create one from scratch. The OS_USERNAME and OS_TENANTPROJECT_NAME variables are the same; each will be the email address for your Rapid Access Cloud account.

...

Calgary openrc

#!/bin/bash
export OS_REGION_NAME="Calgary"
export OS_AUTH_URL=https://keystone-yyc.cloud.cybera.ca:5000/v2.0v3
export OS_USERNAMEPROJECT_NAME="<account_username>"
export OS_TENANT_NAMEUSERNAME="<account_username>"
echo "Please enter your OpenStack Password: "
read -sr OS_PASSWORD_INPUTexport OS_USER_DOMAIN_NAME="Default"
export OS_REGION_NAME="Calgary"
export OS_PASSWORD=$OS_PASSWORD_INPUT

...

INTERFACE=public
export OS_IDENTITY_API_VERSION=3
echo "Please enter your OpenStack Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT

Edmonton openrc

#!/bin/bash
export OS_AUTH_URL=https://

...

#!/bin/bash
export OS_REGION_NAME="Edmonton"
export OS_AUTH_URL=https://keystone-yeg.cloud.cybera.ca:5000/v2.0v3
export OS_PROJECT_USERNAMENAME="<account_username>"
export OS_TENANT_NAMEUSERNAME="<account_username>"
echo "Please export OS_USER_DOMAIN_NAME="Default"
export OS_REGION_NAME="Edmonton"
export OS_INTERFACE=public
export OS_IDENTITY_API_VERSION=3
echo "Please enter your OpenStack Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT

Sourcing the rc File

Whether you downloaded the RC file or created your own, you will need to "source" into your shell environment:

source /path/to/openrc/file

Using the openstack client

This tutorial will walk through some of the steps outlined in the Basic Guide in building a single instance from scratch, with some notes about alternative functionality that each command offers, to show how flexible using the OpenStack command line client is.

...

• Detach a volume. This is not a destructive action and data on the volume is left intact: 

  Code Block
  $ openstack server remove volume <instance_name> <volume_name>

  
  

Floating IPs

As discussed previously, networking with respect to the assignment of IP addresses in the Rapid Access Cloud is handled automatically during provisioning, with the exception of public IPv4 addresses referred to as floating IPs in OpenStack. There is a single pool that floating IPs are allocated from, named ‘nova’ and by default each project is permitted a single IP from this pool:

• Allocate a floating IP to your project: 

  Code Block
  $ openstack ip floating create nova

• Assign an allocated floating IP to an instance: 

  Code Block
  $ openstack ip floating add <ip_address> <instance_name>

• List IP addresses allocated to project: 

  Code Block
  $ openstack ip floating list

• Remove floating IP from an instance: 

  Code Block
  $ openstack ip floating remove <ip_address> <instance_name>

• Return allocated IP address to pool: 

  Code Block
  $ openstack ip floating delete <ip_address>

Volumes

The root storage for an instance is solely for volatile application data such as kernel operations and applications. Rapid Access Cloud users are provided with a default 500GB of storage that can be used in the form of volumes to be attached to instances and treated no differently by the instance than an internal hard drive would be to a bare-metal server. Attaching volumes to instances is handled by the openstack server command detailed under managing instances. For volume backup, see managing snapshots and images.

discussed previously, networking with respect to the assignment of IP addresses in the Rapid Access Cloud is handled automatically during provisioning, with the exception of public IPv4 addresses referred to as floating IPs in OpenStack. There is a single pool that floating IPs are allocated from, named ‘nova’ and by default each project is permitted a single IP from this pool:

• Allocate a floating IP to your projectCreate a volume: 

  Code Block
  $ openstack volumeip floating create --size 25 <volume_name>nova

  
  

• Assign an allocated floating IP to an instance: 

  Code Block
  $ openstack ip floating add <ip_address> <instance_name>

  
  

• List IP addresses allocated to projectClone an existing volume: 

  Code Block
  $ openstack volumeip create --source <existing_volume_id_or_name> <volume_name>

   

  floating list

  
  

• Remove floating IP from an instanceCreate a volume from a snapshot (see snapshots and images below): 

  Code Block
  $ openstack volumeip createfloating --snapshot <snapshot_id_or_name> <volume_name>remove <ip_address> <instance_name>

  
  

• Return allocated IP address to poolDelete a volume. This is a destructive action and all data associated with the volume is lost: 

  Code Block
  $ openstack ip volumefloating delete <volume<ip_name>

Snapshots and Images

...

• address>

  
  

Volumes

...

...

The root storage for an instance is solely for volatile application data such as kernel operations and applications. Rapid Access Cloud users are provided with a default 500GB of storage that can be used in the form of volumes to be attached to instances and treated no differently by the instance than an internal hard drive would be to a bare-metal server. Attaching volumes to instances is handled by the openstack server command detailed under managing instances. For volume backup, see managing snapshots and images.

• Create a volume

Before snapshotting your instance, make sure it is in a shut-off state.

• Create an image of an existing instance: 

  Code Block
  $ openstack servervolume image create --namesize <image_name>25 <instance<volume_name>

   

  
  

• Download an image to a local computerClone an existing volume: 

  Code Block
  $ openstack imagevolume savecreate --file <filesource <existing_volume_id_or_name> <image<volume_name>

   

• Create a volume from a snapshot (see snapshots and images below)Snapshot an existing volume, unattached to an instance: 

  Code Block
  $ openstack snapshotvolume create --namesnapshot <snapshot_id_or_name> <volume_name>

  
  

• Snapshot an existing volume, attached to an instanceDelete a volume. This is a destructive action and all data associated with the volume is lost: 

  Code Block
  $ openstack snapshotvolume create --name <snapshot_name> --force <volume_name>

  Note
  Note about volume snapshots: Notice the use of the --force switch when taking a snapshot of an attached volume; the snapshot will work and not fail, however if there are open files being actively written to the validity of the data being cloned cannot be guaranteed.

Installing command-line tools (OS X)

...

Ensure you have the Developer Tools (Xcode) with the Command Line Tools for OS X.

...

Open the Terminal application.

...

Install pip (a package management system for software packages written in python): 

 $ sudo easy_install pip

...

Install the openstack command line tool: 

$ pip install --user python-openstackclient

Add the following to .bashrc: 

...

• delete <volume_name>

  
  

Images

While it is true that instances in the Rapid Access Cloud are intended to be ephemeral, it is still possible to capture the state of an instance at any moment and save it as an image that can in turn be provisioned in a similar fashion to deploying a new instance using openstack server create as outlined above. This permits the ability to back-up an instance for safe keeping or create a base image with required applications already installed if you want to rapidly deploy many instances with a similar role.

• Create an image of an existing instance: 

  Code Block
  $ openstack server image create --name <image_name> <instance_name>

   

• Download an image to a local computer: 

  Code Block
  $ openstack image save --file <file_name> <image_name>