aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2021-02-19 15:48:53 +0000
committerGerrit Code Review <review@openstack.org>2021-02-19 15:48:53 +0000
commite9c11009f5f91f12711605d30e6562419fce1e06 (patch)
tree2bfc34ab4ed651fc48a8e590c2aaba9de6f5fb91
parentb4d6ffaf5799c3c72a2ecfa3f08c6ae9ccf21df0 (diff)
parent7449773e3bff3be6a8c6cc8024658c91458bcb49 (diff)
downloadkolla-e9c11009f5f91f12711605d30e6562419fce1e06.tar.gz
kolla-e9c11009f5f91f12711605d30e6562419fce1e06.zip
Merge "doc: describe 'allowed-to-fail' option"
-rw-r--r--doc/source/contributor/ci.rst27
-rw-r--r--doc/source/contributor/index.rst1
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/contributor/ci.rst b/doc/source/contributor/ci.rst
new file mode 100644
index 000000000..2ed0b821b
--- /dev/null
+++ b/doc/source/contributor/ci.rst
@@ -0,0 +1,27 @@
+======================
+Continuous Integration
+======================
+
+To make sure that changes do not break Kolla we use Continuous Integration (CI
+in short) on Opendev Zuul platform.
+
+Distribution, architecture, build type coverage
+===============================================
+
+There are several builds running on CI. We cover each supported distribution on
+x86-64 architecture and Debian/source builds on AArch64.
+
+Allowed to fail
+===============
+
+During Wallaby cycle we added support for 'allowed to fail' images.
+
+The ``allowed-to-fail`` option in ``kolla-build.conf`` file (generated by
+``tests/playbooks/run.yml`` lists images which are allowed to fail during CI
+build without bringing whole build down.
+
+Main use will be situation when we need to wait for other projects to fix
+problems blocking build of image.
+
+.. note::
+ This is meant to be used on CI in emergency situation.
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
index f2a05eafd..bec582049 100644
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@@ -20,3 +20,4 @@ We welcome everyone to join our project!
bug-triage
ptl-guide
release-management
+ ci