From c5d3c8a9894fbc8ae9081391a52070a212a1addd Mon Sep 17 00:00:00 2001 From: Shu Muto Date: Tue, 26 Feb 2019 14:21:44 +0900 Subject: [PATCH] Improve Installation documentation Change-Id: I0c121f223fc31f8c48d728d9b2eae5e55828f871 --- README.rst | 73 ++++++++++++------------------------ doc/source/install/index.rst | 67 ++++++++++----------------------- 2 files changed, 44 insertions(+), 96 deletions(-) diff --git a/README.rst b/README.rst index 05ebe38..30cd1e7 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. + +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 + cd zun-ui + pip install . + +Enable Zun UI in your Horizon:: + + cp zun_ui/enabled/* /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/ diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index dcafdcf..27958db 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -2,6 +2,26 @@ Installation ============ +Manual Installation +------------------- + +Install Horizon according to `Horizon documentation `_. + +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 + cd zun-ui + pip install . + +Enable Zun UI in your Horizon:: + + cp zun_ui/enabled/* /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/