diff --git a/docs/install/README.md b/docs/install/README.md index 5921c7948a..22e2c61c8b 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -2,8 +2,7 @@ * [Prerequisites](#prerequisites) * [Packaged installation methods](#packaged-installation-methods) - * [Supported Distributions](#supported-distributions) - * [Official packages](#official-packages) + * [Official packages](#official-packages) * [Automatic Installation](#automatic-installation) * [Snap Installation](#snap-installation) * [Scripted Installation](#scripted-installation) @@ -29,13 +28,13 @@ to see if your system is capable of running Kata Containers. | Installation method | Description | Distributions supported | |------------------------------------------------------|-----------------------------------------------------------------------------------------|--------------------------------------| -| [Automatic](#automatic-installation) |Run a single command to install a full system |[see table](#supported-distributions) | +| [Automatic](#automatic-installation) |Run a single command to install a full system | | | [Using snap](#snap-installation) |Easy to install and automatic updates |any distro that supports snapd | -| [Using official distro packages](#official-packages) |Kata packages provided by Linux distributions official repositories |[see table](#supported-distributions) | -| [Scripted](#scripted-installation) |Generates an installation script which will result in a working system when executed |[see table](#supported-distributions) | -| [Manual](#manual-installation) |Allows the user to read a brief document and execute the specified commands step-by-step |[see table](#supported-distributions) | +| [Using official distro packages](#official-packages) |Kata packages provided by Linux distributions official repositories | | +| [Scripted](#scripted-installation) |Generates an installation script which will result in a working system when executed | | +| [Manual](#manual-installation) |Allows the user to read a brief document and execute the specified commands step-by-step | | -#### Official packages +### Official packages Kata packages are provided by official distribution repositories for: @@ -61,7 +60,7 @@ Kata packages are provided by official distribution repositories for: [Use `kata-doc-to-script`](installing-with-kata-doc-to-script.md) to generate installation scripts that can be reviewed before they are executed. ### Manual Installation -Manual installation instructions are available for [these distributions](#supported-distributions) and document how to: +Manual installation instructions are available for [these distributions](#packaged-installation-methods) and document how to: 1. Add the Kata Containers repository to your distro package manager, and import the packages signing key. 2. Install the Kata Containers packages. 3. Install a supported container manager. diff --git a/docs/install/azure-installation-guide.md b/docs/install/azure-installation-guide.md index e36206b5b1..53cbf2600f 100644 --- a/docs/install/azure-installation-guide.md +++ b/docs/install/azure-installation-guide.md @@ -15,4 +15,4 @@ Create a new virtual machine with: ## Set up with distribution specific quick start -Follow distribution specific [install guides](../install/README.md#supported-distributions). +Follow distribution specific [install guides](../install/README.md#packaged-installation-methods). diff --git a/docs/install/docker/opensuse-leap-docker-install.md b/docs/install/docker/opensuse-leap-docker-install.md deleted file mode 100644 index c743f4bda0..0000000000 --- a/docs/install/docker/opensuse-leap-docker-install.md +++ /dev/null @@ -1,14 +0,0 @@ -# Install Docker for Kata Containers on openSUSE Leap - -Follow the instructions in the generic [openSUSE Docker install guide](opensuse-docker-install.md). - diff --git a/docs/install/docker/opensuse-tumbleweed-docker-install.md b/docs/install/docker/opensuse-tumbleweed-docker-install.md deleted file mode 100644 index 8d1c5a369f..0000000000 --- a/docs/install/docker/opensuse-tumbleweed-docker-install.md +++ /dev/null @@ -1,14 +0,0 @@ -# Install Docker for Kata Containers on openSUSE Tumbleweed - -Follow the instructions in the generic [openSUSE Docker install guide](opensuse-docker-install.md). - diff --git a/docs/install/docker/rhel-docker-install.md b/docs/install/docker/rhel-docker-install.md deleted file mode 100644 index f4c9d224f4..0000000000 --- a/docs/install/docker/rhel-docker-install.md +++ /dev/null @@ -1,76 +0,0 @@ -# Install Docker for Kata Containers on RHEL - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../rhel-installation-guide.md). - -1. Install the latest version of Docker with the following commands: - - > **Notes:** - > - > - This step is only required if Docker is not installed on the system. - > - Docker version 18.09 [removed devicemapper support](https://github.com/kata-containers/documentation/issues/373). - > If you wish to use a block based backend, see the options listed on https://github.com/kata-containers/documentation/issues/407. - - ```bash - $ export rhel_devtoolset_version="7" - $ sudo subscription-manager repos --enable=rhel-${rhel_devtoolset_version}-server-extras-rpms - $ sudo yum -y install docker && systemctl enable --now docker - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/getting_started_with_containers/#getting_docker_in_rhel_7). - -2. Configure Docker to use Kata Containers by default with **ONE** of the following methods: - - 1. systemd (this is the default and is applied automatically if you select the - [automatic installation](../../install/README.md#automatic-installation) option) - - ```bash - $ sudo mkdir -p /etc/systemd/system/docker.service.d/ - $ cat < **Note:** > > - This guide assumes you have -> [already installed the Kata Containers packages](../sles-installation-guide.md). +> [already installed the Kata Containers packages](../sle-installation-guide.md). 1. Install the latest version of Docker with the following commands: diff --git a/docs/install/installing-with-kata-doc-to-script.md b/docs/install/installing-with-kata-doc-to-script.md index 3c6e25b948..3f531f02f1 100644 --- a/docs/install/installing-with-kata-doc-to-script.md +++ b/docs/install/installing-with-kata-doc-to-script.md @@ -5,7 +5,7 @@ * [Docker Installation and Setup](#docker-installation-and-setup) ## Introduction -Use [these installation instructions](README.md#supported-distributions) together with +Use [these installation instructions](README.md#packaged-installation-methods) together with [`kata-doc-to-script`](https://github.com/kata-containers/tests/blob/master/.ci/kata-doc-to-script.sh) to generate installation bash scripts. diff --git a/docs/install/installing-with-kata-manager.md b/docs/install/installing-with-kata-manager.md index 14cf725fb3..fffa3bbf9a 100644 --- a/docs/install/installing-with-kata-manager.md +++ b/docs/install/installing-with-kata-manager.md @@ -6,7 +6,7 @@ * [Further Information](#further-information) ## Introduction -`kata-manager` automates the Kata Containers installation procedure documented for [these Linux distributions](README.md#supported-distributions). +`kata-manager` automates the Kata Containers installation procedure documented for [these Linux distributions](README.md#packaged-installation-methods). > **Note**: > - `kata-manager` requires `curl` and `sudo` installed on your system. diff --git a/docs/install/vexxhost-installation-guide.md b/docs/install/vexxhost-installation-guide.md index 92890d1bee..728bd6c371 100644 --- a/docs/install/vexxhost-installation-guide.md +++ b/docs/install/vexxhost-installation-guide.md @@ -13,4 +13,4 @@ with v2). The recommended machine type for container workloads is `v2-highcpu` ## Set up with distribution specific quick start -Follow distribution specific [install guides](../install/README.md#supported-distributions). +Follow distribution specific [install guides](../install/README.md#packaged-installation-methods).