75c77c1627
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/bb1efd9e3989198cd126fe49ec17faae\n' Change-Id: I99554920175bdfba9c5e1452d8033c8bc362fbd3
69 lines
2.2 KiB
ReStructuredText
69 lines
2.2 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/ironic-ui.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
===============================
|
|
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
|
|
|
|
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.
|