doc: Remove description of CI jobs from documentation

This information duplicates what's defined in zuul config files.

This was discussed at the last PTG:
https://etherpad.opendev.org/p/oct2024-ptg-neutron#L149

Change-Id: I5b125451aed1eaa447f8d1ef4036bcf25a6a8ea4
This commit is contained in:
Ihar Hrachyshka 2025-01-09 18:26:48 -05:00
parent da06d1a7d8
commit 7c1853d67d
4 changed files with 65 additions and 182 deletions

View File

@ -0,0 +1,64 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
.. _ci_jobs:
Neutron Jobs Running in Zuul CI
===============================
Different kinds of CI jobs are running against patches proposed for Neutron in
Gerrit. They have different purposes and complexity. Some jobs are more
lightweight (for example, unit tests or linters), while others are more
heavyweight (for example, tempest or grenade jobs).
Mainline Tempest and Grenade jobs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Neutron CI runs a number of tempest and grenade (upgrade) jobs in CI. These
jobs are required to pass to merge a patch.
Periodic and experimental jobs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Due to a significant number of jobs, not all of them are run on every patch.
Some of them are instead executed periodically or on-demand. The periodic jobs
are run on a schedule, while the experimental jobs are run on-demand by making
a ``check experimental`` comment in Gerrit under a patch.
Where to find job definitions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You may inspect the list of jobs defined for the project by either looking
under ``zuul.d/`` in the Neutron repository or by visiting the Zuul web
interface at https://zuul.opendev.org/
Some jobs are not defined in this repository, but in the
`neutron-tempest-plugin
<https://opendev.org/openstack/neutron-tempest-plugin>`_ repository.
Finally, some jobs are defined through templates. Please consult
``zuul.d/project.yaml`` for the list of templates used in the Neutron project.
Alternatively, you may also inspect the list of jobs in a recent patch in
Gerrit comments. (Note that the list executed for a particular patch may be
affected by ``irrelevant-files`` filters. You may consult these in the
``zuul.d/`` configuration files.)

View File

