Ceph » Stable releases

h3. Scheduling a suite

This requires access to a running teuthology cluster, for instance the cluster from the sepia lab (with Sepia VPN running, you can do something like <code>ssh teuthology.front.sepia.ceph.com</code> ).

* git clone https://github.com/ceph/teuthology/

* cd teuthology

* ./bootstrap

* Test the suite with *--dry-run*, i.e. something like:

<pre>

./virtualenv/bin/teuthology-suite --dry-run --priority 1000 --subset 1/18 --suite rados --suite-branch giant --machine-type plana,burnupi,mira --distro ubuntu --email loic@dachary.org --ceph giant

</pre>

* Review the jobs to be scheduled and if it matches what is expected, run the same command without the *--dry-run*

* Assuming the suite was run on the sepia lab, it will immediately show up at http://pulpito.ceph.com/ (for instance http://pulpito.ceph.com/loic-2015-03-27_09:57:09-upgrade:firefly-x:stress-split-erasure-code-hammer---basic-multi/). Note the *loic-2015-03-27_09:57:09-upgrade:firefly-x:stress-split-erasure-code-hammer---basic-multi* part of the path: it matches the run name displayed by teuthology-suite

The meaning of the teuthology-suite arguments are:

* *--suite*  a reference to https://github.com/ceph/ceph-qa-suite/tree/master/suites. For instance --suite rados means run all jobs at https://github.com/ceph/ceph-qa-suite/tree/master/suites/rados

* *--suite-branch* a reference to the ceph-qa-suite branch to use. For instance --suite rados --suite-branch giant means run all jobs at https://github.com/ceph/ceph-qa-suite/tree/giant/suites/rados instead of https://github.com/ceph/ceph-qa-suite/tree/master/suites/rados

* *--priority* is the the priority of the job in the queue (lower numbers are higher priority). By default it is 1000 and if nothing is urgent it should be used. If in the process of debugging a single job that fails, the priority 101 can be used so that it is scheduled faster.

* *--machine-type* is the kind of machine that will be provisionned to run the tests. Use *plana,burnupi,mira* for bare metal or *vps* for virtual machines.

* *--ceph* is the branch of the Ceph repository to use and defaults to master. For instance --ceph giant means use https://github.com/ceph/ceph/tree/giant/ instead of https://github.com/ceph/ceph/tree/master/

* *--email* when the run is complete an email will be sent to this address with a summary of the results.

* *--subset X/N* will reduce the number of jobs to *1/N* of the total number of jobs, as long as it includes all yaml (facets). For instance, in a given "rados suite":https://github.com/ceph/ceph-qa-suite/tree/master/suites/rados *--subset 0/18* will always create the same jobs. By running *0/18*, then *1/18*, etc. up to *17/18* all jobs are generated. It is a good idea to not always pick the same subset to get various combinations and increase the odds of discovering a problem. As of may 2015, it is recommended to use X/18 for rados which is by far the largest suite (3000+ jobs). Since all other suites are smaller, X/18 is also a good choice for all of them.

h3. Using the *--subset* option

The goal of integration tests is to verify a set of commits won't create problems that could be easily detected by running the teuthology suites. If the *--subset* is not used, the tests being run will be the same as if *--subset* is used, only combined differently. Running all combinations of tests is useful to detect subtle bugs, but it's not the focus of the integration tests. It is therefore advisable to always use the *--subset* option, regardless of the suite being run, to reduce the number of tests being scheduled and speed up their completion.

Note that as of August 2016, it was agreed with Samuel Just (rados lead) that we will use <code>--subset $(expr $RANDOM % 20)/20</code> for all rados integration testing runs.

h3. Re-scheduling failed or dead jobs from an existing suite

* Ask https://github.com/ceph/paddles (the server in which suite runs are stored) about the *dead* or *fail* jobs

<pre>

run=loic-2015-03-23_01:09:31-rados-giant---basic-multi

