openstack
/
tripleo-ci
Code Issues Proposed changes

Add more documentation of how tripleo-ci works 

A brief section describing the flow through the tripleo-ci scripts
and documentation of the temprevert, cherry-pick, and pin
functions for modifying git repos during a ci run.

Change-Id: Id020855064afb725a8a56ec91707e2c3d3618902
This commit is contained in:
Ben Nemec 2017-01-30 18:32:21 +00:00
parent 962586c228
commit 6ed8fda261
1 changed files with 64 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.rst
View File

@ -24,6 +24,70 @@ OpenStack services are balanced between different scenarios because OpenStack
Infastructure Jenkins slaves can not afford the load of running everything on
the same node.
Usage Details
-------------
Job parameters are configured in ``toci_gate_test.sh``. Control passes to
one of the ``toci_instack_*.sh`` scripts (depending on the type of job being
run) which do environment-specific setup. These scripts then call
``scripts/deploy.sh`` to run the actual deployment steps. For most things,
``deploy.sh`` simply calls ``scripts/tripleo.sh`` with the appropriate
parameters.
In ascii art, the flow of the scripts would look like:
toci_gate_test -> toci_instack_* -> deploy.sh -> tripleo.sh
There's some additional complexity that this description glosses over, but
for the most part only tripleo-ci admins need to worry about it.
temprevert, cherry-pick, pin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are three functions available in tripleo-ci which can be used to alter
the git repos of non-tripleo projects that are used in tripleo-ci. They only
work on projects that are part of OpenStack. Use of these should
be avoided whenever possible as any changes made during a ci run will not
apply to regular users of TripleO. However, they can be useful for determining
which commit broke something, and in rare cases we may want to use them
until a project can sort out a problem itself.
To apply one of these functions during a ci run, add it to the appropriate
location in the ``toci_instack_*.sh`` script. There should be a comment that
says "Tempreverts/cherry-picks/pins go here."
.. note:: Do not include the bug number in the commit message where you
propose adding one of these functions. Any change whose commit
message includes a reference to the bug will not apply the function.
This is to allow testing of patches intended to fix the bug.
.. warning:: As of this writing, these functions all apply against the latest
master branch of the project in question. They do not respect
the current-tripleo repo versions.
* temprevert
Revert a commit from a project. Takes 3 parameters: project, commit id,
and bug number. Example::
temprevert neutron 2ad9c679ed8718633732da1e97307f9fd9647dcc 1654032
* pin
Pin to a commit from a project. This usually is not necessary now that our
repos are gated by the promotion jobs. Takes 3 parameters: project,
commit id, and bug number. Example::
pin neutron 2ad9c679ed8718633732da1e97307f9fd9647dcc 1654032
* cherrypick
Cherry-pick an active review from a project. Takes 3 parameters: project,
Gerrit refspec, and bug number. The Gerrit refspec can be found under the
download button of the change in question. Example::
cherrypick neutron refs/changes/49/317949/28 1654032
Service testing matrix
----------------------