github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-29 20:24:31 +00:00
Code Issues Projects Releases Wiki Activity

docs: update general wording for installation documentation

Browse Source 
Remove duplicated information, reduce text separation, and rewrite notes
to be more clear and concise.

Fixes: #2449

Signed-off-by: Joao Vanzuita <joaovanzuita@me.com>
This commit is contained in:
Joao Vanzuita 2021-08-16 18:54:03 +02:00 committed by João Vanzuita
parent b94252a5fa
commit 2cb7b51355
1 changed files with 16 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/install/README.md
View File

@ -1,22 +1,19 @@
# Kata Containers installation user guides # Kata Containers installation guides
The following is an overview of the different installation methods available. All of these methods equally result The following is an overview of the different installation methods available.
in a system configured to run Kata Containers.
## Prerequisites ## Prerequisites
Kata Containers requires nested virtualization or bare metal. Kata Containers requires nested virtualization or bare metal. Check
See the [hardware requirements](/src/runtime/README.md#hardware-requirements) to see if your system is capable of running Kata
[hardware requirements](/src/runtime/README.md#hardware-requirements) Containers.
to see if your system is capable of running Kata Containers.
## Packaged installation methods ## Packaged installation methods
> **Notes:** Packaged installation methods uses your distribution's native package format (such as RPM or DEB).
>
> - 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
> - You are strongly encouraged to choose an installation method that provides easily applied.
> automatic updates, to ensure you benefit from security updates and bug fixes.
| Installation method | Description | Automatic updates | Use case | | Installation method | Description | Automatic updates | Use case |
|------------------------------------------------------|---------------------------------------------------------------------|-------------------|----------------------------------------------------------| |------------------------------------------------------|---------------------------------------------------------------------|-------------------|----------------------------------------------------------|
@ -35,16 +32,9 @@ Kata packages are provided by official distribution repositories for:
| [CentOS](centos-installation-guide.md) | 8 | | [CentOS](centos-installation-guide.md) | 8 |
| [Fedora](fedora-installation-guide.md) | 34 | | [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 ### Snap Installation
> **Note:** The snap installation is available for all distributions which support `snapd`. The snap installation is available for all distributions which support `snapd`.
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/kata-containers)
[Use snap](snap-installation-guide.md) to install Kata Containers from https://snapcraft.io. [Use snap](snap-installation-guide.md) to install Kata Containers from https://snapcraft.io.
@ -58,11 +48,9 @@ Follow the [containerd installation guide](container-manager/containerd/containe
## Build from source installation ## Build from source installation
> **Note:** *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
> Power users who decide to build from sources should be aware of the updated as new [releases](../Stable-Branch-Strategy.md) are made available.
> 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 [Building from sources](../Developer-Guide.md#initial-setup) allows power users
who are comfortable building software from source to use the latest component who are comfortable building software from source to use the latest component
@ -78,6 +66,6 @@ versions. This is not recommended for normal users.
## Further information ## Further information
* The [upgrading document](../Upgrading.md). * [upgrading document](../Upgrading.md)
* The [developer guide](../Developer-Guide.md). * [developer guide](../Developer-Guide.md)
* The [runtime documentation](../../src/runtime/README.md). * [runtime documentation](../../src/runtime/README.md)