Skip to main content

a command-line toolbox for Ceph

Project description


ceph-workbench is a command-line toolbox for Ceph

Documentation : Home page :


  • Install Docker

  • Copy the following to ~/.bashrc:

    eval "$(docker run dachary/ceph-workbench install)"
  • Verify that it works:

    ceph-workbench --help
  • Optionally copy your OpenStack $ file to ~/.ceph-workbench/ the ceph-qa-suite subcommand will use it.


For best results, develop in Ubuntu 14.04 as a normal user (not root).

  • Get the code:

    git clone --recursive
  • Set up the development environment:

    deactivate || true ; source bootstrap

    This creates a virtualenv containing the ceph-workbench executable and everything it needs to work.

  • Activate the development environment and run ceph-workbench:

    source virtualenv/bin/activate
    PYTHONPATH=teuthology ceph-workbench --help
  • Run the tests (requires OpenStack credentials to get 100% coverage):

    deactivate || true ; bash
  • Sync the teuthology submodule:

    git submodule update --remote teuthology
  • Run a single test:

    tox -e py27 -- -s -k test_run tests/
  • Run ceph-workbench using the dev environment of the current working directory in the docker container instead of the installed version:

    eval "$(docker/ install)"
    ceph-workbench --help # use what is installed in the container
    ceph-workbench-debug --help # use ceph-workbench from the working directory
    ceph-workbench-shell bash # login the container and debug
  • Check the documentation : rst2html < README.rst > /tmp/a.html

Release management

  • Prepare a new version
  • version=1.3.0 ; perl -pi -e “s/^version.*/version = $version/” setup.cfg ; for i in 1 2 ; do python sdist ; amend=$(git log -1 –oneline | grep –quiet “version $version” && echo –amend) ; git commit $amend -m “version $version” ChangeLog setup.cfg ; git tag -a -f -m “version $version” $version ; done
  • Publish a new version
  • python sdist upload –sign
  • git push ; git push –tags
  • docker rmi dachary/ceph-workbench
  • docker build –no-cache –tag dachary/ceph-workbench docker
  • docker build –tag dachary/ceph-workbench:1.5.9 docker
  • docker login
  • docker push dachary/ceph-workbench
  • docker push dachary/ceph-workbench:1.5.9
  • pypi maintenance

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ceph-workbench-1.5.19.tar.gz (107.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page