230a112ee6
Some of the trove-dashboard panels require a cross-process cache to be used to temporarily store data until it is committed to the server. For example, building up the list of configuration parameters is store in the cache until it is applied to the the database instance. This requirement is now added to the readme to inform users to enable the cache. Change-Id: I1928da600c7364d8681a8c0b45fe1c66c97032df Closes-Bug: #1638713
100 lines
2.5 KiB
ReStructuredText
100 lines
2.5 KiB
ReStructuredText
OpenStack Dashboard plugin for Trove project
|
|
============================================
|
|
|
|
.. image:: http://governance.openstack.org/badges/trove-dashboard.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
|
|
How to use with Horizon on server:
|
|
----------------------------------
|
|
|
|
Use pip to install the package on the server running Horizon. Then either copy
|
|
or link the files in trove_dashboard/enabled to
|
|
openstack_dashboard/local/enabled. This step will cause the Horizon service to
|
|
pick up the trove plugin when it starts.
|
|
|
|
How to use with devstack:
|
|
-------------------------
|
|
|
|
Add the following to your devstack ``local.conf`` file::
|
|
|
|
enable_plugin trove-dashboard git://git.openstack.org/openstack/trove-dashboard
|
|
|
|
|
|
To run unit tests:
|
|
------------------
|
|
::
|
|
|
|
./run_tests.sh
|
|
|
|
Editing Code
|
|
------------
|
|
|
|
Apache
|
|
~~~~~~
|
|
|
|
Make a change to trove-dashboard then goto to the horizon directory and
|
|
compress the code with django and then restart apache.::
|
|
|
|
# rsync code to /opt/stack/trove-dashboard
|
|
# copy or link files from trove-dashboard/enabled/* to horizon/openstack_dashboard/local/enabled/
|
|
cd /opt/stack/horizon
|
|
python manage.py compress
|
|
python manage.py collectstatic --noinput
|
|
sudo service apache2 restart
|
|
|
|
|
|
Django
|
|
~~~~~~
|
|
|
|
You can also speed up development time using the django test server instead of
|
|
apache.::
|
|
|
|
/opt/stack/horizon/run_tests.sh --runserver
|
|
|
|
If you set COMPRESS_ENABLED and COMPRESS_OFFLINE to False in local_settings.py
|
|
that allows you to bypass the compress and collectstatic as well.
|
|
|
|
|
|
Settings
|
|
~~~~~~~~
|
|
|
|
The use of a cross-process cache such as Memcached is required.
|
|
|
|
Install Memcached itself and a Memcached binding such as python-memcached.
|
|
|
|
For a single horizon instance use the CACHES setting like the example below.
|
|
|
|
CACHES = {
|
|
'default': {
|
|
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
|
|
'LOCATION': '127.0.0.1:11211',
|
|
},
|
|
}
|
|
|
|
For multiple horizon instances behind a load balancer configure each instance
|
|
to use the same cache like the example below.
|
|
|
|
CACHES = {
|
|
'default': {
|
|
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
|
|
'LOCATION': [u'10.2.100.133:11211', u'10.2.100.134:11211'']
|
|
},
|
|
}
|
|
|
|
|
|
NOTE:
|
|
=====
|
|
|
|
As of the Mitaka release, the dashboard for trove is now maintained outside of
|
|
the Horizon codebase, in this repository.
|
|
|
|
Links:
|
|
------
|
|
|
|
Trove project: https://git.openstack.org/openstack/trove
|
|
|
|
Trove at wiki.openstack.org: https://wiki.openstack.org/wiki/Trove
|
|
|
|
Launchpad project: https://launchpad.net/trove
|