openstack/ironic-ui
Code Issues Proposed changes
ironic-ui/doc/source/installation.rst
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

1.8 KiB
Raw Blame History

Ironic-UI Installation

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 virtualenv. Example:

    source .venv/bin/activate

    Note

    The .venv folder is pre-installed 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 -r requirements.txt -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.

  5. Change back into the horizon repository and bring up your environment:

    ./run_tests.sh --runserver

    The Bare Metal service 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.