c12s-kubespray/docs/kata-containers.md
Cristian Calin 52ee5d0fff
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 15:05:21 -08:00

2.2 KiB

Kata Containers

Kata Containers is a secure container runtime with lightweight virtual machines that supports multiple hypervisor solutions.

Hypervisors

Qemu is the only hypervisor supported by Kubespray.

Installation

To use Kata Containers, set the following variables:

k8s_cluster.yml:

container_manager: containerd
kata_containers_enabled: true

etcd.yml:

etcd_deployment_type: host

Configuration

Pod Overhead is a feature for accounting for the resources consumed by the Runtime Class used by the Pod.

When this feature is enabled, Kubernetes will count the fixed amount of CPU and memory set in the configuration as used by the virtual machine and not by the containers running in the Pod.

Pod Overhead is mandatory if you run Pods with Kata Containers that use resources limits.

Set cgroup driver:

To enable Pod Overhead feature you have to configure Kubelet with the appropriate cgroup driver, using the following configuration:

cgroupfs works best:

kubelet_cgroup_driver: cgroupfs

... but when using cgroups v2 (see https://www.redhat.com/en/blog/world-domination-cgroups-rhel-8-welcome-cgroups-v2) you can use systemd as well:

kubelet_cgroup_driver: systemd

Qemu hypervisor configuration:

The configuration for the Qemu hypervisor uses the following values:

kata_containers_qemu_overhead: true
kata_containers_qemu_overhead_fixed_cpu: 10m
kata_containers_qemu_overhead_fixed_memory: 290Mi

Optional : Select Kata Containers version

Optionally you can select the Kata Containers release version to be installed. The available releases are published in GitHub.

kata_containers_version: 2.2.2

Optional : Debug

Debug is disabled by default for all the components of Kata Containers. You can change this behaviour with the following configuration:

kata_containers_qemu_debug: 'false'