github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-25 11:13:15 +00:00
Code Issues Projects Releases Wiki Activity

docs: Change install guides to use bash code blocks

Browse Source 
Change the installation guides so that all commands the user must type
use an explicit bash code block rather than a standard code block.

This adds meaning to the documents and will then allow us to extract
the commands and run them for testing purposes.

Fixes #92.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2018-05-17 15:21:06 +01:00
parent 6ae6e1ee1e
commit f3e454560e
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
install/fedora-installation-guide.md
View File

@ -6,7 +6,7 @@ Kata Containers is available for Fedora\* versions **26** and **27**.
This step is only required in case Docker is not installed on the system. This step is only required in case Docker is not installed on the system.
1. Install the latest version of Docker with the following commands: 1. Install the latest version of Docker with the following commands:
``` ```bash
$ sudo dnf -y install dnf-plugins-core $ sudo dnf -y install dnf-plugins-core
$ sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo $ sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo
$ sudo dnf makecache $ sudo dnf makecache
@ -18,7 +18,7 @@ For more information on installing Docker please refer to the
2. Install the Kata Containers components with the following commands: 2. Install the Kata Containers components with the following commands:
``` ```bash
$ source /etc/os-release $ source /etc/os-release
$ sudo -E VERSION_ID=$VERSION_ID dnf config-manager --add-repo \ $ sudo -E VERSION_ID=$VERSION_ID dnf config-manager --add-repo \
https://download.opensuse.org/repositories/home:/katacontainers:/release/Fedora\_$VERSION_ID/home:katacontainers:release.repo https://download.opensuse.org/repositories/home:/katacontainers:/release/Fedora\_$VERSION_ID/home:katacontainers:release.repo
@ -27,7 +27,7 @@ $ sudo -E dnf -y install kata-runtime kata-proxy kata-shim
3. Configure Docker to use Kata Containers by default with the following commands: 3. Configure Docker to use Kata Containers by default with the following commands:
``` ```bash
$ sudo mkdir -p /etc/systemd/system/docker.service.d/ $ sudo mkdir -p /etc/systemd/system/docker.service.d/
$ cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf $ cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf
[Service] [Service]
@ -38,7 +38,7 @@ EOF
4. Restart the Docker systemd service with the following commands: 4. Restart the Docker systemd service with the following commands:
``` ```bash
$ sudo systemctl daemon-reload $ sudo systemctl daemon-reload
$ sudo systemctl restart docker $ sudo systemctl restart docker
``` ```
@ -47,6 +47,6 @@ $ sudo systemctl restart docker
You are now ready to run Kata Containers: You are now ready to run Kata Containers:
``` ```bash
$ sudo docker run -ti busybox sh $ sudo docker run -ti busybox sh
``` ```

10
install/ubuntu-installation-guide.md
View File

@ -8,7 +8,7 @@ Currently Kata Containers is currently only build for x86_64.
This step is only required in case Docker is not installed on the system. This step is only required in case Docker is not installed on the system.
1. Install the latest version of Docker with the following commands: 1. Install the latest version of Docker with the following commands:
``` ```bash
$ sudo -E apt-get -y install apt-transport-https ca-certificates wget software-properties-common $ sudo -E apt-get -y install apt-transport-https ca-certificates wget software-properties-common
$ curl -sL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - $ curl -sL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ arch=$(dpkg --print-architecture) $ arch=$(dpkg --print-architecture)
@ -22,7 +22,7 @@ For more information on installing Docker please refer to the
2. Install the Kata Containers components with the following commands: 2. Install the Kata Containers components with the following commands:
``` ```bash
$ sudo sh -c "echo 'deb https://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/ /' >> /etc/apt/sources.list.d/kata-containers.list" $ sudo sh -c "echo 'deb https://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/ /' >> /etc/apt/sources.list.d/kata-containers.list"
$ curl -sL https://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/Release.key | sudo apt-key add - $ curl -sL https://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/Release.key | sudo apt-key add -
$ sudo -E apt-get update $ sudo -E apt-get update
@ -31,7 +31,7 @@ $ sudo -E apt-get -y install kata-runtime kata-proxy kata-shim
3. Configure Docker to use Kata Containers by default with the following commands: 3. Configure Docker to use Kata Containers by default with the following commands:
``` ```bash
$ sudo mkdir -p /etc/systemd/system/docker.service.d/ $ sudo mkdir -p /etc/systemd/system/docker.service.d/
$ cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf $ cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf
[Service] [Service]
@ -42,7 +42,7 @@ EOF
4. Restart the Docker systemd service with the following commands: 4. Restart the Docker systemd service with the following commands:
``` ```bash
$ sudo systemctl daemon-reload $ sudo systemctl daemon-reload
$ sudo systemctl restart docker $ sudo systemctl restart docker
``` ```
@ -51,6 +51,6 @@ $ sudo systemctl restart docker
You are now ready to run Kata Containers: You are now ready to run Kata Containers:
``` ```bash
$ sudo docker run -ti busybox sh $ sudo docker run -ti busybox sh
``` ```