The OpenStack Command Line Interface (CLI) tools are recommended for advanced users only.  The majority of information about your cloud account can be managed in the OpenStack web console.


The steps to setup the CLI tools and connect to Lake Effect are as follows:


1. Install the OpenStack client tools for the operating system of your desktop/laptop.    



Most Linux and MacOS distributions can install this using pip.  You may want to use a virtual environment - documentation can be found online, if you are unfamiliar with this.


sudo apt install virtualenv


virtualenv openstack

source openstack/bin/activate

pip install python-cinderclient

pip install python-openstackclient


sudo apt install git


CCR software to allow the connection of your machine and the Lake Effect cloud:

pip install git+https://github.com/ubccr/v3oidcmokeyapikey.git



Please see this documentation from Red Hat for more information on installing the OpenStack tools.  Windows client installations have not been tested by CCR at this time.




2.  Create an API key in the identity management portal to allow for secure access between your machine and the Lake Effect cloud:


https://idm.ccr.buffalo.edu/apikey


Click the "Create Api Key" button:


Click the "Create" button in the pop-up window:




You are then provided your API key that you'll use in your OpenStack configuration.

DO NOT SHARE THIS INFORMATION!  If you believe it may be compromised, delete it and recreate a new one


As the message states, copy the key to a safe place.  Once you've copied your API key from the IDM portal, you can click done and you will be redirected to the page displaying the API key you've activated.  You can then exit the IDM portal:






4.  Download the version 3 Openstack configuration file to your desktop.  You can find it under Projects - API Access - Download Openstack RC File.  Make sure to choose the 'Identity API v3' version:




Your openrc file will look something like this but your username and project_name will be different:




5. Now  go back to your terminal window, you will need to source your RC file and then you'll be able to run OpenStack commands:


source ~/Downloads/lakeeffect-ccrstds-openrc.sh

If you renamed your openrc file you can type "source " then drag and drop your openrc file in the terminal window


You'll be prompted to enter your API key.  NOTE: it will not show up on the command line - copy & paste it, then you should be brought back to a prompt and can begin using Openstack tools such as:


openstack image list

openstack flavor list

openstack network list

openstack security group list

openstack keypair list


openstack --help