ui-cookiecutter/{{cookiecutter.repo_name}}
Akihiro Motoki 4ebeeab1d4 Update document link affected by document migration
Also use https for docs.openstack.org

Change-Id: Ic1f52fbc9815bf12b67812712593cf60299f956a
2017-07-14 13:26:34 +00:00
..
{{cookiecutter.module_name}} hacking: Specify white list rules in noqa explicity 2017-05-31 21:11:36 +09:00
doc Switch from oslosphinx to openstackdocstheme 2017-06-29 18:31:53 +09:00
releasenotes Switch from oslosphinx to openstackdocstheme 2017-06-29 18:31:53 +09:00
tools Use tox_install.sh to handle Depends-On 2017-05-31 21:12:07 +09:00
.eslintrc Setup JavaScript test environment 2016-10-05 17:07:26 +09:00
.gitignore ignore nose test result 2017-06-22 12:31:29 +09:00
.gitreview Update description of this cookiecutter 2016-11-17 14:51:32 +09:00
.jshintrc change for Dashboard UI plugin 2016-07-27 16:15:56 +09:00
babel-django.cfg change for Dashboard UI plugin 2016-07-27 16:15:56 +09:00
babel-djangojs.cfg change for Dashboard UI plugin 2016-07-27 16:15:56 +09:00
CONTRIBUTING.rst Update document link affected by document migration 2017-07-14 13:26:34 +00:00
HACKING.rst Update document link affected by document migration 2017-07-14 13:26:34 +00:00
LICENSE Modified to work for OpenStack projects 2013-08-18 14:28:57 -04:00
manage.py hacking: Specify white list rules in noqa explicity 2017-05-31 21:11:36 +09:00
MANIFEST.in Remove ironic_ui :) 2017-05-31 12:26:50 +09:00
package.json Use module_name everywhere; module_folder is redundant 2017-05-31 12:26:26 +09:00
README.rst Use module_name everywhere; module_folder is redundant 2017-05-31 12:26:26 +09:00
requirements.txt Update requirements for pbr>=2.0.0 2017-04-13 10:09:59 +00:00
setup.cfg Improve docs build 2017-05-31 21:12:55 +09:00
setup.py Update requirements for pbr>=2.0.0 2017-04-13 10:09:59 +00:00
test-requirements.txt Switch from oslosphinx to openstackdocstheme 2017-06-29 18:31:53 +09:00
test-shim.js Setup JavaScript test environment 2016-10-05 17:07:26 +09:00
tox.ini Merge "Improve docs build" 2017-06-19 07:11:56 +00:00

{{ 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/