mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-18 14:54:19 +01:00
4f0726bc49
Removed all TOCs now that GitHub auto-generates them. Also updated the documentation requirements doc removing the requirement to add a TOC. Fixes: #2022. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# Kata Containers snap package
|
|
|
|
## Install Kata Containers
|
|
|
|
Kata Containers can be installed in any Linux distribution that supports
|
|
[snapd](https://docs.snapcraft.io/installing-snapd).
|
|
|
|
Run the following command to install **Kata Containers**:
|
|
|
|
```sh
|
|
$ sudo snap install kata-containers --stable --classic
|
|
```
|
|
|
|
## Configure Kata Containers
|
|
|
|
By default Kata Containers snap image is mounted at `/snap/kata-containers` as a
|
|
read-only file system, therefore default configuration file can not be edited.
|
|
Fortunately Kata Containers supports loading a configuration file from another
|
|
path than the default.
|
|
|
|
```sh
|
|
$ sudo mkdir -p /etc/kata-containers
|
|
$ sudo cp /snap/kata-containers/current/usr/share/defaults/kata-containers/configuration.toml /etc/kata-containers/
|
|
$ $EDITOR /etc/kata-containers/configuration.toml
|
|
```
|
|
|
|
## Integration with shim v2 Container Engines
|
|
|
|
The Container engine daemon (`cri-o`, `containerd`, etc) needs to be able to find the
|
|
`containerd-shim-kata-v2` binary to allow Kata Containers to be created.
|
|
Run the following command to create a symbolic link to the shim v2 binary.
|
|
|
|
```sh
|
|
$ sudo ln -sf /snap/kata-containers/current/usr/bin/containerd-shim-kata-v2 /usr/local/bin/containerd-shim-kata-v2
|
|
```
|
|
|
|
Once the symbolic link has been created and the engine daemon configured, `io.containerd.kata.v2`
|
|
can be used as runtime.
|
|
|
|
Read the following documents to know how to run Kata Containers 2.x with `containerd`.
|
|
|
|
* [How to use Kata Containers and Containerd](https://github.com/kata-containers/kata-containers/blob/main/docs/how-to/containerd-kata.md)
|
|
* [Install Kata Containers with containerd](https://github.com/kata-containers/kata-containers/blob/main/docs/install/container-manager/containerd/containerd-install.md)
|
|
|
|
|
|
## Remove Kata Containers snap package
|
|
|
|
Run the following command to remove the Kata Containers snap:
|
|
|
|
```sh
|
|
$ sudo snap remove kata-containers
|
|
```
|