docs: fix broken links

Some sections and files were removed in a previous commit,
remove all reference to such sections and files to fix the
check-markdown test.

fixes #826

Signed-off-by: Julio Montes <julio.montes@intel.com>
This commit is contained in:
Julio Montes 2020-09-29 12:24:05 -05:00
parent 3360fb343f
commit a7faeaac51
9 changed files with 12 additions and 117 deletions

View File

@ -2,7 +2,6 @@
* [Prerequisites](#prerequisites) * [Prerequisites](#prerequisites)
* [Packaged installation methods](#packaged-installation-methods) * [Packaged installation methods](#packaged-installation-methods)
* [Supported Distributions](#supported-distributions)
* [Official packages](#official-packages) * [Official packages](#official-packages)
* [Automatic Installation](#automatic-installation) * [Automatic Installation](#automatic-installation)
* [Snap Installation](#snap-installation) * [Snap Installation](#snap-installation)
@ -29,13 +28,13 @@ to see if your system is capable of running Kata Containers.
| Installation method | Description | Distributions supported | | 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 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) | | [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 |[see table](#supported-distributions) | | [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 |[see table](#supported-distributions) | | [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: 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. [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
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. 1. Add the Kata Containers repository to your distro package manager, and import the packages signing key.
2. Install the Kata Containers packages. 2. Install the Kata Containers packages.
3. Install a supported container manager. 3. Install a supported container manager.

View File

@ -15,4 +15,4 @@ Create a new virtual machine with:
## Set up with distribution specific quick start ## 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).

View File

@ -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).
<!--
You can ignore the content of this comment.
(test code run by test-install-docs.sh to validate code blocks this document)
```bash
$ echo "NOTE: this document is just a link to the generic openSUSE install guide located at:
https://raw.githubusercontent.com/kata-containers/documentation/master/install/docker/opensuse-docker-install.md
Please download this file and run kata-doc-to-script.sh again."
```
-->

View File

@ -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).
<!--
You can ignore the content of this comment.
(test code run by test-install-docs.sh to validate code blocks this document)
```bash
$ echo "NOTE: this document is just a link to the generic openSUSE install guide located at:
https://raw.githubusercontent.com/kata-containers/documentation/master/install/docker/opensuse-docker-install.md
Please download this file and run kata-doc-to-script.sh again."
```
-->

View File

@ -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 <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf
[Service]
ExecStart=
ExecStart=/usr/bin/dockerd -D --add-runtime kata-runtime=/usr/bin/kata-runtime --default-runtime=kata-runtime
EOF
```
2. Docker `daemon.json`
Create docker configuration folder.
```
$ sudo mkdir -p /etc/docker
```
Add the following definitions to `/etc/docker/daemon.json`:
```json
{
"default-runtime": "kata-runtime",
"runtimes": {
"kata-runtime": {
"path": "/usr/bin/kata-runtime"
}
}
}
```
3. Restart the Docker systemd service with the following commands:
```bash
$ sudo systemctl daemon-reload
$ sudo systemctl restart docker
```
4. Run Kata Containers
You are now ready to run Kata Containers:
```bash
$ sudo docker run busybox uname -a
```
The previous command shows details of the kernel version running inside the
container, which is different to the host kernel version.

View File

@ -3,7 +3,7 @@
> **Note:** > **Note:**
> >
> - This guide assumes you have > - 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: 1. Install the latest version of Docker with the following commands:

View File

@ -5,7 +5,7 @@
* [Docker Installation and Setup](#docker-installation-and-setup) * [Docker Installation and Setup](#docker-installation-and-setup)
## Introduction ## 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) [`kata-doc-to-script`](https://github.com/kata-containers/tests/blob/master/.ci/kata-doc-to-script.sh)
to generate installation bash scripts. to generate installation bash scripts.

View File

@ -6,7 +6,7 @@
* [Further Information](#further-information) * [Further Information](#further-information)
## Introduction ## 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**: > **Note**:
> - `kata-manager` requires `curl` and `sudo` installed on your system. > - `kata-manager` requires `curl` and `sudo` installed on your system.

View File

@ -13,4 +13,4 @@ with v2). The recommended machine type for container workloads is `v2-highcpu`
## Set up with distribution specific quick start ## 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).