magnum-ui/README.rst
Shu Muto d78285db9d Add releasenotes links to README
Add release notes link to README.rst.

Change-Id: I88e67589164e0f0ceb3c281ca2703f6e0d7f78b0
2018-03-29 16:44:03 +09:00

72 lines
2.4 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/magnum-ui.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=========
Magnum UI
=========
Horizon plugin for Magnum
* Free software: Apache license
* Source: http://git.openstack.org/cgit/openstack/magnum-ui
* Bugs: http://bugs.launchpad.net/magnum-ui
* Documentation: https://docs.openstack.org/magnum-ui/latest/
* Release notes: https://docs.openstack.org/releasenotes/magnum-ui/
Enabling in DevStack
--------------------
Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin magnum-ui https://github.com/openstack/magnum-ui
Manual Installation
-------------------
Begin by cloning the Horizon and Magnum UI repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/magnum-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 Magnum UI with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../magnum-ui/
And enable it in Horizon::
cp ../magnum-ui/magnum_ui/enabled/_1370_project_container_infra_panel_group.py openstack_dashboard/local/enabled
cp ../magnum-ui/magnum_ui/enabled/_1371_project_container_infra_clusters_panel.py openstack_dashboard/local/enabled
cp ../magnum-ui/magnum_ui/enabled/_1372_project_container_infra_cluster_templates_panel.py openstack_dashboard/local/enabled
To run horizon with the newly enabled Magnum 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/