mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-10-22 04:18:53 +00:00
e1f3b871cd
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>
100 lines
5.9 KiB
Markdown
100 lines
5.9 KiB
Markdown
# Kata Containers installation guides
|
|
|
|
The following is an overview of the different installation methods available.
|
|
|
|
## Prerequisites
|
|
|
|
Kata Containers 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.
|
|
|
|
## Packaged installation methods
|
|
|
|
Packaged installation methods uses your distribution's native package format (such as RPM or DEB).
|
|
|
|
> **Note:** We encourage installation methods that provides automatic updates, it ensures security updates and bug fixes are
|
|
> easily applied.
|
|
|
|
| Installation method | Description | Automatic updates | Use case |
|
|
|------------------------------------------------------|----------------------------------------------------------------------------------------------|-------------------|-----------------------------------------------------------------------------------------------|
|
|
| [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. |
|
|
| [Using official distro packages](#official-packages) | Kata packages provided by Linux distributions official repositories | yes | Recommended for most users. |
|
|
| ~~[Using snap](#snap-installation)~~ | ~~Easy to install~~ | ~~yes~~ | **Snap is unmaintained!** ~~Good alternative to official distro packages.~~ |
|
|
| [Automatic](#automatic-installation) | Run a single command to install a full system | **No!** | For those wanting the latest release quickly. |
|
|
| [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. |
|
|
| [Build from source](#build-from-source-installation) | Build the software components manually | **No!** | Power users and developers only. |
|
|
|
|
### Kata Deploy Installation
|
|
|
|
Kata Deploy provides a Dockerfile, which contains all of the binaries and
|
|
artifacts required to run Kata Containers, as well as reference DaemonSets,
|
|
which can be utilized to install Kata Containers on a running Kubernetes
|
|
cluster.
|
|
|
|
[Use Kata Deploy](/tools/packaging/kata-deploy/README.md) to install Kata Containers on a Kubernetes Cluster.
|
|
|
|
### Official packages
|
|
|
|
Kata packages are provided by official distribution repositories for:
|
|
|
|
| Distribution (link to installation guide) | Minimum versions |
|
|
|----------------------------------------------------------|--------------------------------------------------------------------------------|
|
|
| [CentOS](centos-installation-guide.md) | 8 |
|
|
| [Fedora](fedora-installation-guide.md) | 34 |
|
|
|
|
### Snap Installation
|
|
|
|
> **WARNING:**
|
|
>
|
|
> The Snap package method is **unmaintained** and only provides an old
|
|
> version of Kata Containers:
|
|
> The [latest Kata Containers snap](https://snapcraft.io/kata-containers)
|
|
> provides Kata Containers
|
|
> [version 2.4.2](https://github.com/kata-containers/kata-containers/releases/tag/2.4.2)
|
|
> but the latest stable Kata Containers release at the time of writing is
|
|
> [version 3.1.0](https://github.com/kata-containers/kata-containers/releases/tag/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.
|
|
|
|
~~The snap installation is available for all distributions which support `snapd`.~~
|
|
|
|
~~[Use snap](snap-installation-guide.md) to install Kata Containers from https://snapcraft.io. ~~
|
|
|
|
### Automatic Installation
|
|
|
|
[Use `kata-manager`](/utils/README.md) to automatically install a working Kata Containers system.
|
|
|
|
### Manual Installation
|
|
|
|
Follow the [containerd installation guide](container-manager/containerd/containerd-install.md).
|
|
|
|
## Build from source installation
|
|
|
|
> **Note:** Power users who decide to build from sources should be aware of the
|
|
> implications of using an unpackaged system which will not be automatically
|
|
> updated as new [releases](../Stable-Branch-Strategy.md) are made available.
|
|
|
|
[Building from sources](../Developer-Guide.md#initial-setup) allows power users
|
|
who are comfortable building software from source to use the latest component
|
|
versions. This is not recommended for normal users.
|
|
|
|
## Installing on a Cloud Service Platform
|
|
|
|
* [Amazon Web Services (AWS)](aws-installation-guide.md)
|
|
* [Google Compute Engine (GCE)](gce-installation-guide.md)
|
|
* [Microsoft Azure](azure-installation-guide.md)
|
|
* [Minikube](minikube-installation-guide.md)
|
|
* [VEXXHOST OpenStack Cloud](vexxhost-installation-guide.md)
|
|
|
|
## Further information
|
|
|
|
* [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)
|