CI documentation

- Jobs description: Help people understand what each job does in our CI.

Change-Id: Ia6267e9b4618d4039f0606270f8dcf759cd92750
This commit is contained in:
Iury Gregory Melo Ferreira 2019-08-01 12:09:30 +02:00
parent 9a62401fb7
commit 503cba28ba
2 changed files with 56 additions and 0 deletions

View File

@ -9,3 +9,14 @@ Python API
:maxdepth: 1
api/autoindex
Ironic Inspector CI
~~~~~~~~~~~~~~~~~~~
It's important to understand the role of each job in the CI. To facilitate
that, we have created the documentation below.
.. toctree::
:maxdepth: 1
Job roles in the CI <jobs-description>

View File

@ -0,0 +1,45 @@
.. _jobs-description:
================
Jobs description
================
The description of each jobs that runs in the CI when you submit a patch for
`openstack/ironic-inspector` is shown in the following table.
.. note::
All jobs are configured to use a pre-build tinyipa ramdisk, a wholedisk
image that is downloaded from a Swift temporary url, `pxe` boot and
`ipmi` driver.
.. list-table:: Table. OpenStack Ironic Inspector CI jobs description
:widths: 45 55
:header-rows: 1
* - Job name
- Description
* - ironic-inspector-grenade-dsvm
- Deploys Ironic and Ironic Inspector in DevStack and runs upgrade for
all enabled services.
* - ironic-inspector-tempest
- Deploys Ironic and Ironic Inspector in DevStack.
Runs tempest tests that match the regex `InspectorBasicTest` and
deploys 1 virtual baremetal.
* - ironic-inspector-tempest-discovery
- Deploys Ironic and Ironic Inspector in DevStack.
Runs tempest tests that match the regex `InspectorDiscoveryTest` and
deploys 1 virtual baremetal.
* - ironic-inspector-tempest-python3
- Deploys Ironic and Ironic Inspector in DevStack under Python3.
Runs tempest tests that match the regex `Inspector` and deploys 1
virtual baremetal.
* - openstack-tox-functional
- Run tox-based functional tests for Ironic Inspector under Python2
* - openstack-tox-functional-py36
- Run tox-based functional tests for Ironic Inspector under Python3.6
* - bifrost-integration-tinyipa-ubuntu-xenial
- Tests the integration between Ironic Inspector and Bifrost.
* - ironic-inspector-tox-bandit
- Runs bandit security tests in a tox environment to find known issues in
the Ironic Inspector code.