diff --git a/doc/source/contributor/check_gates.rst b/doc/source/contributor/check_gates.rst new file mode 100644 index 00000000..1c52b78b --- /dev/null +++ b/doc/source/contributor/check_gates.rst @@ -0,0 +1,117 @@ +How to add a TripleO job to your projects check pipeline +======================================================== + +To ensure a non-TripleO project's changes work with TripleO an additional +check job can be added to the project's job definitions in OpenStack's +`project config `_ + +Project Config Example +---------------------- + +In this case we'll use openstack/neutron as an example to understand how +this works. Note that this is only an example and this job may not be appropriate +for your project, we will cover how to pick a job later on in this documentation. +Browse through the `layout.yaml +`_ +file in the project-config repository until you find:: + + - name: openstack/neutron + template: + - name: merge-check + - ... + - ... + check: + - ... + - ... + - gate-tripleo-ci-centos-7-nonha-multinode-oooq-nv + +The above configuration will run the TripleO job +``gate-tripleo-ci-centos-7-nonha-multinode-oooq-nv`` without voting (nv). +This type of job is used to inform the reviewers of the patch whether or not +the change under review works with TripleO. + + +How to pick which job to execute for any given OpenStack project +---------------------------------------------------------------- + +TripleO can deploy a number of different OpenStack services. To best utilize +the available upstream CI resources TripleO uses the same concept as the +`puppet-openstack-integration project +`_ to define how +services are deployed. The TripleO documentation regarding services can be found +`here. `_ +Review the TripleO documentation and find a scenario that includes the services +that your project requires to be tested. Once you have determined which +scenario to use you are ready to pick a TripleO check job. + +The following is a list of available check jobs:: + + gate-tripleo-ci-centos-7-scenario001-multinode-oooq + gate-tripleo-ci-centos-7-scenario001-multinode-oooq-puppet + gate-tripleo-ci-centos-7-scenario001-multinode-oooq-container + gate-tripleo-ci-centos-7-scenario002-multinode-oooq + gate-tripleo-ci-centos-7-scenario002-multinode-oooq-puppet + gate-tripleo-ci-centos-7-scenario002-multinode-oooq-container + gate-tripleo-ci-centos-7-scenario003-multinode-oooq + gate-tripleo-ci-centos-7-scenario003-multinode-oooq-puppet + gate-tripleo-ci-centos-7-scenario003-multinode-oooq-container + gate-tripleo-ci-centos-7-scenario004-multinode-oooq + gate-tripleo-ci-centos-7-scenario004-multinode-oooq-puppet + gate-tripleo-ci-centos-7-scenario004-multinode-oooq-container + gate-tripleo-ci-centos-7-nonha-multinode-oooq + gate-tripleo-ci-centos-7-containers-multinode + +**Note** over time additional scenarios will be added and will follow the same +pattern as the job names listed above. + +Adding a new non-voting check job +--------------------------------- + +Find your project in `layout.yaml +`_. +An example of a project will look like the following example:: + + - name: openstack/$project + template: + - ... + - ... + +**Note** ``$project`` is the name of your project. + +Under the section named ``check``, add the job that best suits your project. +Be sure to add ``-nv`` to the job name to ensure the job does not vote:: + + check: + - ... + - ... + - $job-nv + +Enabling voting jobs +-------------------- + +If your project is interested in gating your project with a voting version +of a TripleO job, you can follow the openstack/mistral project's example in +`layout.yaml +`_ + +For example:: + + - name: openstack/mistral + template: + -name: merge-check + - ... + - ... + check: + - ... + - ... + - gate-tripleo-ci-centos-7-scenario003-multinode-oooq-puppet + gate: + - gate-tripleo-ci-centos-7-scenario003-multinode-oooq-puppet + +**Note** the example does **not** append ``-nv`` as a suffix to the job name + + + + + + diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 2ee39883..f44d80d5 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -6,3 +6,4 @@ TripleO Contributor Guide :includehidden: contributions + check_gates