ui-cookiecutter/{{cookiecutter.repo_name}}/README.rst
manchandavishal 3216c90db0 Changes for url transition to OpenDev
This commit changes openstack.org URL to opendev.org URL
as discussed here [1]

[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html

Change-Id: I10d71b6face1f58c42ae3e2a590f1ac77fb5e4af
2019-04-23 05:14:24 +00:00

2.3 KiB

{{ cookiecutter.call_by_name }}

{{ cookiecutter.project_short_description}}

Features

  • TODO

Enabling in DevStack

Add this repo as an external repository into your local.conf file:

[[local|localrc]]
enable_plugin {{ cookiecutter.module_name }} https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}

Manual Installation

Begin by cloning the Horizon and {{ cookiecutter.call_by_name }} repositories:

git clone https://github.com/openstack/horizon
git clone https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}

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 {{ cookiecutter.call_by_name }} with all dependencies in your virtual environment:

tools/with_venv.sh pip install -e ../{{ cookiecutter.repo_name }}/

And enable it in Horizon:

ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_90_project_{{ cookiecutter.panel_group }}_panelgroup.py openstack_dashboard/local/enabled
ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_91_project_{{ cookiecutter.panel_group }}_{{ cookiecutter.panel }}s_panel.py openstack_dashboard/local/enabled

To run horizon with the newly enabled {{ cookiecutter.call_by_name }} plugin run:

./run_tests.sh --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/