mirror of https://github.com/kata-containers/kata-containers.git synced 2026-04-02 18:13:57 +00:00

Files

LandonTClipp 795869152d docs: Move to mkdocs-material, port Helm to docs site

This supersedes https://github.com/kata-containers/kata-containers/pull/12622.
I replaced Zensical with mkdocs-materialx. Materialx is a fork of mkdocs-material
created after mkdocs-material was put into maintenance mode. We'll use this
platform until Zensical is more feature complete.

Added a few of the existing docs into the site to make a more user-friendly flow.

Signed-off-by: LandonTClipp <11232769+LandonTClipp@users.noreply.github.com>

2026-03-20 14:51:39 -05:00

2.0 KiB

Raw Blame History

Runtime Configuration

The containerd shims (both the Rust and Go implementations) take configuration files to control their behavior. These files are in /opt/kata/share/defaults/kata-containers/. An example excerpt:

[hypervisor.qemu]
path = "/opt/kata/bin/qemu-system-x86_64"
kernel = "/opt/kata/share/kata-containers/vmlinux.container"
image = "/opt/kata/share/kata-containers/kata-containers.img"
machine_type = "q35"

# rootfs filesystem type:
#   - ext4 (default)
#   - xfs
#   - erofs
rootfs_type = "ext4"

# Enable running QEMU VMM as a non-root user.
# By default QEMU VMM run as root. When this is set to true, QEMU VMM process runs as
# a non-root random user. See documentation for the limitations of this mode.
rootless = false

# List of valid annotation names for the hypervisor
# Each member of the list is a regular expression, which is the base name
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
enable_annotations = ["enable_iommu", "virtio_fs_extra_args", "kernel_params"]

These files should never be modified directly. If you wish to create a modified version of these files, you may create your own custom runtime. For example, to modify the image path, we provide these values to helm:

customRuntimes:
  enabled: true
  runtimes:
    my-gpu-runtime:
      baseConfig: "qemu-nvidia-gpu"
      dropIn: |
        [hypervisor.qemu]
        image = "/path/to/custom-image.img"
      runtimeClass: |
        kind: RuntimeClass
        apiVersion: node.k8s.io/v1
        metadata:
          name: kata-my-gpu-runtime
          labels:
            app.kubernetes.io/managed-by: kata-deploy
        handler: kata-my-gpu-runtime
        overhead:
          podFixed:
            memory: "640Mi"
            cpu: "500m"
        scheduling:
          nodeSelector:
            katacontainers.io/kata-runtime: "true"

2.0 KiB Raw Blame History

Runtime Configuration

2.0 KiB

Raw Blame History