From: Zack Cerza Date: Fri, 24 Oct 2014 19:04:02 +0000 (-0600) Subject: Add "Provided utilities" section X-Git-Tag: 1.1.0~1110 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=0f9026dfd8911e2a08c7d686bd1c5c74246072ca;p=teuthology.git Add "Provided utilities" section Signed-off-by: Zack Cerza --- diff --git a/README.rst b/README.rst index 08393f662..54da1f96e 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -================================================== - `Teuthology` -- The Ceph integration test runner -================================================== +=================================================== +`Teuthology` -- The Ceph integration test framework +=================================================== ``teuthology`` is an automation framework for `Ceph `__, written in `Python @@ -24,6 +24,23 @@ operations on remote hosts over SSH, as implemented by `Paramiko When testing, it is common to group many `jobs` together to form a `test run`. +Provided Utilities +================== +* ``teuthology`` - Run individual jobs +* ``teuthology-coverage`` - Analyze code coverage via lcov +* ``teuthology-kill`` - Kill running jobs or entire runs +* ``teuthology-lock`` - Lock, unlock, and update status of machines +* ``teuthology-ls`` - List job results by examining an archive directory +* ``teuthology-nuke`` - Attempt to return a machine to a pristine state +* ``teuthology-queue`` - List, or delete, jobs in the queue +* ``teuthology-report`` - Submit test results to a web service (we use `paddles `__) +* ``teuthology-results`` - Examing a finished run and email results +* ``teuthology-schedule`` - Schedule a single job +* ``teuthology-suite`` - Schedule a full run based on a suite (see `suites` in `ceph-qa-suite `__) +* ``teuthology-updatekeys`` - Update SSH host keys for a mchine +* ``teuthology-worker`` - Worker daemon to monitor the queue and execute jobs + + Build ===== Teuthology is not meant to be distributed as a library, therefore we depend