mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-10-22 04:18:53 +00:00
43d70a32df
Create a containerd installation guide and a new `kata-manager` script
for 2.0 that automated the steps outlined in the guide.
Also cleaned up and improved the installation documentation in various
ways, the most significant being:
- Added legacy install link for 1.x installs.
- Official packages section:
- Removed "Contact" column (since it was empty!)
- Reworded "Versions" column to clarify the versions are a minimum
(to reduce maintenance burden).
- Add a column to show which installation methods receive automatic updates.
- Modified order of installation options in table and document to
de-emphasise automatic installation and promote official packages
and snap more.
- Removed sections no longer relevant for 2.0.
Fixes: #738.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
103 lines
5.6 KiB
Markdown
103 lines
5.6 KiB
Markdown
# Kata Containers installation user guides
|
|
|
|
* [Kata Containers installation user guides](#kata-containers-installation-user-guides)
|
|
* [Prerequisites](#prerequisites)
|
|
* [Legacy installation](#legacy-installation)
|
|
* [Packaged installation methods](#packaged-installation-methods)
|
|
* [Official packages](#official-packages)
|
|
* [Snap Installation](#snap-installation)
|
|
* [Automatic Installation](#automatic-installation)
|
|
* [Manual Installation](#manual-installation)
|
|
* [Build from source installation](#build-from-source-installation)
|
|
* [Installing on a Cloud Service Platform](#installing-on-a-cloud-service-platform)
|
|
* [Further information](#further-information)
|
|
|
|
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.
|
|
|
|
## Legacy installation
|
|
|
|
If you wish to install a legacy 1.x version of Kata Containers, see
|
|
[the Kata Containers 1.x installation documentation](https://github.com/kata-containers/documentation/tree/master/install/).
|
|
|
|
## 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) | 32, Rawhide |
|
|
| [openSUSE](opensuse-installation-guide.md) | [Leap 15.1](opensuse-leap-15.1-installation-guide.md)<br>Leap 15.2, Tumbleweed |
|
|
| [SUSE Linux Enterprise (SLE)](sle-installation-guide.md) | SLE 15 SP1, 15 SP2 |
|
|
|
|
> **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
|
|
|
|
> **Notes:**
|
|
>
|
|
> - 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).
|