From 5257bfa9a9404f9c967af5adca0e0e22a35916ab Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" <james.o.hunt@intel.com> Date: Wed, 6 Mar 2024 13:14:03 +0000 Subject: [PATCH] docs: install: Simplify instructions Move the "build from source" and "manual installation" details to the developer guide. This makes the installation landing page clearer for users. Fixes: #9234. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com> --- docs/Developer-Guide.md | 15 +++++++++++++-- docs/install/README.md | 27 +++++++-------------------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/docs/Developer-Guide.md b/docs/Developer-Guide.md index 343716a99e..70bf190de4 100644 --- a/docs/Developer-Guide.md +++ b/docs/Developer-Guide.md @@ -15,11 +15,22 @@ The recommended way to create a development environment is to first to create a working system. The installation guide instructions will install all required Kata Containers -components, plus *Docker*, the hypervisor, and the Kata Containers image and -guest kernel. +components, plus a container manager, the hypervisor, and the Kata +Containers image and guest kernel. + +Alternatively, you can perform a +[manual installation](install/container-manager/containerd/containerd-install.md), +or continue with [the instructions below](#requirements-to-build-individual-components) +to build the Kata Containers components from source. # Requirements to build individual components +> **Note:** +> +> If you decide to build from sources, you 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. + You need to install the following to build Kata Containers components: - [golang](https://golang.org/dl) diff --git a/docs/install/README.md b/docs/install/README.md index 5fb1c3a03a..fabb623dce 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -10,18 +10,19 @@ Containers. ## Packaged installation methods -Packaged installation methods uses your distribution's native package format (such as RPM or DEB). +The packaged installation method 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. +> **Note:** +> +> We encourage you to select an installation method that provides +> automatic updates, to ensure you get the latest security updates and +> bug fixes. | 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. | | [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. | +| [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. | ### Kata Deploy Installation @@ -45,20 +46,6 @@ Kata packages are provided by official distribution repositories for: [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)