From 85646c96adf87881e6b7249b1aa37d059875f450 Mon Sep 17 00:00:00 2001
From: Maxime Guyot <Miouge1@users.noreply.github.com>
Date: Thu, 20 Aug 2020 13:37:23 +0200
Subject: [PATCH] Add docs about CI setup (#6397)

---
 docs/_sidebar.md |  1 +
 docs/ci-setup.md | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 docs/ci-setup.md

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index fb5374fdb..cde5247d9 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -41,4 +41,5 @@
   * [Test cases](docs/test_cases.md)
   * [Vagrant](docs/vagrant.md)
   * [CI Matrix](docs/ci.md)
+  * [CI Setup](docs/ci-setup.md)
 * [Roadmap](docs/roadmap.md)
diff --git a/docs/ci-setup.md b/docs/ci-setup.md
new file mode 100644
index 000000000..36d512f04
--- /dev/null
+++ b/docs/ci-setup.md
@@ -0,0 +1,20 @@
+# CI Setup
+
+## Pipeline
+
+1. unit-tests: fast jobs for fast feedback (linting, etc...)
+2. deploy-part1: small number of jobs to test if the PR works with default settings
+3. deploy-part2: slow jobs testing different platforms, OS, settings, CNI, etc...
+4. deploy-part3: very slow jobs (upgrades, etc...)
+
+## Runners
+
+Kubespray has 3 types of GitLab runners:
+
+- packet runners: used for E2E jobs (usually long)
+- light runners: used for short lived jobs
+- auto scaling runners: used for on-demand resources, see [GitLab docs](https://docs.gitlab.com/runner/configuration/autoscale.html) for more info
+
+## Vagrant
+
+Vagrant jobs are using the [quay.io/kubespray/vagrant](/test-infra/vagrant-docker/Dockerfile) docker image with `/var/run/libvirt/libvirt-sock` exposed from the host, allowing the container to boot VMs on the host.