OpenStack Dashboard plugin for Trove project
============================================
.. image:: https://governance.openstack.org/tc/badges/trove-dashboard.svg
:target: https://governance.openstack.org/tc/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 https://opendev.org/openstack/trove-dashboard
Here is a full example of devstack ``local.conf`` file that includes the trove plugin::
[[local|localrc]]
RECLONE=False
HOST_IP=<your-host-ip-here>
enable_plugin trove https://opendev.org/openstack/trove
enable_plugin trove-dashboard https://opendev.org/openstack/trove-dashboard
LIBS_FROM_GIT+=,python-troveclient
DATABASE_PASSWORD=password
ADMIN_PASSWORD=password
SERVICE_PASSWORD=password
SERVICE_TOKEN=password
RABBIT_PASSWORD=password
LOGFILE=$DEST/logs/stack.sh.log
VERBOSE=True
LOG_COLOR=False
LOGDAYS=1
IPV4_ADDRS_SAFE_TO_USE=10.111.0.0/26
FIXED_RANGE=10.111.0.0/26
NETWORK_GATEWAY=10.111.0.1
FLOATING_RANGE=172.30.5.0/24
PUBLIC_NETWORK_GATEWAY=172.30.5.1
# Pre-requisites
ENABLED_SERVICES=rabbit,mysql,key
# Horizon
enable_service horizon
# Nova
enable_service n-api
enable_service n-cpu
enable_service n-cond
enable_service n-sch
enable_service n-api-meta
enable_service placement-api
enable_service placement-client
# Glance
enable_service g-api
enable_service g-reg
# Cinder
enable_service cinder
enable_service c-api
enable_service c-vol
enable_service c-sch
# Neutron
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
# enable DVR
Q_PLUGIN=ml2
Q_ML2_TENANT_NETWORK_TYPE=vxlan
Q_DVR_MODE=legacy
# Swift
ENABLED_SERVICES+=,swift
SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5
SWIFT_REPLICAS=1
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://opendev.org/openstack/trove/
Trove at wiki.openstack.org: https://wiki.openstack.org/wiki/Trove
Launchpad project: https://launchpad.net/trove-dashboard
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/trove/latest",
"name": "trove-dashboard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/d8/b6/5162c7b41e7e1b3dcc846208e26cd89720768cfa297668363d4fcbe13f8b/trove-dashboard-23.0.0.tar.gz",
"platform": null,
"description": "OpenStack Dashboard plugin for Trove project\n============================================\n\n.. image:: https://governance.openstack.org/tc/badges/trove-dashboard.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n\nHow to use with Horizon on server:\n----------------------------------\n\nUse pip to install the package on the server running Horizon. Then either copy\nor link the files in trove_dashboard/enabled to\nopenstack_dashboard/local/enabled. This step will cause the Horizon service to\npick up the trove plugin when it starts.\n\nHow to use with devstack:\n-------------------------\n\nAdd the following to your devstack ``local.conf`` file::\n\n enable_plugin trove-dashboard https://opendev.org/openstack/trove-dashboard\n\nHere is a full example of devstack ``local.conf`` file that includes the trove plugin::\n\n [[local|localrc]]\n RECLONE=False\n HOST_IP=<your-host-ip-here>\n\n enable_plugin trove https://opendev.org/openstack/trove\n enable_plugin trove-dashboard https://opendev.org/openstack/trove-dashboard\n\n LIBS_FROM_GIT+=,python-troveclient\n DATABASE_PASSWORD=password\n ADMIN_PASSWORD=password\n SERVICE_PASSWORD=password\n SERVICE_TOKEN=password\n RABBIT_PASSWORD=password\n LOGFILE=$DEST/logs/stack.sh.log\n VERBOSE=True\n LOG_COLOR=False\n LOGDAYS=1\n\n IPV4_ADDRS_SAFE_TO_USE=10.111.0.0/26\n FIXED_RANGE=10.111.0.0/26\n NETWORK_GATEWAY=10.111.0.1\n FLOATING_RANGE=172.30.5.0/24\n PUBLIC_NETWORK_GATEWAY=172.30.5.1\n\n # Pre-requisites\n ENABLED_SERVICES=rabbit,mysql,key\n\n # Horizon\n enable_service horizon\n\n # Nova\n enable_service n-api\n enable_service n-cpu\n enable_service n-cond\n enable_service n-sch\n enable_service n-api-meta\n enable_service placement-api\n enable_service placement-client\n\n # Glance\n enable_service g-api\n enable_service g-reg\n\n # Cinder\n enable_service cinder\n enable_service c-api\n enable_service c-vol\n enable_service c-sch\n\n # Neutron\n enable_service q-svc\n enable_service q-agt\n enable_service q-dhcp\n enable_service q-l3\n enable_service q-meta\n\n # enable DVR\n Q_PLUGIN=ml2\n Q_ML2_TENANT_NETWORK_TYPE=vxlan\n Q_DVR_MODE=legacy\n\n # Swift\n ENABLED_SERVICES+=,swift\n SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5\n SWIFT_REPLICAS=1\n\n\nTo run unit tests:\n------------------\n::\n\n ./run_tests.sh\n\nEditing Code\n------------\n\nApache\n~~~~~~\n\nMake a change to trove-dashboard then goto to the horizon directory and\ncompress the code with django and then restart apache.::\n\n # rsync code to /opt/stack/trove-dashboard\n # copy or link files from trove-dashboard/enabled/* to horizon/openstack_dashboard/local/enabled/\n cd /opt/stack/horizon\n python manage.py compress\n python manage.py collectstatic --noinput\n sudo service apache2 restart\n\n\nDjango\n~~~~~~\n\nYou can also speed up development time using the django test server instead of\napache.::\n\n /opt/stack/horizon/run_tests.sh --runserver\n\nIf you set COMPRESS_ENABLED and COMPRESS_OFFLINE to False in local_settings.py\nthat allows you to bypass the compress and collectstatic as well.\n\n\nSettings\n~~~~~~~~\n\nThe use of a cross-process cache such as Memcached is required.\n\nInstall Memcached itself and a Memcached binding such as python-memcached.\n\nFor a single horizon instance use the CACHES setting like the example below.::\n\n CACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',\n 'LOCATION': '127.0.0.1:11211',\n },\n }\n\nFor multiple horizon instances behind a load balancer configure each instance\nto use the same cache like the example below.::\n\n CACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',\n 'LOCATION': [u'10.2.100.133:11211', u'10.2.100.134:11211'']\n },\n }\n\n\nNOTE:\n=====\n\nAs of the Mitaka release, the dashboard for trove is now maintained outside of\nthe Horizon codebase, in this repository.\n\nLinks:\n------\n\nTrove project: https://opendev.org/openstack/trove/\n\nTrove at wiki.openstack.org: https://wiki.openstack.org/wiki/Trove\n\nLaunchpad project: https://launchpad.net/trove-dashboard\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Trove Management Dashboard",
"version": "23.0.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/trove/latest"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8eb1b54fdae0805a96dd1af889977e4788efbe70235075c846d4cb341e430ad",
"md5": "b8c571e46cc36baf714ff4d3af967bc2",
"sha256": "c6ef3fcff17c09e430ff2a80cc625ddaa93db6ce70bc9844e2cf1a75e5cdbc09"
},
"downloads": -1,
"filename": "trove_dashboard-23.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8c571e46cc36baf714ff4d3af967bc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 260554,
"upload_time": "2024-10-02T11:05:59",
"upload_time_iso_8601": "2024-10-02T11:05:59.418875Z",
"url": "https://files.pythonhosted.org/packages/f8/eb/1b54fdae0805a96dd1af889977e4788efbe70235075c846d4cb341e430ad/trove_dashboard-23.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8b65162c7b41e7e1b3dcc846208e26cd89720768cfa297668363d4fcbe13f8b",
"md5": "959f636e175828367df6f18f7f569da3",
"sha256": "f4e77150a8b1861705f5816405404b947926690ad887914d7658295a2f3f37a1"
},
"downloads": -1,
"filename": "trove-dashboard-23.0.0.tar.gz",
"has_sig": false,
"md5_digest": "959f636e175828367df6f18f7f569da3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 212335,
"upload_time": "2024-10-02T11:06:01",
"upload_time_iso_8601": "2024-10-02T11:06:01.169382Z",
"url": "https://files.pythonhosted.org/packages/d8/b6/5162c7b41e7e1b3dcc846208e26cd89720768cfa297668363d4fcbe13f8b/trove-dashboard-23.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 11:06:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "trove-dashboard"
}
JSON