Julia Kreger 8d6fcd819c Refactor ironic-ui documentation to remove warnings

Warnings, such as those caused by the README.rst file's
inclusion of an externally hosted file cause the default
sphinx job to fail. Removed the link, and cleaned up the
documentation formatting to make it more clear moving
forward.

Change-Id: I55afe786b794a6cb179a3de20b5f4e0f3f8072c8

2016-12-12 23:43:49 +00:00

2.5 KiB

Raw Blame History

Team and repository tags

Ironic UI

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
Source: http://git.openstack.org/cgit/openstack/ironic-ui
Bugs: http://bugs.launchpad.net/ironic-ui

Features

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

Clone the Ironic UI repository:

git clone https://git.openstack.org/openstack/ironic-ui

Change into the root directory of your horizon installation and activate the python virtual environment. Example:
```
source .venv/bin/activate
```
Note

The .venv folder is preinstalled when horizon is setup with ./run_tests.sh. Do not attempt to reinstall the virtual environment.
Copy the _2200_ironic.py file from ironic_ui/enabled/_2200_ironic.py file to horizon/openstack_dashboard/local/enabled directory. Example, set as if being executed from the root of the ironic-ui repository:
```
cp ./ironic_ui/enabled/_2200_ironic.py ../horizon/horizon/openstack_dashboard/local/enabled
```
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.
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.

Uninstallation

To uninstall, use pip uninstall ironic-ui from with-in the horizon virtual environment. You will also need to remove the openstack_dashboard/enabled/_2200_ironic.py file from the horizon installation.