openstack/zun-ui
Code Issues Proposed changes

Improve Installation documentation

Browse Source 
Change-Id: I0c121f223fc31f8c48d728d9b2eae5e55828f871
This commit is contained in:
Shu Muto 2019-02-26 14:21:44 +09:00
parent 56b1e61b78
commit c5d3c8a989
2 changed files with 44 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.rst
View File

@ -1,14 +1,32 @@
======
Zun UI
======
==========
zun-ui
==========
Horizon plugin for Zun
Zun UI
* Free software: Apache license
* Source: https://git.openstack.org/cgit/openstack/zun-ui
* Bugs: https://bugs.launchpad.net/zun-ui
* Documentation: https://docs.openstack.org/zun-ui/latest/
* Release notes: https://docs.openstack.org/releasenotes/zun-ui/
Manual Installation
-------------------
Install Horizon according to `Horizon documentation <https://docs.openstack.org/horizon/>`_.
Clone Zun UI from git repository, checkout branch same as Horizon and Zun, and install it::
git clone https://github.com/openstack/zun-ui
git checkout <branch which you want>
cd zun-ui
pip install .
Enable Zun UI in your Horizon::
cp zun_ui/enabled/* <path to your horizon>/openstack_dashboard/local/enabled/
Then restart your Horizon.
After restart your Horizon, reload dashboard forcely using [Ctrl + F5] or etc. in your browser.
Enabling in DevStack
--------------------
@ -18,46 +36,3 @@ Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin zun-ui https://github.com/openstack/zun-ui
Manual Installation
-------------------
Begin by cloning the Horizon and Zun UI repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/zun-ui
Create a virtual environment and install Horizon dependencies::
cd horizon
python tools/install_venv.py
Set up your ``local_settings.py`` file::
cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
Open up the copied ``local_settings.py`` file in your preferred text
editor. You will want to customize several settings:
- ``OPENSTACK_HOST`` should be configured with the hostname of your
OpenStack server. Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Zun UI with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../zun-ui/
And enable it in Horizon::
cp ../zun-ui/zun_ui/enabled/_1330_project_container_panelgroup.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_1331_project_container_containers_panel.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_2330_project_container_panelgroup.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_2331_project_container_images_panel.py openstack_dashboard/local/enabled
To run horizon with the newly enabled Zun UI plugin run::
python manage.py runserver 0.0.0.0:8080
to have the application start on port 8080 and the horizon dashboard will be
available in your browser at http://localhost:8080/

67
doc/source/install/index.rst
View File

@ -2,6 +2,26 @@
Installation
============
Manual Installation
-------------------
Install Horizon according to `Horizon documentation <https://docs.openstack.org/horizon/>`_.
Clone Zun UI from git repository, checkout branch same as Horizon and Zun, and install it::
git clone https://github.com/openstack/zun-ui
git checkout <branch which you want>
cd zun-ui
pip install .
Enable Zun UI in your Horizon::
cp zun_ui/enabled/* <path to your horizon>/openstack_dashboard/local/enabled/
Then restart your Horizon.
After restart your Horizon, reload dashboard forcely using [Ctrl + F5] or etc. in your browser.
Enabling in DevStack
--------------------
@ -10,50 +30,3 @@ Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin zun-ui https://github.com/openstack/zun-ui
Manual Installation
-------------------
Begin by cloning the Horizon and Zun UI repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/zun-ui
Create a virtual environment and install Horizon dependencies::
cd horizon
python tools/install_venv.py
Set up your ``local_settings.py`` file::
cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
Open up the copied ``local_settings.py`` file in your preferred text
editor. You will want to customize several settings:
- ``OPENSTACK_HOST`` should be configured with the hostname of your
OpenStack server. Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Zun UI with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../zun-ui/
And enable it in Horizon::
cp ../zun-ui/zun_ui/enabled/_1330_project_container_panelgroup.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_1331_project_container_containers_panel.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_2330_project_container_panelgroup.py openstack_dashboard/local/enabled
cp ../zun-ui/zun_ui/enabled/_2331_project_container_images_panel.py openstack_dashboard/local/enabled
If allow users to use cloud shell::
cp ../zun-ui/zun_ui/enabled/_0330_cloud_shell.py openstack_dashboard/local/enabled
To run horizon with the newly enabled Zun UI plugin run::
python manage.py runserver 0.0.0.0:8080
to have the application start on port 8080 and the horizon dashboard will be
available in your browser at http://localhost:8080/