openstack/trove
Code Issues Proposed changes
OpenStack Database As A Service (Trove)
1,257 Commits 10 Branches 52 Tags 114 MiB
Python 95%
Shell 4.9%
294330c554
Go to file
Tim Simpson 294330c554 Moved the apidocs from openstack/database-api 
By hosting the docs here we'll be able to better maintain that
developers are being mindful of changes or even occassionally writing
documentation for new API features. This should also allow us to
autogenerate the snippets.

Change-Id: I0111bcd38341b1736a47b0a3d3e6ff96d2ca1c58
2014-04-24 14:41:40 -05:00
apidocs Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05: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 Merge "fix default rabbitmq configuration values in sample cfgs" 2014-04-15 02:43:10 +00:00
rsdns Remove extraneous vim configuration comments 2014-02-27 15:05:21 +08:00
tools rename and fix the db_wipe command 2014-03-10 10:16:03 +01:00
trove Merge "Removes volumes redefinition in fake nova_client" 2014-04-08 07:31:18 +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
babel.cfg Setup trove for translation 2014-03-19 15:06:23 +01:00
doc-test.conf Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05: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
openstack-common.conf Mask database user's password in trove logs 2014-01-21 12:18:27 -08:00
README.rst Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05:00
requirements.txt Trove doesn't use extras 2014-04-10 19:28:33 +02: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 Update from global requirements 2013-09-30 11:43:42 -04:00
test-requirements.txt Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05:00
tox.ini Moved the apidocs from openstack/database-api 2014-04-24 14:41:40 -05: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.