From 1113e2eaae4ad7ee2496fd91e274076bfa5ce04c Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Tue, 4 Jul 2017 00:15:49 +0000 Subject: [PATCH] Moving ironic-ui install content to install folder Change-Id: I6b80cf46bec09ad66ed189e08b79e0df10ca6850 --- README.rst | 81 +---------------------- doc/source/index.rst | 11 ++- doc/source/install/index.rst | 9 +++ doc/source/{ => install}/installation.rst | 32 +++++++-- doc/source/install/uninstallation.rst | 9 +++ 5 files changed, 49 insertions(+), 93 deletions(-) create mode 100644 doc/source/install/index.rst rename doc/source/{ => install}/installation.rst (63%) create mode 100644 doc/source/install/uninstallation.rst diff --git a/README.rst b/README.rst index 580e2c80..28903f83 100644 --- a/README.rst +++ b/README.rst @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index c082cf82..058fea18 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 - Installing the ironic UI + Installing the ironic UI Contributing Release notes diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 00000000..6e52bf41 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,9 @@ +============================ +ironic-ui installation guide +============================ + +.. toctree:: + :maxdepth: 1 + + installation + uninstallation diff --git a/doc/source/installation.rst b/doc/source/install/installation.rst similarity index 63% rename from doc/source/installation.rst rename to doc/source/install/installation.rst index 290c3bc7..b37ae20f 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/installation.rst @@ -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. diff --git a/doc/source/install/uninstallation.rst b/doc/source/install/uninstallation.rst new file mode 100644 index 00000000..f8515c56 --- /dev/null +++ b/doc/source/install/uninstallation.rst @@ -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.