From 26d41b8f6e327298e7bbf290deff5e92ff8a88c1 Mon Sep 17 00:00:00 2001 From: Alex Lyn Date: Fri, 6 Mar 2026 15:24:46 +0800 Subject: [PATCH] docs: Remove the dedicated installation guide for runtime-rs When runtime-rs becomes default runtime, everything just for runtime-rs will be changed, and the dedicated installation for runtime-rs will be deprecated. Signed-off-by: Alex Lyn --- docs/install/README.md | 3 - ...ers-3.0-rust-runtime-installation-guide.md | 116 ------------------ 2 files changed, 119 deletions(-) delete mode 100644 docs/install/kata-containers-3.0-rust-runtime-installation-guide.md diff --git a/docs/install/README.md b/docs/install/README.md index c70399fac4..e0be7b2da4 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -18,6 +18,3 @@ artifacts required to run Kata Containers on Kubernetes. * [upgrading document](../Upgrading.md) * [developer guide](../Developer-Guide.md) * [runtime documentation](../../src/runtime/README.md) - -## Kata Containers 3.0 rust runtime installation -* [installation guide](../install/kata-containers-3.0-rust-runtime-installation-guide.md) diff --git a/docs/install/kata-containers-3.0-rust-runtime-installation-guide.md b/docs/install/kata-containers-3.0-rust-runtime-installation-guide.md deleted file mode 100644 index 676a2b7c16..0000000000 --- a/docs/install/kata-containers-3.0-rust-runtime-installation-guide.md +++ /dev/null @@ -1,116 +0,0 @@ -# Kata Containers 3.0 rust runtime installation -The following is an overview of the different installation methods available. - -## Prerequisites - -Kata Containers 3.0 rust runtime requires nested virtualization or bare metal. Check -[hardware requirements](/src/runtime/README.md#hardware-requirements) to see if your system is capable of running Kata -Containers. - -### Platform support - -Kata Containers 3.0 rust runtime currently runs on 64-bit systems supporting the following -architectures: - -> **Notes:** -> For other architectures, see https://github.com/kata-containers/kata-containers/issues/4320 - -| Architecture | Virtualization technology | -|-|-| -| `x86_64`| [Intel](https://www.intel.com) VT-x | -| `aarch64` ("`arm64`")| [ARM](https://www.arm.com) Hyp | - -## Packaged installation methods - -| Installation method | Description | Automatic updates | Use case | Availability -|------------------------------------------------------|----------------------------------------------------------------------------------------------|-------------------|-----------------------------------------------------------------------------------------------|----------- | -| [Using kata-deploy](#kata-deploy-installation) | The preferred way to deploy the Kata Containers distributed binaries on a Kubernetes cluster | **No!** | Best way to give it a try on kata-containers on an already up and running Kubernetes cluster. | Yes | -| [Using official distro packages](#official-packages) | Kata packages provided by Linux distributions official repositories | yes | Recommended for most users. | No | -| [Automatic](#automatic-installation) | Run a single command to install a full system | **No!** | For those wanting the latest release quickly. | No | -| [Manual](#manual-installation) | Follow a guide step-by-step to install a working system | **No!** | For those who want the latest release with more control. | No | -| [Build from source](#build-from-source-installation) | Build the software components manually | **No!** | Power users and developers only. | Yes | - -### Kata Deploy Installation - -Follow the [`kata-deploy`](../../tools/packaging/kata-deploy/helm-chart/README.md). -### Official packages -`ToDo` -### Automatic Installation -`ToDo` -### Manual Installation -`ToDo` - -## Build from source installation - -### Rust Environment Set Up - -* Download `Rustup` and install `Rust` - > **Notes:** - > For Rust version, please set `RUST_VERSION` to the value of `languages.rust.meta.newest-version key` in [`versions.yaml`](../../versions.yaml) or, if `yq` is available on your system, run `export RUST_VERSION=$(yq read versions.yaml languages.rust.meta.newest-version)`. - - Example for `x86_64` - ``` - $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - $ source $HOME/.cargo/env - $ rustup install ${RUST_VERSION} - $ rustup default ${RUST_VERSION}-x86_64-unknown-linux-gnu - ``` - -* Musl support for fully static binary - - Example for `x86_64` - ``` - $ rustup target add x86_64-unknown-linux-musl - ``` -* [Musl `libc`](http://musl.libc.org/) install - - Example for musl 1.2.3 - ``` - $ curl -O https://git.musl-libc.org/cgit/musl/snapshot/musl-1.2.3.tar.gz - $ tar vxf musl-1.2.3.tar.gz - $ cd musl-1.2.3/ - $ ./configure --prefix=/usr/local/ - $ make && sudo make install - ``` - - -### Install Kata 3.0 Rust Runtime Shim - -``` -$ git clone https://github.com/kata-containers/kata-containers.git -$ cd kata-containers/src/runtime-rs -$ make && sudo make install -``` -After running the command above, the default config file `configuration.toml` will be installed under `/usr/share/defaults/kata-containers/`, the binary file `containerd-shim-kata-v2` will be installed under `/usr/local/bin/` . - -### Install Shim Without Builtin Dragonball VMM - -By default, runtime-rs includes the `Dragonball` VMM. To build without the built-in `Dragonball` hypervisor, use `make USE_BUILTIN_DB=false`: -```bash -$ cd kata-containers/src/runtime-rs -$ make USE_BUILTIN_DB=false -``` -After building, specify the desired hypervisor during installation using `HYPERVISOR`. For example, to use `qemu` or `cloud-hypervisor`: - -``` -sudo make install HYPERVISOR=qemu -``` -or -``` -sudo make install HYPERVISOR=cloud-hypervisor -``` - -### Build Kata Containers Kernel -Follow the [Kernel installation guide](/tools/packaging/kernel/README.md). - -### Build Kata Rootfs -Follow the [Rootfs installation guide](../../tools/osbuilder/rootfs-builder/README.md). - -### Build Kata Image -Follow the [Image installation guide](../../tools/osbuilder/image-builder/README.md). - -### Install Containerd - -Follow the [Containerd installation guide](container-manager/containerd/containerd-install.md). - -