mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-06-26 15:32:30 +00:00
fa85fd584e
add more details for rust set up in kata 3.0 install guide Fixes: #4720 Signed-off-by: Zhongtao Hu <zhongtaohu.tim@linux.alibaba.com>
102 lines
4.7 KiB
Markdown
102 lines
4.7 KiB
Markdown
# 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. | No |
|
|
| [Using official distro packages](#official-packages) | Kata packages provided by Linux distributions official repositories | yes | Recommended for most users. | No |
|
|
| [Using snap](#snap-installation) | Easy to install | yes | Good alternative to official distro packages. | 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
|
|
`ToDo`
|
|
### Official packages
|
|
`ToDo`
|
|
### Snap Installation
|
|
`ToDo`
|
|
### Automatic Installation
|
|
`ToDo`
|
|
### Manual Installation
|
|
`ToDo`
|
|
|
|
## Build from source installation
|
|
|
|
### Rust Environment Set Up
|
|
|
|
* Download `Rustup` and install `Rust`
|
|
> **Notes:**
|
|
> Rust version 1.58 is needed
|
|
|
|
Example for `x86_64`
|
|
```
|
|
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
|
$ source $HOME/.cargo/env
|
|
$ rustup install 1.58
|
|
$ rustup default 1.58-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
|
|
```
|
|
$ wget 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 && 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 `/user/local/bin` .
|
|
|
|
### 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).
|
|
|
|
|