From 056d8ebc49d81dac468eb782eae97eebfe6e26a2 Mon Sep 17 00:00:00 2001 From: Elizabeth Elwell Date: Mon, 25 Jan 2016 17:23:52 +0000 Subject: [PATCH] Added installation instructions to the Readme Includes addition of install package to requirements.txt and note to user to ensure they remember to use requirements.txt to install additional packages as required. Change-Id: I122a3f6b2b62b6d1945013eb21c2fadc75910696 --- README.rst | 49 ++++++++++++++++++++++++++++++++++++++++++++++-- requirements.txt | 1 + 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e62c6066..d690a55a 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,8 @@ Ironic UI =============================== -The Ironic UI is a Horizon plugin that will allow users to view and manage bare metal nodes, ports and drivers. +The Ironic UI is a Horizon plugin that will allow users to view and manage bare +metal nodes, ports and drivers. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/ironic-ui @@ -12,4 +13,48 @@ The Ironic UI is a Horizon plugin that will allow users to view and manage bare Features -------- -* WIP \ No newline at end of file +* View bare metal nodes +* View node details +* Apply maintenance and power on/off actions to the nodes + +Installation Instructions +------------------------- + +Please note that the following instructions assume that you have an existing +installation of the OpenStack Horizon dashboard application. For Horizon +installation please see http://docs.openstack.org/developer/horizon/quickstart. +html + +1. Clone Ironic UI repository: + + `git clone https://git.openstack.org/openstack/ironic-ui` + +2. Change into the root directory of your horizon installation and run the venv. + NOTE: this has been preinstalled when horizon was setup with ./run_tests.sh - + do not reinstall venv + + `source .venv/bin/activate` + +3. Copy the _2200_ironic.py file from ironic-ui/enabled directory to +horizon/openstack_dashboard/local/enabled + +4. Change into the ironic-ui repository and package the plugin: + + `pip install -e .` + +This will build and install the ironic-ui plugin into the active virtual +environment associated with your horizon installation. The plugin is installed +in "editable" mode as a link back to your ironic-ui plugin directory. + +Also ensure that all packages as per requirements.txt have been installed. + +5. Change back into the horizon repository and bring up your environment: + + `./run_tests.sh --runserver` + +The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon +navigation. + +To uninstall, use pip uninstall (find the name of the package to uninstall by +running pip list from inside the horizon .venv). You will also need to remove +the enabled file from the openstack_dashboard/enabled folder. diff --git a/requirements.txt b/requirements.txt index 95d0fe88..00b97bbc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ # process, which may cause wedges in the gate later. pbr>=1.6 # Apache-2.0 +python-ironicclient>=1.1.0 # Apache-2.0