Metadata-Version: 1.1
Name: ceph-workbench
Version: 1.5.9
Summary: a command-line toolbox for Ceph
Home-page: http://ceph-workbench.dachary.org/root/ceph-workbench
Author: Loic Dachary
Author-email: loic@dachary.org
License: UNKNOWN
Description: ceph-workbench
        ==============
        
        ceph-workbench is a command-line toolbox for `Ceph <http://ceph.com>`_
        
        Documentation : http://ceph-workbench.readthedocs.org/
        Home page : https://pypi.python.org/pypi/ceph-workbench
        
        Installation
        ============
        
        * Install Docker http://docs.docker.com/engine/installation/
        
        * Copy the following shell function to ~/.bashrc::
        
            function ceph-workbench() {
               mkdir -p $HOME/.ceph-workbench
               sudo docker run --rm -ti \
                   -v $HOME/.ceph-workbench:/opt/.ceph-workbench \
                   -v /var/run/docker.sock:/run/docker.sock \
                   -v $(which docker):/bin/docker \
                   $(w=$(git rev-parse --show-toplevel 2>/dev/null) && echo "-v $w:$w -w $w") \
                   --env USER_ID=$(id -u) --env USER_NAME=$(id -un) \
                   dachary/ceph-workbench \
                   ceph-workbench "$@"
            }
        
        * Verify that it works::
        
            ceph-workbench --help
        
        * Optionally copy the OpenStack openrc.sh file in
          ~/.ceph-workbench/openrc.sh: the ``ceph-qa-suite`` subcommand will
          use it
        
        Hacking
        =======
        
        * Get the code : git clone --recursive http://ceph-workbench.dachary.org/root/ceph-workbench.git
        
        * Set up the development environment::
        
           deactivate || true ; source bootstrap
        
          This creates a virtualenv containing the :code:`ceph-workbench`
          executable and everything it needs to work.
        
        * Activate the development environment and run :code:`ceph-workbench`::
        
           source virtualenv/bin/activate
           PYTHONPATH=teuthology ceph-workbench --help
        
        * Run the tests (requires OpenStack credentials to get 100% coverage)::
        
           deactivate || true ; bash run-tests.sh
        
        * Sync the teuthology submodule::
        
           git submodule update --remote teuthology
        
        * Run a single test::
        
           tox -e py27 -- -s -k test_run tests/test_ceph_qa_suite.py
        
        * Run ceph-workbench using the dev environment of the current working
          directory in the docker container instead of the installed version::
        
           function cw() { docker run --rm --volume=$HOME:$HOME -v $HOME/.ceph-workbench:/opt/.ceph-workbench -v /var/run/docker.sock:/run/docker.sock -v $(which docker):/bin/docker -v $(pwd):$(pwd) -w $(pwd) --env USER_ID=$(id -u) --env USER_NAME=$(id -un) -ti dachary/ceph-workbench env PYTHONPATH=$(pwd)/teuthology:$(pwd) virtualenv/bin/ceph-workbench "$@"; }
        
        * Get a shell in the dev environment of the current working directory
          in the docker container::
        
           function cw-sh() { docker run --rm --volume=$HOME:$HOME -v $HOME/.ceph-workbench:/opt/.ceph-workbench -v /var/run/docker.sock:/run/docker.sock -v $(which docker):/bin/docker -v $(pwd):$(pwd) -w $(pwd) --env USER_ID=$(id -u) --env USER_NAME=$(id -un) -ti dachary/ceph-workbench env PYTHONPATH=$(pwd)/teuthology:$(pwd) bash "$@"; }
        
        * 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 setup.py 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 setup.py sdist upload --sign
         - git push ; git push --tags
         - docker rmi dachary/ceph-workbench
         - docker build --no-cache --tag dachary/ceph-workbench docker
         - docker login
         - docker push dachary/ceph-workbench:1.5.7
         - docker push dachary/ceph-workbench
        
        * pypi maintenance
        
         - python setup.py register # if the project does not yet exist
         - trim old versions at https://pypi.python.org/pypi/ceph-workbench
        
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
