trove/doc/source/index.rst
Andreas Jaeger a23e5451fb Sphinx: Treat warnings as errors
Add warning-is-error to setup.cfg to treat sphinx warnings as errors.
Fix all existing warnings so that docs build with this change.
Also fix some display problems in secure_oslo_messaging.

Change-Id: I7b2fe76cfc388c49f6be4c2d62e983b19bd7e927
2017-03-03 22:16:49 +01:00

2.4 KiB

Welcome to Trove's developer documentation!

Introduction

Trove is Database as a Service for OpenStack. It's designed to run entirely on OpenStack, with the goal of allowing users to quickly and easily utilize the features of a relational database without the burden of handling complex administrative tasks. Cloud users and database administrators can provision and manage multiple database instances as needed.

Initially, the service will focus on providing resource isolation at high performance while automating complex administrative tasks including deployment, configuration, patching, backups, restores, and monitoring.

For an in-depth look at the project's design and structure, see the dev/design page.

Installation And Deployment

Trove is constantly under development. The easiest way to install Trove is using the Trove integration scripts that can be found in git in the Trove Repository.

For further details on how to install Trove using the integration scripts please refer to the dev/install page.

For further details on how to install Trove to work with existing OpenStack environment please refer to the dev/manual_install page.

Developer Resources

For those wishing to develop Trove itself, or to extend Trove's functionality, the following resources are provided.

dev/design dev/testing dev/install dev/manual_install.rst dev/building_guest_images.rst dev/guest_cloud_init.rst dev/notifier.rst dev/trove_api_extensions.rst dev/secure_oslo_messaging.rst

Guest Images

In order to use Trove, you need to have Guest Images for each datastore and version. These images are loaded into Glance and registered with Trove.

For those wishing to develop guest images, please refer to the build_guest_images page.

Search Trove Documentation

  • search