Skip to content
This repository has been archived by the owner on Nov 16, 2022. It is now read-only.

Latest commit

 

History

History
118 lines (83 loc) · 2.92 KB

INSTALL.md

File metadata and controls

118 lines (83 loc) · 2.92 KB
Raw

CLI Explorer

Installing pre requisites

If you have a virgin Ubuntu server, the following steps will install and configure a working web environment to demonstrate the CLI Explorer with a local OpenStack dev environment running the OpenStack Client only.

sudo apt-get install -y apache2 git-core

Install CLI Explorer code

sudo su -
cd /var/www
git clone https://github.com/ronaldbradford/cli_explorer.git
cp cli_explorer/etc/cli_explorer.cnf.example cli_explorer/etc/cli_explorer.cnf
cp cli_explorer/etc/apache2/sites-available/cli_explorer.conf /etc/apache2/sites-available
ln -s /etc/apache2/sites-available/cli_explorer.conf /etc/apache2/sites-enabled
echo "ServerName "`hostname` > /etc/apache2/conf-enabled/servername.conf
rm /etc/apache2/sites-enabled/000-default.conf
apachectl graceful
curl -s http://localhost | grep title
exit # from root

Install OpenStack Client

In order to run the various CLI commands these must be installed on server running the web container.

Install from source

sudo apt-get install -y python-dev python-tox
git clone https://git.openstack.org/openstack/python-openstackclient
cd python-openstackclient
tox -e py27
. .tox/py27/bin/activate
python setup.py build
python setup.py install
pip install flask

This will setup a virtual environment ready to run the Flask container.

Install from Ubuntu packages

This is an example of using the OpenStack Kilo client tools on Ubuntu 14.04 LTS.

  sudo apt-get install ubuntu-cloud-keyring
  echo "deb http://ubuntu-cloud.archive.canonical.com/ubuntu trusty-updates/kilo main"  | sudo tee /etc/apt/sources.list.d/cloudarchive-kilo.list
  sudo apt-get update
  sudo apt-get install python-openstackclient

In addition to installing openstack, the other OpenStack clients such as nova and glance are installed with these commands.

You will also need to install the Python pip installer and flask module.

  sudo apt-get install -y python-pip
  sudo pip install flask

Verifying the API Endpoint

After you have a working environment you can start the API endpoint with:

python /var/www/cli_explorer/api/api.py

This command will provide stdout for the startup and requests like:

* Running on http://127.0.0.1:4242/ (Press CTRL+C to quit)
* Restarting with stat

In a different session you can validate the API endpoint is working with:

curl http://localhost:4242/api

This will return a JSON response of the available API endpoints:

{
  "apis": [
    "/api/cli"
  ]
}

And you will see the stdout of the request in the flask window.

...
127.0.0.1 - - [20/Oct/2015 16:54:50] "GET /api HTTP/1.1" 200 -
...

If you wish to run this on a public URL rather than localhost you will need to modift the configuration in /var/www/cli_explorer/etc/cli_explorer.conf to define the public URL and IP address of the server.

Future Work

TODO: Ensure the flask process can run in a daemon process.