From 7499b13030274ccc0a1610f2d7e41d1a3a722d7a Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 14:34:15 +0100 Subject: [PATCH 1/8] docs: Add headings and TOC Add missing heading names and a table of contents. Also, folded the long lines to make them easier to edit and diff. Fixes #501. Signed-off-by: James O. D. Hunt --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58e6230390..2231306b1e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ # Kata Containers packaging -Kata Containers currently supports packages for many distributions. Tooling to aid in creating these -packages are contained within this repository. +* [Introduction](#introduction) +* [Build in a container](#build-in-a-container) +* [Credits](#credits) -In addition, Kata build artifacts are available within a container image, created by a -[Dockerfile](kata-deploy/Dockerfile). Reference daemonsets are provided in [kata-deploy](kata-deploy), -which make installation of Kata Containers in a running Kubernetes Cluster very straightforward. +## Introduction + +Kata Containers currently supports packages for many distributions. Tooling to +aid in creating these packages are contained within this repository. + +## Build in a container + +Kata build artifacts are available within a container image, created by a +[Dockerfile](kata-deploy/Dockerfile). Reference daemonsets are provided in +[kata-deploy](kata-deploy), which make installation of Kata Containers in a +running Kubernetes Cluster very straightforward. ## Credits From 0c520582eb64e69808b2103c96045bf9f82ccd68 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 15:01:39 +0100 Subject: [PATCH 2/8] docs: Remove redundant markdown GFM doesn't require corresponding heading hashes at the end of line - start of lines hashes are adequate. Signed-off-by: James O. D. Hunt --- release/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/release/README.md b/release/README.md index 10d4f4763c..b1bc3d3c15 100644 --- a/release/README.md +++ b/release/README.md @@ -1,8 +1,8 @@ -# Release tools # +# Release tools This directory contains tools for Kata Containers releases. -## update-repository-version.sh ## +## update-repository-version.sh This script creates a GitHub pull request (a.k.a PR) to change the version in all the Kata repositories. @@ -13,7 +13,7 @@ For more information on using the script, run the following: $ ./update-repository-version.sh -h ``` -### Update Kata projects to a new version ### +### Update Kata projects to a new version Kata Containers is divided into multiple projects. With each release, all project versions are updated to keep the version consistent. @@ -28,7 +28,7 @@ repositories. These pull requests are tested by the Kata CI to ensure the entire project is working prior to the release. Next, the PR is approved and merged by Kata Containers members. -## tag_repos.sh ## +## tag_repos.sh After all the Kata repositories are updated with a new version, they need to be tagged. From e8ba16eec943265a77bf4b15674c82ec6cbf07ec Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 15:04:00 +0100 Subject: [PATCH 3/8] docs: Correct heading level Fix the heading level in the release README. Signed-off-by: James O. D. Hunt --- release/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/release/README.md b/release/README.md index b1bc3d3c15..e1e6420357 100644 --- a/release/README.md +++ b/release/README.md @@ -13,7 +13,8 @@ For more information on using the script, run the following: $ ./update-repository-version.sh -h ``` -### Update Kata projects to a new version +## Update Kata projects to a new version + Kata Containers is divided into multiple projects. With each release, all project versions are updated to keep the version consistent. From 4213fcba537744783b8a7e8743b64d59e1201017 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 15:05:34 +0100 Subject: [PATCH 4/8] docs: Improve release README Added backticks to commands and added a TOC. Signed-off-by: James O. D. Hunt --- release/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/release/README.md b/release/README.md index e1e6420357..64485be48b 100644 --- a/release/README.md +++ b/release/README.md @@ -1,8 +1,15 @@ # Release tools +* [Introduction](#introduction) +* [`update-repository-version.sh`](#update-repository-versionsh) +* [Update Kata projects to a new version](#update-kata-projects-to-a-new-version) +* [`tag_repos.sh`](#tag_repossh) + +## Introduction + This directory contains tools for Kata Containers releases. -## update-repository-version.sh +## `update-repository-version.sh` This script creates a GitHub pull request (a.k.a PR) to change the version in all the Kata repositories. @@ -24,12 +31,12 @@ To update all versions for all projects, use the following: $ make bump-kata-version NEW_VERSION= ``` -The makefile target bump-kata-version creates a GitHub pull request in the Kata -repositories. These pull requests are tested by the Kata CI to ensure the +The makefile target `bump-kata-version` creates a GitHub pull request in the +Kata repositories. These pull requests are tested by the Kata CI to ensure the entire project is working prior to the release. Next, the PR is approved and merged by Kata Containers members. -## tag_repos.sh +## `tag_repos.sh` After all the Kata repositories are updated with a new version, they need to be tagged. From dececa6ad381ce87e8768adfeef86727bb939690 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 15:05:56 +0100 Subject: [PATCH 5/8] docs: Add missing link to kernel configs doc Add a link in the kernel README to the kernel configs README. Fixes: #501. Signed-off-by: James O. D. Hunt --- kernel/README.md | 2 ++ kernel/kata_config_version | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/kernel/README.md b/kernel/README.md index 5196a2c588..070e43ef4a 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -60,6 +60,8 @@ Kata Containers packaging repository holds the kernel configs and patches. The config and patches can work for many versions, but we only test the kernel version defined in the [runtime versions file][runtime-versions-file]. +For further details, see [the kernel configuration documentation](configs). + ## How is it tested The Kata Containers CI scripts install the kernel from [CI cache diff --git a/kernel/kata_config_version b/kernel/kata_config_version index a2720097dc..425151f3a4 100644 --- a/kernel/kata_config_version +++ b/kernel/kata_config_version @@ -1 +1 @@ -39 +40 From 5a598841aff86944b46b271a216588ab2e106406 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 15:38:47 +0100 Subject: [PATCH 6/8] docs: Add missing link to release process Add a reference to the release.md file to make it more discoverable. Fixes: #501. Signed-off-by: James O. D. Hunt --- release/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/release/README.md b/release/README.md index 64485be48b..1e526a2365 100644 --- a/release/README.md +++ b/release/README.md @@ -1,6 +1,7 @@ # Release tools * [Introduction](#introduction) +* [Create a Kata Containers release](#create-a-kata-containers-release) * [`update-repository-version.sh`](#update-repository-versionsh) * [Update Kata projects to a new version](#update-kata-projects-to-a-new-version) * [`tag_repos.sh`](#tag_repossh) @@ -9,6 +10,10 @@ This directory contains tools for Kata Containers releases. +## Create a Kata Containers release + +See [the release documentation](release.md). + ## `update-repository-version.sh` This script creates a GitHub pull request (a.k.a PR) to change the version in From 577fd9fcc0696db1d5adec45e3ec660e7fda98f5 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 16:41:37 +0100 Subject: [PATCH 7/8] docs: Add missing READMEs Created a skeletal set of README for the packaging areas that didn't have them: - Jenkins - OBS - QEMU - static build tooling Signed-off-by: James O. D. Hunt --- Jenkinsfiles/README.md | 8 ++++++++ obs-packaging/README.md | 11 +++++++++++ qemu/README.md | 3 +++ static-build/README.md | 3 +++ 4 files changed, 25 insertions(+) create mode 100644 Jenkinsfiles/README.md create mode 100644 obs-packaging/README.md create mode 100644 qemu/README.md create mode 100644 static-build/README.md diff --git a/Jenkinsfiles/README.md b/Jenkinsfiles/README.md new file mode 100644 index 0000000000..6982baef56 --- /dev/null +++ b/Jenkinsfiles/README.md @@ -0,0 +1,8 @@ +# Jenkins + +Kata Containers uses [Jenkins](https://jenkins.io/) +for [its main CI](http://jenkins.katacontainers.io/). + +This directory contains support files for the Jenkins +[pipeline](https://jenkins.io/doc/book/pipeline/) +[plugin](https://wiki.jenkins.io/display/JENKINS/Pipeline+Plugin). diff --git a/obs-packaging/README.md b/obs-packaging/README.md new file mode 100644 index 0000000000..3a7eb116d5 --- /dev/null +++ b/obs-packaging/README.md @@ -0,0 +1,11 @@ +# Building under OBS + +SUSE's [Open Build Service (OBS)](https://openbuildservice.org) is used to +build [the official Kata Containers packages](https://build.opensuse.org/project/subprojects/home:katacontainers). + +This directory contains tooling and packaging metadata to build all Kata +components with OBS. + +See +[the Kata installation documentation](https://github.com/kata-containers/documentation/blob/master/install/README.md) +for instructions on how to install the official packages. diff --git a/qemu/README.md b/qemu/README.md new file mode 100644 index 0000000000..d900b5143a --- /dev/null +++ b/qemu/README.md @@ -0,0 +1,3 @@ +# QEMU patches + +This directory contains patches used to build QEMU. diff --git a/static-build/README.md b/static-build/README.md new file mode 100644 index 0000000000..70f3014e8a --- /dev/null +++ b/static-build/README.md @@ -0,0 +1,3 @@ +# Static build + +This directory contains files to build static versions of Kata Containers. From e4a5849b5551e814ccddc1b9362d9e67fb9d1039 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 16:39:11 +0100 Subject: [PATCH 8/8] docs: Add missing links Add missing links to other documents under suitable headings. Fixes: #501. Signed-off-by: James O. D. Hunt --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 2231306b1e..a45e7eeba2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # Kata Containers packaging * [Introduction](#introduction) +* [Build using OBS](#build-using-obs) * [Build in a container](#build-in-a-container) +* [Build a snap package](#build-a-snap-package) +* [Build static binaries](#build-static-binaries) +* [Build Kata Containers Kernel](#build-kata-containers-kernel) +* [Build QEMU](#build-qemu) +* [Test Kata using ccloudvm](#test-kata-using-ccloudvm) +* [Create a Kata Containers release](#create-a-kata-containers-release) +* [Jenkins files](#jenkins-files) +* [Packaging scripts](#packaging-scripts) * [Credits](#credits) ## Introduction @@ -9,6 +18,10 @@ Kata Containers currently supports packages for many distributions. Tooling to aid in creating these packages are contained within this repository. +## Build using OBS + +See the [OBS documentation](obs-packaging). + ## Build in a container Kata build artifacts are available within a container image, created by a @@ -16,6 +29,38 @@ Kata build artifacts are available within a container image, created by a [kata-deploy](kata-deploy), which make installation of Kata Containers in a running Kubernetes Cluster very straightforward. +## Build a snap package + +See [the snap documentation](snap). + +## Build static binaries + +See [the static build documentation](static-build). + +## Build Kata Containers Kernel + +See [the kernel documentation](kernel). + +## Build QEMU + +See [the QEMU documentation](qemu). + +## Test Kata using ccloudvm + +See [the ccloudvm documentation](ccloudvm). + +## Create a Kata Containers release + +See [the release documentation](release). + +## Jenkins files + +See [the Jenkins documentation](Jenkinsfiles). + +## Packaging scripts + +See the [scripts documentation](scripts). + ## Credits Kata Containers packaging uses [packagecloud](https://packagecloud.io) for