Metadata-Version: 2.4
Name: trove-dashboard
Version: 25.1.0.dev10
Summary: Trove Management Dashboard
Home-page: https://docs.openstack.org/trove/latest
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: Apache-2.0
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
License-File: LICENSE
Requires-Dist: pbr>=1.6
Requires-Dist: oslo.log>=3.30.0
Requires-Dist: python-swiftclient>=2.2.0
Requires-Dist: python-troveclient>=1.2.0
Requires-Dist: horizon>=17.1.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

============================================
OpenStack Dashboard plugin for Trove project
============================================

.. image:: https://governance.openstack.org/tc/badges/trove-dashboard.svg

.. Change things from this point on

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:
-------------------------

Complete instructions on how to deploy DevStack with
Trove and Trove-Dashboard, please refer to the official `OpenStack documentation <https://docs.openstack.org/trove/latest/install/install-devstack.html>`_.

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': ['10.2.100.133:11211', '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 Documentation: https://docs.openstack.org/trove/latest

Trove at wiki.openstack.org: https://wiki.openstack.org/wiki/Trove

Launchpad project: https://launchpad.net/trove-dashboard

Release notes: https://docs.openstack.org/releasenotes/trove-dashboard

