Installing the OpenStack Command Line Interface (CLI) Tools

This article assumes you already have an account at Internap, have logged into the customer portal, and obtained your API credentials. This procedure will demonstrate how to install the OpenStack Command Line Interface (CLI) Tools.

Using the OpenStack CLI (command-line interface) tools to manage resources in Next-Generation AgileCLOUD is one alternative to using the web-based portal. These commands can be used interactively or added into shell scripts for simple infrastructure management.

Note:

The following CLI tools are supported at Internap:

  • nova (compute)
  • swift (object storage)
  • glance (image management)
  • cinder (block storage)
  • heat (orchestration)
  • openstack (common OpenStack commands)
  • keystone (identity/catalog – deprecated)
  • neutron (network – limited functionality)

We recommend following the official OpenStack instructions for installing the CLI tools for your operating system:

  1. Install the client tools
  2. Set your environment variables

An example nova-openrc.sh file is available at http://downloads.internap.com/nova-openrc.sh

To configure the openrc file, you’ll need the followiing info:

  • OS_USERNAME
  • OS_PASSWORD
  • OS_TENANT_NAME
  • OS_AUTH_URL

 

Once installed and configured, you can test the CLI tools from a terminal window.
Running the openstack catalog command should yield something like this:


user@host$ openstack catalog list
+----------+----------------+-------------------------------------------------------------------------------------------------------+
| Name | Type | Endpoints |
+----------+----------------+-------------------------------------------------------------------------------------------------------+
| nova | compute | da01 |
| | | publicURL: https://compute.api.da01.cloud.iweb.com/v2/e88d0e9c81914ccd99d71a1d7f5d5baf |
| | | internalURL: https://compute.api.da01.cloud.iweb.com/v2/e88d0e9c81914ccd99d71a1d7f5d5baf |
| | | adminURL: https://compute.api.da01.cloud.iweb.com/v2/e88d0e9c81914ccd99d71a1d7f5d5baf |
| | | 

If you want to work with server instances, you can run a few nova commands:


user@host$ nova list
user@host$ nova image-list
user@host$ nova sec-group list

Each CLI tool includes the “help” command for more info.
For example, nova help will give you an output with available nova commands, positional arguments, etc. Using nova help command will give you info on that specific command.

$ nova help image-list
usage: nova image-list [--limit <limit>]

Print a list of available images to boot from.

Optional arguments:
  --limit <limit>  Number of images to return per request.