Working with the Source

Setting up a Development Sandbox

  1. Set up a server or virtual machine to run OpenStack using devstack.
  1. Clone the ceilometer project to the machine:

    $ cd /opt/stack
    $ git clone https://github.com/openstack/ceilometer.git
    $ cd ./ceilometer
  2. Once this is done, you need to setup the review process:

    $ git remote add gerrit ssh://<username>@review.openstack.org:29418/openstack/ceilometer.git
  3. If you are preparing a patch, create a topic branch and switch to it before making any changes:

    $ git checkout -b TOPIC-BRANCH

Running the Tests

Ceiloemter includes an extensive set of automated unit tests which are run through tox.

  1. Install tox:

    $ sudo pip install tox
  2. Install the test dependencies:

    $ sudo pip install -r /opt/stack/ceilometer/tools/test-requires
  3. Run the unit and code-style tests:

    $ cd /opt/stack/ceilometer
    $ tox -e py27,pep8

See also

Code Reviews

Ceilometer uses the OpenStack review process for all code and developer documentation contributions. Code reviews are managed through gerrit.

Table Of Contents

Previous topic

Areas to Contribute

Next topic

Writing Agent Plugins

This Page