github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-17 17:02:42 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #572 from jodh-intel/fix-typos-and-formatting

Browse Source 
docs: Fix typos and formatting
This commit is contained in:
James O. D. Hunt 2019-06-14 08:35:34 +01:00 committed by GitHub
commit a515547c27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -25,7 +25,7 @@ See the [OBS documentation](obs-packaging).
## Build in a container ## Build in a container
Kata build artifacts are available within a container image, created by a Kata build artifacts are available within a container image, created by a
[Dockerfile](kata-deploy/Dockerfile). Reference daemonsets are provided in [Dockerfile](kata-deploy/Dockerfile). Reference DaemonSets are provided in
[`kata-deploy`](kata-deploy), which make installation of Kata Containers in a [`kata-deploy`](kata-deploy), which make installation of Kata Containers in a
running Kubernetes Cluster very straightforward. running Kubernetes Cluster very straightforward.

26
kata-deploy/README.md
View File

@ -10,15 +10,15 @@
* [Remove Kata from the Kubernetes cluster](#remove-kata-from-the-kubernetes-cluster) * [Remove Kata from the Kubernetes cluster](#remove-kata-from-the-kubernetes-cluster)
* [`kata-deploy` details](#kata-deploy-details) * [`kata-deploy` details](#kata-deploy-details)
* [Dockerfile](#dockerfile) * [Dockerfile](#dockerfile)
* [Daemonsets and RBAC](#daemonsets-and-rbac) * [DaemonSets and RBAC](#daemonsets-and-rbac)
* [Kata deploy](#kata-deploy) * [Kata deploy](#kata-deploy)
* [Kata cleanup](#kata-cleanup) * [Kata cleanup](#kata-cleanup)
[`kata-deploy`](.) provides a Dockerfile, which contains all of the binaries [`kata-deploy`](.) provides a Dockerfile, which contains all of the binaries
and artifacts required to run Kata Containers, as well as reference daemonsets, which can and artifacts required to run Kata Containers, as well as reference DaemonSets, which can
be utilized to install Kata Containers for both Docker and on a running Kubernetes cluster. be utilized to install Kata Containers for both Docker and on a running Kubernetes cluster.
Note, installation through daemonsets successfully installs `katacontainers.io/kata-runtime` on Note, installation through DaemonSets successfully installs `katacontainers.io/kata-runtime` on
a node only if it uses either containerd or CRI-O CRI-shims. a node only if it uses either containerd or CRI-O CRI-shims.
## Docker quick start ## Docker quick start
@ -174,25 +174,25 @@ Host artifacts:
* `qemu-system-x86_64` and supporting binaries * `qemu-system-x86_64` and supporting binaries
Virtual Machine artifacts: Virtual Machine artifacts:
* `kata-containers.img`: pulled from Kata github releases page * `kata-containers.img`: pulled from Kata GitHub releases page
* `vmliuz.container`: pulled from Kata github releases page * `vmlinuz.container`: pulled from Kata GitHub releases page
### Daemonsets and RBAC ### DaemonSets and RBAC
Two daemonsets are introduced for `kata-deploy`, as well as an RBAC to facilitate Two DaemonSets are introduced for `kata-deploy`, as well as an RBAC to facilitate
applying labels to the nodes. applying labels to the nodes.
#### Kata deploy #### Kata deploy
This daemonset installs the necessary Kata binaries, configuration files, and virtual machine artifacts on This DaemonSet installs the necessary Kata binaries, configuration files, and virtual machine artifacts on
the node. Once installed, the daemonset adds a node label `katacontainers.io/kata-runtime=true` and reconfigures the node. Once installed, the DaemonSet adds a node label `katacontainers.io/kata-runtime=true` and reconfigures
either CRI-O or containerd to register two `runtimeClasses`: `kata-qemu` (for QEMU isolation) and `kata-fc` (for Firecracker isolation). either CRI-O or containerd to register two `runtimeClasses`: `kata-qemu` (for QEMU isolation) and `kata-fc` (for Firecracker isolation).
As a final step the daemonset restarts either CRI-O or containerd. Upon deletion, the daemonset removes the As a final step the DaemonSet restarts either CRI-O or containerd. Upon deletion, the DaemonSet removes the
Kata binaries and VM artifacts and updates the node label to `katacontainers.io/kata-runtime=cleanup`. Kata binaries and VM artifacts and updates the node label to `katacontainers.io/kata-runtime=cleanup`.
#### Kata cleanup #### Kata cleanup
This daemonset runs of the node has the label `katacontainers.io/kata-runtime=cleanup`. These daemonsets removes This DaemonSet runs of the node has the label `katacontainers.io/kata-runtime=cleanup`. These DaemonSets removes
the `katacontainers.io/kata-runtime` label as well as restarts either CRI-O or `containerd` `systemctl` the `katacontainers.io/kata-runtime` label as well as restarts either CRI-O or `containerd` `systemctl`
daemon. You cannot execute these resets during the `preStopHook` of the Kata installer daemonset, daemon. You cannot execute these resets during the `preStopHook` of the Kata installer DaemonSet,
which necessitated this final cleanup daemonset. which necessitated this final cleanup DaemonSet.

2
release/release.md
View File

@ -23,7 +23,7 @@ guides on how to use release scripts instead of do all the checklist manually.
- [hub](https://github.com/github/hub) - [hub](https://github.com/github/hub)
- OBS account with permissions on /home:katacontainers (https://build.opensuse.org/project/subprojects/home:katacontainers) - OBS account with permissions on [`/home:katacontainers`](https://build.opensuse.org/project/subprojects/home:katacontainers)
- GitHub permissions to push tags and creates Releases in Kata repositories. - GitHub permissions to push tags and creates Releases in Kata repositories.