diff --git a/docs/install/README.md b/docs/install/README.md index ea53766078..d876b7c055 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -65,7 +65,7 @@ Manual installation instructions are available for [these distributions](#packag 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. -4. Configure the container manager to use `kata-runtime` as the default OCI runtime. Or, for Kata Containers 1.5.0 or above, configure the +4. Configure the container manager to use Kata Containers as the default OCI runtime. Or, for Kata Containers 1.5.0 or above, configure the `io.containerd.kata.v2` to be the runtime shim (see [containerd runtime v2 (shim API)](https://github.com/containerd/containerd/tree/master/runtime/v2) and [How to use Kata Containers and CRI (containerd plugin) with Kubernetes](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md)). diff --git a/docs/install/centos-installation-guide.md b/docs/install/centos-installation-guide.md index 58173036c1..f55f20d962 100644 --- a/docs/install/centos-installation-guide.md +++ b/docs/install/centos-installation-guide.md @@ -25,6 +25,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - - [Docker](docker/centos-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/debian-installation-guide.md b/docs/install/debian-installation-guide.md deleted file mode 100644 index 7bb2ebb536..0000000000 --- a/docs/install/debian-installation-guide.md +++ /dev/null @@ -1,22 +0,0 @@ -# Install Kata Containers on Debian - -1. Install the Kata Containers components with the following commands: - - ```bash - $ export DEBIAN_FRONTEND=noninteractive - $ ARCH=$(arch) - $ BRANCH="${BRANCH:-master}" - $ source /etc/os-release - $ [ "$ID" = debian ] && [ -z "$VERSION_ID" ] && echo >&2 "ERROR: Debian unstable not supported. - You can try stable packages here: - http://download.opensuse.org/repositories/home:/katacontainers:/releases:/${ARCH}:/${BRANCH}" && exit 1 - $ sudo sh -c "echo 'deb http://download.opensuse.org/repositories/home:/katacontainers:/releases:/${ARCH}:/${BRANCH}/Debian_${VERSION_ID}/ /' > /etc/apt/sources.list.d/kata-containers.list" - $ curl -sL http://download.opensuse.org/repositories/home:/katacontainers:/releases:/${ARCH}:/${BRANCH}/Debian_${VERSION_ID}/Release.key | sudo apt-key add - - $ sudo -E apt-get update - $ sudo -E apt-get -y install kata-runtime kata-proxy kata-shim - ``` - -2. Decide which container manager to use and select the corresponding link that follows: - - - [Docker](docker/debian-docker-install.md) - - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/docker/centos-docker-install.md b/docs/install/docker/centos-docker-install.md deleted file mode 100644 index b9902da4bd..0000000000 --- a/docs/install/docker/centos-docker-install.md +++ /dev/null @@ -1,75 +0,0 @@ -# Install Docker for Kata Containers on CentOS - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../centos-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 - $ sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo - $ sudo yum -y install docker-ce - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://docs.docker.com/engine/installation/linux/centos). - -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. diff --git a/docs/install/docker/debian-docker-install.md b/docs/install/docker/debian-docker-install.md deleted file mode 100644 index 662e0ecfaf..0000000000 --- a/docs/install/docker/debian-docker-install.md +++ /dev/null @@ -1,103 +0,0 @@ -# Install Docker for Kata Containers on Debian - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../debian-installation-guide.md). -> - This guide allows for installation with `systemd` or `sysVinit` init systems. - -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 - $ sudo apt-get -y install apt-transport-https ca-certificates curl gnupg2 software-properties-common - $ curl -fsSL https://download.docker.com/linux/$(. /etc/os-release; echo "$ID")/gpg | sudo apt-key add - - $ sudo add-apt-repository "deb https://download.docker.com/linux/$(. /etc/os-release; echo "$ID") $(lsb_release -cs) stable" - $ sudo apt-get update - $ sudo -E apt-get -y install docker-ce - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://docs.docker.com/engine/installation/linux/debian). - -2. Configure Docker to use Kata Containers by default with **ONE** of the following methods: - -a. `sysVinit` - - - with `sysVinit`, docker config is stored in `/etc/default/docker`, edit the options similar to the following: - - ```sh - $ sudo sh -c "echo '# specify docker runtime for kata-containers - DOCKER_OPTS=\"-D --add-runtime kata-runtime=/usr/bin/kata-runtime --default-runtime=kata-runtime\"' >> /etc/default/docker" - ``` - -b. 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 - ``` - -c. 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 one of the following (depending on init choice): - - a. `sysVinit` - - ```sh - $ sudo /etc/init.d/docker stop - $ sudo /etc/init.d/docker start - ``` - - To watch for errors: - - ```sh - $ tail -f /var/log/docker.log - ``` - - b. systemd - - ```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. diff --git a/docs/install/docker/fedora-docker-install.md b/docs/install/docker/fedora-docker-install.md deleted file mode 100644 index 51c629fc56..0000000000 --- a/docs/install/docker/fedora-docker-install.md +++ /dev/null @@ -1,77 +0,0 @@ -# Install Docker for Kata Containers on Fedora - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../fedora-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 - $ source /etc/os-release - $ sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo - $ sudo dnf makecache - $ sudo dnf -y install docker-ce - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://docs.docker.com/engine/installation/linux/fedora). - -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. diff --git a/docs/install/docker/opensuse-docker-install.md b/docs/install/docker/opensuse-docker-install.md deleted file mode 100644 index 0e126ae4cb..0000000000 --- a/docs/install/docker/opensuse-docker-install.md +++ /dev/null @@ -1,75 +0,0 @@ -# Install Docker for Kata Containers on openSUSE - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../opensuse-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 - $ sudo zypper -n install docker - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://software.opensuse.org/package/docker). - -2. Configure Docker to use Kata Containers by default with **ONE** of the following methods: - - 1. Specify the runtime options in `/etc/sysconfig/docker` (this is the default and is applied automatically if you select the - [automatic installation](../../install/README.md#automatic-installation) option) - - ```bash - $ DOCKER_SYSCONFIG=/etc/sysconfig/docker - # Add kata-runtime to the list of available runtimes, if not already listed - $ grep -qE "^ *DOCKER_OPTS=.+--add-runtime[= ] *kata-runtime" $DOCKER_SYSCONFIG || sudo -E sed -i -E "s|^( *DOCKER_OPTS=.+)\" *$|\1 --add-runtime kata-runtime=/usr/bin/kata-runtime\"|g" $DOCKER_SYSCONFIG - # If a current default runtime is specified, overwrite it with kata-runtime - $ sudo -E sed -i -E "s|^( *DOCKER_OPTS=.+--default-runtime[= ] *)[^ \"]+(.*\"$)|\1kata-runtime\2|g" $DOCKER_SYSCONFIG - # Add kata-runtime as default runtime, if no default runtime is specified - $ grep -qE "^ *DOCKER_OPTS=.+--default-runtime" $DOCKER_SYSCONFIG || sudo -E sed -i -E "s|^( *DOCKER_OPTS=.+)(\"$)|\1 --default-runtime=kata-runtime\2|g" $DOCKER_SYSCONFIG - ``` - - 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. diff --git a/docs/install/docker/sles-docker-install.md b/docs/install/docker/sles-docker-install.md deleted file mode 100644 index b11d5d8a06..0000000000 --- a/docs/install/docker/sles-docker-install.md +++ /dev/null @@ -1,74 +0,0 @@ -# Install Docker for Kata Containers on SLES - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../sle-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 - $ sudo zypper -n install docker - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://www.suse.com/documentation/sles-12/singlehtml/book_sles_docker/book_sles_docker.html). - -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. diff --git a/docs/install/docker/ubuntu-docker-install.md b/docs/install/docker/ubuntu-docker-install.md deleted file mode 100644 index d1cc494564..0000000000 --- a/docs/install/docker/ubuntu-docker-install.md +++ /dev/null @@ -1,79 +0,0 @@ -# Install Docker for Kata Containers on Ubuntu - -> **Note:** -> -> - This guide assumes you have -> [already installed the Kata Containers packages](../ubuntu-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 - $ sudo -E apt-get -y install apt-transport-https ca-certificates software-properties-common - $ curl -sL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - - $ arch=$(dpkg --print-architecture) - $ sudo -E add-apt-repository "deb [arch=${arch}] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" - $ sudo -E apt-get update - $ sudo -E apt-get -y install docker-ce - ``` - - For more information on installing Docker please refer to the - [Docker Guide](https://docs.docker.com/engine/installation/linux/ubuntu). - -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. diff --git a/docs/install/fedora-installation-guide.md b/docs/install/fedora-installation-guide.md index 47780dcd9a..cce1f25065 100644 --- a/docs/install/fedora-installation-guide.md +++ b/docs/install/fedora-installation-guide.md @@ -7,6 +7,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - - [Docker](docker/fedora-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/opensuse-installation-guide.md b/docs/install/opensuse-installation-guide.md index 6d13981354..02ce2aa8d3 100644 --- a/docs/install/opensuse-installation-guide.md +++ b/docs/install/opensuse-installation-guide.md @@ -7,5 +7,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - [Docker](docker/opensuse-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/opensuse-leap-15.1-installation-guide.md b/docs/install/opensuse-leap-15.1-installation-guide.md index ccfe7dc851..6affa6900e 100644 --- a/docs/install/opensuse-leap-15.1-installation-guide.md +++ b/docs/install/opensuse-leap-15.1-installation-guide.md @@ -8,5 +8,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - [Docker](docker/opensuse-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/sle-installation-guide.md b/docs/install/sle-installation-guide.md index 7e22396b33..ba7cff288c 100644 --- a/docs/install/sle-installation-guide.md +++ b/docs/install/sle-installation-guide.md @@ -10,6 +10,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - - [Docker](docker/sles-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes) diff --git a/docs/install/ubuntu-installation-guide.md b/docs/install/ubuntu-installation-guide.md index a3f97f8b99..29bb03883b 100644 --- a/docs/install/ubuntu-installation-guide.md +++ b/docs/install/ubuntu-installation-guide.md @@ -12,6 +12,4 @@ ``` 2. Decide which container manager to use and select the corresponding link that follows: - - - [Docker](docker/ubuntu-docker-install.md) - [Kubernetes](../Developer-Guide.md#run-kata-containers-with-kubernetes)