Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc fixes #165

Merged
merged 2 commits into from
May 27, 2019
Merged

Doc fixes #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f74b0d9
docs: Fix formatting
jodh-intel May 24, 2019
bbe9666
docs: Add missing TOCs and missing TOC entries
jodh-intel May 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 20 additions & 19 deletions Jenkins_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
* [Kata Containers Jenkins CI setup](#kata-containers-jenkins-ci-setup)
* [Types of jobs](#types-of-jobs)
* [PR builds](#pr-builds)
* [Master builds](#master-builds)
* [GitHub bandwidth and tokens](#github-bandwidth-and-tokens)
* [Job build script](#job-build-script)
* [Setting up Jenkins](#setting-up-jenkins)
* [Naming jobs](#naming-jobs)
* [Setting up the scripts](#setting-up-the-scripts)
* [Environment variables](#environment-variables)
* [Input variables](#input-variables)
* [Output variables](#output-variables)
* [Experienced users](#experienced-users)
* [Other CIs](#other-cis)
* [Types of jobs](#types-of-jobs)
* [PR builds](#pr-builds)
* [Master builds](#master-builds)
* [GitHub bandwidth and tokens](#github-bandwidth-and-tokens)
* [Job build script](#job-build-script)
* [Setting up Jenkins](#setting-up-jenkins)
* [Installing Plugins](#installing-plugins)
* [Naming jobs](#naming-jobs)
* [Setting up the scripts](#setting-up-the-scripts)
* [Environment variables](#environment-variables)
* [Input variables](#input-variables)
* [Output variables](#output-variables)
* [Experienced users](#experienced-users)
* [Other CIs](#other-cis)

# Kata Containers Jenkins CI setup

Expand All @@ -21,7 +22,7 @@ Kata Containers Jenkins CI system.

## Types of jobs

The Kata Containers Jenkins CI system uses Jenkins 'Freestyle Project' build jobs
The Kata Containers Jenkins CI system uses Jenkins "Freestyle Project" build jobs
to perform its builds. Kata Containers CI operates two types of CI builds:

- [PR builds](#pr-builds)
Expand All @@ -39,7 +40,7 @@ plugin.

The GHPRB plugin is configured to trigger through GitHub hooks. This is the preferred method
to trigger on changes (more efficient than polling). Kata Containers integrates the CIs
using the [katacontainersbot](https://github.com/katacontainersbot) user. Please discuss
using the [`katacontainersbot`](https://github.com/katacontainersbot) user. Please discuss
your requirements with the Kata Containers team who will then make the appropriate changes.

Set the GHPRB triggers similar to the following:
Expand All @@ -51,7 +52,7 @@ Set the GHPRB `Trigger Setup` further options similar to the following:
### Master builds

Master branch builds are tracked with the Jenkins [git Source Code Management](https://plugins.jenkins.io/git)
(GITScm) plugin. GITScm GitHub hooks are used to trigger builds.
(`GITScm`) plugin. `GITScm` GitHub hooks are used to trigger builds.

The Jenkins setup should look similar to the following for the:

Expand All @@ -72,7 +73,7 @@ For Kata Containers CI we configure Jenkins with a GitHub [Personal API token](h
## Job build script

Kata Containers Jenkins builds, for both PR and Master builds, are invoked using the top
level [`jenkins_job_build.sh`](https://github.com/kata-containers/tests/blob/master/.ci/jenkins_job_build.sh) script from the [katacontainers/tests](https://github.com/kata-containers/tests)
level [`jenkins_job_build.sh`](https://github.com/kata-containers/tests/blob/master/.ci/jenkins_job_build.sh) script from the [`katacontainers/tests`](https://github.com/kata-containers/tests)
repository.

This script takes a single argument (i.e. the path to the repository to build), and utilizes
Expand Down Expand Up @@ -154,7 +155,7 @@ The following variables influence the actions of the script:
| --------- | ---------------------------------------------------------------- |
| `ghprbPullId` | Is used in PR builds to locate the correct branch on GitHub to pull and build. |
| `ghprbTargetBranch` | Is set by the GHPRB Jenkins plugin. Is only set for PR builds, and is used with `ghprbPullId` to distinguish between PR and Master builds. |
| `KATA_DEV_MODE` | Must not be set, or the script will not act as a CI script. `KATA_DEV_MODE` is a developer only option allowing the script to be run 'safely' in a development environment. |
| `KATA_DEV_MODE` | Must not be set, or the script will not act as a CI script. `KATA_DEV_MODE` is a developer only option allowing the script to be run "safely" in a development environment. |
| `METRICS_CI` | If set, will skip running the QA tests after the install/build phases (as the tests are not required for a metrics run). |
| `WORKSPACE` | Must be set. Is set by Jenkins to point at the directory the script will use as its workspace (scratch area) |

Expand All @@ -172,7 +173,7 @@ The following variables influence the actions of the script:

For the more experienced Jenkins user, if you are comfortable reading Jenkins XML config files
then you can find a backup of our Azure based Jenkins QA CI in this repository under the
[jenkins sub folder](https://github.com/kata-containers/ci/tree/master/jenkins).
[Jenkins sub folder](https://github.com/kata-containers/ci/tree/master/jenkins).

## Other CIs

Expand Down
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,23 @@ architectures and configurations are properly tested. Below you can find a
matrix of what jobs/configuration we currently use and the tests we run
against them.

| Job | Hypervisor - Machine Type | Guest Image | Architecture | | docker | cri-o | containerd | kubernetes | Openshift | docker stability | oci | network | netmon | vm-templating | shimv2 - containerd | entropy | ramdisk | tracing |
| Job | Hypervisor - Machine Type | Guest Image | Architecture | | Docker | CRI-O | Containerd | Kubernetes | OpenShift | Docker stability | OCI | network | `netmon` | VM-templating | `shimv2 - containerd` | entropy | ramdisk | tracing |
|-------------------------|---------------------------|-------------|-------------|---------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|---------------------|--------------------|--------------------|--------------------|
| centos-7.4-firecracker | firecracker | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | | | | |
| centos-7.4-q35 | qemu - q35 | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| debian-9 | [WIP](https://github.com/kata-containers/ci/issues/87) | WIP | x86_64 | :arrow_right: | | | | | | | | | | | | | | |
| fedora-28 | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| fedora-28-vsocks | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| opensuse 15 | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| rhel-7 | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| sles-12-SP3 | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| ubuntu-18.04 | qemu - PC | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| ubuntu-18.04-containerd | qemu - PC | rootfs | x86_64 | :arrow_right: | | | :heavy_check_mark: | :heavy_check_mark: | | | | | | | | | | |
| ubuntu-18.04-initrd | qemu - PC | intird | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| ubuntu-18.04-nemu | nemu - virt | rootfs | x86_64 | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| ubuntu-18.04-aarch64 | qemu - virt | rootfs | arm64 | :arrow_right: | :heavy_check_mark: | | | | | | | | | | | | | |
| ubuntu-18.04-s390x | qemu - s390-ccw-virtio | initrd | s390x | :arrow_right: | :heavy_check_mark: | | | | | | | | | | | | | |
| ubuntu-16.04-Power8 | [WIP](https://github.com/kata-containers/ci/issues/100) | WIP | Power8 | :arrow_right: | | | | | | | | | | | | | | |
| `centos-7.4-firecracker` | firecracker | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | | | | |
| `centos-7.4-q35` | `qemu - q35` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `debian-9` | [WIP](https://github.com/kata-containers/ci/issues/87) | WIP | `x86_64` | :arrow_right: | | | | | | | | | | | | | | |
| `fedora-28` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `fedora-28-vsocks` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `opensuse` 15 | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `rhel-7` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `sles-12-SP3` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ubuntu-18.04` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ubuntu-18.04-containerd` | `qemu - PC` | rootfs | `x86_64` | :arrow_right: | | | :heavy_check_mark: | :heavy_check_mark: | | | | | | | | | | |
| `ubuntu-18.04-initrd` | `qemu - PC` | initrd | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ubuntu-18.04-nemu` | `nemu - virt` | rootfs | `x86_64` | :arrow_right: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ubuntu-18.04-aarch64` | `qemu - virt` | rootfs | `arm64` | :arrow_right: | :heavy_check_mark: | | | | | | | | | | | | | |
| `ubuntu-18.04-s390x` | `qemu - s390-ccw-virtio` | initrd | `s390x` | :arrow_right: | :heavy_check_mark: | | | | | | | | | | | | | |
| `ubuntu-16.04-Power8` | [WIP](https://github.com/kata-containers/ci/issues/100) | WIP | `Power8` | :arrow_right: | | | | | | | | | | | | | | |

# CI health status

Expand Down