openstack
/
trove
Code Issues Proposed changes
OpenStack Database As A Service (Trove)
1,373 Commits 9 Branches 47 Tags 113 MiB
Python 95.1%
Shell 4.9%
Go to file
Jenkins fc8932bb63 Merge "Add a new column and indexes to agent_heartbeats" 2014-06-11 02:07:35 +00:00
apidocs Update database-api to follow OpenStack conventions 2014-05-23 07:32:29 +02:00
contrib Migrating trove to entry points 2014-02-01 01:19:58 +00:00
doc Start using oslosphinx theme for docs 2014-03-26 15:50:05 +04:00
etc Remove unused xml config file 2014-05-28 17:13:01 -07:00
rsdns Merge "Use six.moves.urllib.parse instead of urlparse" 2014-04-17 22:25:30 +00:00
tools rename and fix the db_wipe command 2014-03-10 10:16:03 +01:00
trove Merge "Add a new column and indexes to agent_heartbeats" 2014-06-11 02:07:35 +00:00
.coveragerc Rename from reddwarf to trove. 2013-06-24 14:11:15 -07:00
.gitignore Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05:00
.gitreview Renamed repos to trove. 2013-06-14 18:25:42 -04:00
.testr.conf Rename from reddwarf to trove. 2013-06-24 14:11:15 -07:00
LICENSE Add Apache 2.0 LICENSE file. 2013-04-29 18:01:12 -04:00
MANIFEST.in Package AUTHORS and ChangeLog file 2013-06-25 10:41:57 +02:00
README.rst Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05:00
babel.cfg Setup trove for translation 2014-03-19 15:06:23 +01:00
doc-test.conf Update database-api to follow OpenStack conventions 2014-05-23 07:32:29 +02:00
openstack-common.conf Clean up openstack-common.conf 2014-05-27 11:54:39 +00:00
requirements.txt Updated from global requirements 2014-05-21 18:56:11 +00:00
run_tests.py Hide Datastores In List With No Active Versions 2014-03-14 13:22:02 -07:00
run_tests.sh Remove extraneous vim configuration comments 2014-02-27 15:05:21 +08:00
setup.cfg Open Juno development 2014-04-02 11:06:09 +02:00
setup.py Updated from global requirements 2014-05-01 13:51:51 +00:00
test-requirements.txt switch from mox to mox3 2014-05-30 08:42:03 +00:00
tox.ini Merge "Enabled H402 flake8 rule" 2014-06-08 11:16:59 +00:00

README.rst

Trove

Trove is Database as a Service for Open Stack.

Usage for integration testing

If you'd like to start up a fake Trove API daemon for integration testing with your own tool, run:

$ ./tools/start-fake-mode.sh

Stop the server with:

$ ./tools/stop-fake-mode.sh

Tests

To run all tests and PEP8, run tox, like so:

$ tox

To run just the tests for Python 2.7, run:

$ tox -epy27

To run just PEP8, run:

$ tox -epep8

To generate a coverage report,run:

$ tox -ecover

(note: on some boxes, the results may not be accurate unless you run it twice)

Docs

This repository contains the following OpenStack manual:

  • Database Services API Reference

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Building

The manuals are in the apidocs directory.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd apidocs
mvn clean generate-sources

The generated PDF documentation file is:

apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf

The root of the generated HTML documentation is:

apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Contributing

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.

The best way to get involved with the community is to talk with others online or at a meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

If you would like to contribute to the documents, please see the Documentation HowTo.

Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-api-site/

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.