eval filter=$(curl --silent http://paddles.front.sepia.ceph.com/runs/$run/ | jq '.jobs[] | select(.status == "dead" or .status == "fail") | .description' | while read description ; do echo -n $description, ; done | sed -e 's/,$//')

</pre>

* Re-run the suite using the same command line without *--filter-out* and with *--filter="$filter"* to only schedule the jobs described in the *fitler* variable

<pre>

./virtualenv/bin/teuthology-suite --filter="$filter" --priority 1000 --suite rados --suite-branch giant --machine-type plana,burnupi,mira --distro ubuntu --email loic@dachary.org --ceph giant

</pre>

h3. Scheduling jobs missed in an existing suite.

In case some network problem occurs when you're scheduling a large suite, instead of killing and rescheduling the entire suite, only the missed jobs can be scheduled as

<pre>

run=http://pulpito.ceph.com/abhi-2015-06-20_09:01:42-rados-hammer-backports---basic-multi/

eval filter=$(curl --silent http://paddles.front.sepia.ceph.com/runs/$run/ | jq '.jobs[] | .description' | while read description ; do echo -n $description, ; done | sed -e 's/,$//')

./virtualenv/bin/teuthology-suite --filter-out="$filter" --priority 1000 --suite rados --suite-branch giant --machine-type plana,burnupi,mira --distro ubuntu --email loic@dachary.org --ceph giant

</pre>

h3. Killing a suite

* if the run is scheduled but did not start yet:

** if the suite was scheduled with *--machine-type plana,burnupi,mira*:

<pre>

./virtualenv/bin/teuthology-kill -m multi -r loic-2015-03-27_09:57:09-upgrade:firefly-x:stress-split-erasure-code-hammer 

</pre>

** if the suite was scheduled with *--machine-type vps*

<pre>

./virtualenv/bin/teuthology-kill -m vps -r loic-2015-03-27_09:57:09-upgrade:firefly-x:stress-split-erasure-code-hammer

</pre>

* if the run already started the *-m* option is not necessary

<pre>

./virtualenv/bin/teuthology-kill -r loic-2015-03-27_09:57:09-upgrade:firefly-x:stress-split-erasure-code-hammer

</pre>

*NOTE:* allow some time for the operation to complete.

h3. Integration suites

Expected to be successfully run on the integration branch before "asking approval to the leads":http://ceph.com/docs/master/dev/development-workflow/#resolving-bug-reports-and-implementing-features (hence before asking QE to tests further)

"rados":https://github.com/ceph/ceph-qa-suite/tree/master/suites/rados

"rgw":https://github.com/ceph/ceph-qa-suite/tree/master/suites/rgw

"rbd":https://github.com/ceph/ceph-qa-suite/tree/master/suites/rbd

"fs":https://github.com/ceph/ceph-qa-suite/tree/master/suites/fs

"upgrade":https://github.com/ceph/ceph-qa-suite/tree/master/suites/upgrade/hammer-x (with vps to cover all supported operating systems)

"powercycle":https://github.com/ceph/ceph-qa-suite/tree/master/suites/powercycle (only run 2 for the sake of verifying the code path for obvious mistakes)

"ceph-deploy":https://github.com/ceph/ceph-qa-suite/tree/master/suites/ceph-deploy (to verify packaging because it uses packages to install ceph)

h3. QE suites

Expected to be successfully run on the release branch before "passing it to the person publishing the release":http://ceph.com/docs/master/dev/development-workflow/#cutting-a-new-stable-release.

h4. dumpling

rados

rbd

rgw

fs

ceph-deploy

upgrade/dumpling

h4. firefly

rados

rbd

rgw

fs

krbd

kcephfs

samba

ceph-deploy

upgrade/firefly

upgrade/dumpling-firefly-x (to giant)

powercycle 

h4. giant

rados

rbd

rgw

fs

krbd

kcephfs

knfs

haddop

samba

rest

multimds

multi-version

upgrade/giant

powecycle