mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-07 00:14:21 +01:00
57b696a5ec
All users should be running 2.x releases so remove the legacy details since it's arguably confusing to have two sets of details. Reworked the components listed in the main README so that rather than being sorted alphabetically, they are now sorted in semi-order of importance and split into two tables to make the point more clearly. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
84 lines
4.5 KiB
Markdown
84 lines
4.5 KiB
Markdown
# Kata Containers installation user guides
|
|
|
|
The following is an overview of the different installation methods available. All of these methods equally result
|
|
in a system configured to run Kata Containers.
|
|
|
|
## Prerequisites
|
|
|
|
Kata Containers requires nested virtualization or bare metal.
|
|
See the
|
|
[hardware requirements](/src/runtime/README.md#hardware-requirements)
|
|
to see if your system is capable of running Kata Containers.
|
|
|
|
## Packaged installation methods
|
|
|
|
> **Notes:**
|
|
>
|
|
> - Packaged installation methods uses your distribution's native package format (such as RPM or DEB).
|
|
> - You are strongly encouraged to choose an installation method that provides
|
|
> automatic updates, to ensure you benefit from security updates and bug fixes.
|
|
|
|
| Installation method | Description | Automatic updates | Use case |
|
|
|------------------------------------------------------|---------------------------------------------------------------------|-------------------|----------------------------------------------------------|
|
|
| [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 | 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. |
|
|
|
|
### 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 |
|
|
|
|
> **Note:**
|
|
>
|
|
> All users are encouraged to uses the official distribution versions of Kata
|
|
> Containers unless they understand the implications of alternative methods.
|
|
|
|
### Snap Installation
|
|
|
|
> **Note:** The snap installation is available for all distributions which support `snapd`.
|
|
|
|
[](https://snapcraft.io/kata-containers)
|
|
|
|
[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
|
|
|
|
* The [upgrading document](../Upgrading.md).
|
|
* The [developer guide](../Developer-Guide.md).
|
|
* The [runtime documentation](../../src/runtime/README.md).
|