@ -1,177 +0,0 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
.. _ci_jobs:
Neutron Jobs Running in Zuul CI
===============================
Tempest jobs running in Neutron CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In upstream Neutron CI there are various tempest and neutron-tempest-plugin
jobs running. Each of those jobs runs on slightly different configuration of
Neutron services.
Below is a summary of those jobs.
::
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
| Job name | Run tests | nodes | Operating system | L2 agent | firewall | L3 agent | L3 HA | L3 DVR | enable_dvr | Run in gate |
| | | | | driver | mode | | | | | queue |
+==============================================+==================================+=======+==================+==============+================+==========+=======+========+============+=============+
|neutron-tempest-plugin-designate-scenario |neutron_tempest_plugin.scenario.\ | 1 | Ubuntu Jammy | openvswitch | openvswitch | legacy | False | False | True | No |
| |test_dns_integration | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-tempest-plugin-linuxbridge |neutron_tempest_plugin.api | 1 | Ubuntu Jammy | linuxbridge | iptables | ha | False | False | False | Yes |
| |neutron_tempest_plugin.scenario | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_attach_interfaces | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_multiple_create | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-tempest-plugin-openvswitch |neutron_tempest_plugin.api | 1 | Ubuntu Jammy | openvswitch | openvswitch | ha | False | False | False | Yes |
| |neutron_tempest_plugin.scenario | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_attach_interfaces | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_multiple_create | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-tempest-plugin-openvswitch-\ |neutron_tempest_plugin.api | 1 | Ubuntu Jammy | openvswitch | iptables_hybrid | ha | False | False | False | Yes |
| iptables_hybrid |neutron_tempest_plugin.scenario | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_attach_interfaces | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_multiple_create | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-tempest-plugin-scenario-ovn | neutron_tempest_plugin.scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | False | False | False | Yes |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_attach_interfaces | | | | | | | | | |
| |tempest.api.compute.servers.\ | | | | | | | | | |
| | test_multiple_create | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovs-tempest-multinode-full |tempest.api (without slow tests) | 2 | Ubuntu Jammy | openvswitch | openvswitch | legacy | False | False | True | Yes |
| |tempest.scenario | | | | | | | | | |
| |(only tests related to | | | | | | | | | |
| |Neutron and Nova) | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovs-tempest-dvr-ha-multinode-full |tempest.api (without slow tests) | 3 | Ubuntu Jammy | openvswitch | openvswitch | dvr_snat | True | True | True | No |
|(non-voting) |tempest.scenario | | | | | dvr | | | | |
| | | | | | | dvr | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovs-tempest-slow |tempest slow tests | 2 | Ubuntu Jammy | openvswitch | openvswitch | legacy | False | False | True | Yes |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|tempest-integrated-networking |tempest.api (without slow tests) | 1 | Ubuntu Jammy | ovn | ovn | --- | False | False | True | Yes |
| |tempest.scenario | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-ipv6-only-ovs-release |tempest.api (without slow tests) | 1 | Ubuntu Jammy | ovn | ovn | --- | False | False | True | Yes |
| |(only tests related to | | | | | | | | | |
| |Neutron and Nova) | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
Grenade jobs running in Neutron CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In upstream Neutron CI there are various Grenade jobs running.
Each of those jobs runs on slightly different configuration of Neutron
services.
Below is summary of those jobs.
::
+------------------------------------+-------+------------------+-------------+-------------+----------+-------+--------+------------+-------------+
| Job name | nodes | Operating system | L2 agent | firewall | L3 agent | L3 HA | L3 DVR | enable_dvr | Run in gate |
| | | | | driver | mode | | | | queue |
+====================================+=======+==================+=============+=============+==========+=======+========+============+=============+
| neutron-ovs-grenade-multinode | 2 | Ubuntu Jammy | openvswitch | openvswitch | legacy | False | False | True | Yes |
+------------------------------------+-------+------------------+-------------+-------------+----------+-------+--------+------------+-------------+
| neutron-ovn-grenade-multinode | 2 | Ubuntu Jammy | OVN | --- | --- | --- | --- | False | Yes |
+------------------------------------+-------+------------------+-------------+-------------+----------+-------+--------+------------+-------------+
Tempest jobs running in Neutron experimental CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In upstream Neutron CI there is also queue called ``experimental``. It includes
jobs which are not needed to be run on every patch and/or jobs which isn't
stable enough to be run always.
Those jobs can be run by making comment ``check experimental`` in the comment
to the patch in Gerrit.
Currently we have in that queue jobs like listed below.
::
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
| Job name | Run tests | nodes | Operating system | L2 agent | firewall | L3 agent | L3 HA | L3 DVR | enable_dvr | Run in gate |
| | | | | | driver | mode | | | | queue |
+==============================================+==================================+=======+==================+=============+=================+==========+=======+========+============+=============+
|neutron-ovn-tempest-loki |tempest.api (without slow tests) | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
|(non-voting) |tempest.scenario | | | | | | | | | |
| |(only tests related to | | | | | | | | | |
| |Neutron and Nova) | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-full-multinode-ovs-master |Various tempest api and scenario | 2 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |tests | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-full-multinode-ovs-lts |Various tempest api and scenario | 2 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |tests using latest OVS and OVN | | | | | | | | | |
| |LTS branches | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-ovs-master |Various tempest api and scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |tests | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-ovs-lts |Various tempest api and scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |tests using latest OVS and OVN | | | | | | | | | |
| |LTS branches | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-plugin-ovs-master |Various tempest api, scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |and neutron_tempest_plugin tests | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-plugin-ovs-lts |Various tempest api, scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |and neutron_tempest_plugin | | | | | | | | | |
| |test using latest OVS and OVN LTS | | | | | | | | | |
| |branches | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-with-neutron-lib-master |Various tempest api and scenario | 1 | Ubuntu Jammy | ovn | ovn | --- | --- | --- | --- | No |
| |tests using main neutron-lib | | | | | | | | | |
| |branch | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
|neutron-ovn-tempest-ipv6-only-ovs-master |tempest.api (without slow tests) | 1 | Ubuntu Jammy | ovn | ovn | --- | False | False | True | Yes |
| |(only tests related to | | | | | | | | | |
| |Neutron and Nova) | | | | | | | | | |
+----------------------------------------------+----------------------------------+-------+------------------+-------------+-----------------+----------+-------+--------+------------+-------------+
And we also have Grenade jobs in the periodic queue.
::
+------------------------------------+-------+------------------+-------------+-------------+----------+--------+------------+------------+-------------+
| Job name | nodes | Operating system | L2 agent | firewall | L3 agent | L3 HA | L3 DVR | enable_dvr | Run in gate |
| | | | | driver | mode | | | | queue |
+====================================+=======+=============+==================+=============+==========+========+============+============+=============+
| neutron-ovs-grenade-dvr-multinode | 2 | Ubuntu Jammy | openvswitch | openvswitch | dvr | False | False | True | No |
| | | | | | dvr_snat | | | | |
+------------------------------------+-------+------------------+-------------+-------------+----------+--------+------------+------------+-------------+
Columns description
* L2 agent - agent used on nodes in test job,
* firewall driver - driver configured in L2 agent's config,
* L3 agent mode - mode(s) configured for L3 agent(s) on test nodes,
* L3 HA - value of ``l3_ha`` option set in ``neutron.conf``,
* L3 DVR - value of ``router_distributed`` option set in ``neutron.conf``,
* enable_dvr - value of ``enable_dvr`` option set in ``neutron.conf``

View File

@ -33,7 +33,7 @@ Testing
testing
fullstack
ml2_ovs_devstack
ci_scenario_jobs
ci_jobs
ml2_ovn_devstack
tempest
template_model_sync_test

View File

@ -1,7 +1,3 @@
# NOTE: In doc/source/contributor/testing/ci_scenario_jobs.rst file there is
# document with summary of all tempest, neutron-tempest-plugin and grenade jobs
# summary.
# Please update this document always when any changes to jobs are made.
- project:
templates:
- neutron-tempest-plugin-jobs