From 6267b86c7b6874e5fb47d8bdc7aeb05516454afa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Thu, 16 Jul 2026 13:43:33 +0200 Subject: [PATCH] docs: Address installation guide review feedback from #13238 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove the RuntimeClass table in favour of prose, map `uname -m` to the release tarball architecture names (amd64, arm64, s390x, ppc64le), mark the Go runtime as deprecated, and point README links at installation.md. Signed-off-by: Fabiano Fidêncio Signed-off-by: LandonTClipp Assisted-by: Cursor --- README.md | 2 +- docs/README.md | 2 +- docs/installation.md | 33 ++++++++++++++++++++------------- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a1305b687d..9c136e197b 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ $ kata-runtime check New to Kata Containers? Start with the [Quick Start Guide](docs/quick-start-guide.md) to learn the basics and run your -first workload, then see the [installation documentation](docs/install). +first workload, then see the [installation guide](docs/installation.md). ## Documentation diff --git a/docs/README.md b/docs/README.md index 2c92d84bfc..78b402c28e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,7 +10,7 @@ For details of the other Kata Containers repositories, see the ## Getting Started * [Quick Start Guide](./quick-start-guide.md): Understand the basics and run your first Kata workload in minutes -* [Installation guides](./install/README.md): Install and run Kata Containers with Docker or Kubernetes +* [Installation guide](./installation.md): Install and run Kata Containers with Docker or Kubernetes ## Tracing diff --git a/docs/installation.md b/docs/installation.md index 40f800e50b..92ed8f1a01 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -3,7 +3,9 @@ Kata Containers ships two runtimes side by side: the legacy Go runtime (`src/runtime`) and `runtime-rs` (`src/runtime-rs`), the Rust implementation of the containerd shim v2. Since the 4.0.0 release `runtime-rs` is the -default and recommended choice; the Go runtime is still shipped and supported. +default and recommended choice. The Go runtime is still shipped and supported, +but **deprecated** — see +[Go runtime deprecation](migrating-config-go-runtime-to-runtime-rs.md#go-runtime-deprecation). The recommended install path is the [`kata-deploy` Helm chart](#install-on-kubernetes-with-helm-recommended) on a Kubernetes cluster. Pre-built release tarballs and from-source builds are @@ -148,15 +150,9 @@ node selectors, TEE shims, drop-in configuration files and more), see the ### Use a Kata RuntimeClass The chart creates one `RuntimeClass` per enabled shim. `runtime-rs`-based -runtimes use the `-runtime-rs` suffix; `kata-dragonball` (the built-in -Dragonball VMM) is `runtime-rs` only: - -| RuntimeClass | Hypervisor | Runtime | -|-|-|-| -| `kata-qemu-runtime-rs` | QEMU | runtime-rs | -| `kata-clh-runtime-rs` | Cloud Hypervisor | runtime-rs | -| `kata-dragonball` | Dragonball (built-in) | runtime-rs | -| `kata-qemu` | QEMU | Go runtime (deprecated) | +runtimes use the `-runtime-rs` suffix (for example `kata-qemu-runtime-rs`); +`kata-dragonball` (the built-in Dragonball VMM) is `runtime-rs` only. The +deprecated Go runtime is available as `kata-qemu`. List the runtime classes available on your cluster: @@ -212,7 +208,18 @@ Download the archive for your architecture from the ```sh export VERSION=$(curl -sSL https://api.github.com/repos/kata-containers/kata-containers/releases/latest | jq -r .tag_name) -export ARCH=amd64 # or arm64, s390x, ppcle64 etc + +# Release tarballs use architecture names that differ from `uname -m`. +case "$(uname -m)" in + x86_64) ARCH=amd64 ;; + aarch64) ARCH=arm64 ;; + s390x) ARCH=s390x ;; + ppc64le) ARCH=ppc64le ;; + *) + echo "unsupported architecture: $(uname -m)" >&2 + exit 1 + ;; +esac curl -fsSL -o kata-static.tar.zst \ "https://github.com/kata-containers/kata-containers/releases/download/${VERSION}/kata-static-${VERSION}-${ARCH}.tar.zst" @@ -225,8 +232,8 @@ The release installs both runtimes side by side: | Path | Runtime | |-|-| -| `/opt/kata/runtime-rs/bin/containerd-shim-kata-v2` | runtime-rs (recommended) | -| `/opt/kata/bin/containerd-shim-kata-v2` | Go runtime | +| `/opt/kata/runtime-rs/bin/containerd-shim-kata-v2` | runtime-rs (default) | +| `/opt/kata/bin/containerd-shim-kata-v2` | Go runtime (deprecated) | Packaged configuration files live under `/opt/kata/share/defaults/kata-containers/`. The `runtime-rs` configurations