Files
kata-containers/docs/install/snap-installation-guide.md
James O. D. Hunt e1f3b871cd docs: Mark snap installation method as unmaintained
The snap package is no longer being maintained so update the docs to
warn readers.

We'll remove the snap installation docs in a few weeks.

See: #6769.
Fixes: #6793.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2023-05-10 18:02:46 +01:00

3.0 KiB

Kata Containers snap package

WARNING:

The Snap package method is unmaintained and only provides an old version of Kata Containers: The latest Kata Containers snap provides Kata Containers version 2.4.2 but the latest stable Kata Containers release at the time of writing is version 3.1.0.

We recommend strongly that you switch to an alternative Kata Containers installation method.

See: https://github.com/kata-containers/kata-containers/issues/6769 for further details.

Install Kata Containers

Kata Containers can be installed in any Linux distribution that supports snapd.

Run the following command to install Kata Containers:

WARNING:

The Snap package method is unmaintained and only provides an old version of Kata Containers: The latest Kata Containers snap provides Kata Containers version 2.4.2 but the latest stable Kata Containers release at the time of writing is version 3.1.0.

We recommend strongly that you switch to an alternative Kata Containers installation method.

See: https://github.com/kata-containers/kata-containers/issues/6769 for further details.

$ 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.

$ 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.

$ 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.

Remove Kata Containers snap package

Run the following command to remove the Kata Containers snap:

$ sudo snap remove kata-containers