c12s-kubespray/docs/ci-setup.md

# 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.

## CI Variables

In CI we have a set of overrides we use to ensure greater success of our CI jobs and avoid throttling by various APIs we depend on. See:

- [Docker mirrors](/tests/common/_docker_hub_registry_mirror.yml)
- [Test settings](/tests/common/_kubespray_test_settings.yml)
Add docs about CI setup (#6397) 2020-08-20 11:37:23 +00:00			`# 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.
Various documentation updates (#8243) * Docs: update CONTRIBUTING.md * Docs: clean up outdated roadmap and point to github issues instead * Docs: update note on kubelet_cgroup_driver * Docs: update kata containers docs with note about cgroup driver * Docs: note about CI specific overrides 2021-11-29 23:05:21 +00:00
			`## CI Variables`

			`In CI we have a set of overrides we use to ensure greater success of our CI jobs and avoid throttling by various APIs we depend on. See:`

			`- [Docker mirrors](/tests/common/_docker_hub_registry_mirror.yml)`
			`- [Test settings](/tests/common/_kubespray_test_settings.yml)`