openstack/ironic-ui
Code Issues Proposed changes

Moving ironic-ui install content to install folder

Browse Source 
Change-Id: I6b80cf46bec09ad66ed189e08b79e0df10ca6850
This commit is contained in:
Julia Kreger 2017-07-04 00:15:49 +00:00
parent e8933532c4
commit 1113e2eaae
5 changed files with 49 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.rst
View File

@ -15,8 +15,8 @@ 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
* Documentation: http://docs.openstack.org/ironic-ui/latest
* Source: https://git.openstack.org/cgit/openstack/ironic-ui
* Bugs: http://bugs.launchpad.net/ironic-ui
Features
@ -25,80 +25,3 @@ 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 the Ironic UI repository::
git clone https://git.openstack.org/openstack/ironic-ui
2. 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.
3. 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
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.
Installation Instructions with devstack
---------------------------------------
In order to use the Ironic UI with devstack, you will need to enable the UI plugin separately.
This is done in a similar fashion to enabling Ironic for devstack.
Make sure you have horizon enabled (enabled by default in devstack).
Then, enable the Ironic UI plugin appending the following line to the end of the local.conf file,
just after Ironic plugin enablement:
enable_plugin ironic-ui https://github.com/openstack/ironic-ui
After this, you can run ./stack.sh from the devstack directory.
The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon
navigation.
6. Run JavaScript unit tests by either:
Running the tests locally with npm run test.
Visiting http://localhost:8000/jasmine/?spec=horizon.dashboard.admin.ironic in your
browser.
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.

11
doc/source/index.rst
View File

@ -1,6 +1,6 @@
===============================================
Welcome to Ironic UI's developer documentation!
===============================================
=====================================
Welcome to Ironic UI's documentation!
=====================================
Introduction
============
@ -21,13 +21,10 @@ For more information on ironic, see `the ironic documentation`_.
.. _the ironic documentation: http://docs.openstack.org/developer/ironic/
Administrator's Guide
=====================
.. toctree::
:maxdepth: 1
Introduction to ironic <http://docs.openstack.org/developer/ironic/deploy/user-guide.html>
Installing the ironic UI <installation>
Installing the ironic UI <install/index>
Contributing <contributing>
Release notes <http://docs.openstack.org/releasenotes/ironic-ui>

9
doc/source/install/index.rst Normal file
View File

@ -0,0 +1,9 @@
============================
ironic-ui installation guide
============================
.. toctree::
:maxdepth: 1
installation
uninstallation

32
doc/source/installation.rst → doc/source/install/installation.rst
View File

@ -1,6 +1,5 @@
.. _installation:
======================
Ironic-UI Installation
======================
@ -41,10 +40,29 @@ installation please see http://docs.openstack.org/developer/horizon/quickstart.h
The Bare Metal service should now be visible in the Horizon navigation.
Uninstallation
--------------
Ironic-UI Installation with DevStack
------------------------------------
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.
In order to use the Ironic UI with devstack, you will need to enable
the UI plugin separately in your installation local.conf file.
This is done in a similar fashion to enabling Ironic for devstack.
Make sure you have horizon enabled, which is the default in devstack.
Then, enable the Ironic UI plugin appending the following line to the end of the local.conf file,
just after Ironic plugin enablement:
enable_plugin ironic-ui https://github.com/openstack/ironic-ui
After this, you can run ./stack.sh from the devstack directory.
The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon
navigation.
6. Run JavaScript unit tests by either:
Running the tests locally with npm run test.
Visiting http://localhost:8000/jasmine/?spec=horizon.dashboard.admin.ironic in your
browser.

9
doc/source/install/uninstallation.rst Normal file
View File

@ -0,0 +1,9 @@
.. _unstallation:
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.