From 7449773e3bff3be6a8c6cc8024658c91458bcb49 Mon Sep 17 00:00:00 2001
From: Marcin Juszkiewicz <marcin.juszkiewicz@linaro.org>
Date: Mon, 15 Feb 2021 11:16:57 +0100
Subject: [PATCH] doc: describe 'allowed-to-fail' option

Change-Id: Ia32e44a13c0280767082f11f730c8a54f9bb25c5
---
 doc/source/contributor/ci.rst    | 27 +++++++++++++++++++++++++++
 doc/source/contributor/index.rst |  1 +
 2 files changed, 28 insertions(+)
 create mode 100644 doc/source/contributor/ci.rst

diff --git a/doc/source/contributor/ci.rst b/doc/source/contributor/ci.rst
new file mode 100644
index 0000000000..2ed0b821be
--- /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 f2a05eafd2..bec5820495 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