Skip to content

Commit

Permalink
docs: Add OBS package installation guide for openSUSE
Browse files Browse the repository at this point in the history
This is the installation guide for OBS packages for
openSUSE.

Fixes #160

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
  • Loading branch information
GabyCT committed Aug 15, 2018
1 parent b1c3c58 commit a2d8370
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 0 deletions.
1 change: 1 addition & 0 deletions install/README.md
Expand Up @@ -22,6 +22,7 @@ Select your preferred distribution or cloud service:
* [CentOS](centos-installation-guide.md)
* [Fedora](fedora-installation-guide.md)
* [Red Hat](rhel-installation-guide.md)
* [OpenSuse] (opensuse-installation-guide.md)
* [Ubuntu](ubuntu-installation-guide.md)

### Cloud services
Expand Down
71 changes: 71 additions & 0 deletions install/docker/opensuse-docker-install.md
@@ -0,0 +1,71 @@
# Install Docker for Kata Containers on openSUSE Leap

> **Note:**
>
> - This guide assumes you have
> [already installed the Kata Containers packages](../opensuse-installation-guide.md).
>
> - If you do not want to copy or type all these instructions by hand, you can use the
> [`kata-manager`](https://github.com/kata-containers/tests/blob/master/cmd/kata-manager/kata-manager.sh)
> script to install the packaged system including your chosen container
> manager. Alternatively, you can generate a runnable shell script from
> individual documents using the
> [`kata-doc-to-script`](https://github.com/kata-containers/tests/blob/master/.ci/kata-doc-to-script.sh) script.
1. Install the latest version of Docker with the following commands:

> **Note:** This step is only required if Docker is not installed on the system.
```bash
$ sudo zypper -n install libcgroup1
$ 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. systemd

```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 --containerd /run/containerd/containerd.sock --add-runtime kata-runtime=/usr/bin/kata-runtime --default-runtime=kata-runtime
EOF
```
2. Docker `daemon.json`
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.
32 changes: 32 additions & 0 deletions install/opensuse-installation-guide.md
@@ -0,0 +1,32 @@
# Install Kata Containers on openSUSE Leap

> **Notes:**
>
> - Kata Containers packages are available for [openSUSE\*](https://www.opensuse.org/)
> version 43.2 (currently `x86_64` only).
>
> - If you are installing on a system that already has Clear Containers or `runv` installed,
> first read [the upgrading document](../Upgrading.md).
>
> - If you do not want to copy or type all these instructions by hand, you can use the
> [`kata-manager`](https://github.com/kata-containers/tests/blob/master/cmd/kata-manager/kata-manager.sh)
> script to install the packaged system including your chosen container
> manager. Alternatively, you can generate a runnable shell script from
> individual documents using the
> [`kata-doc-to-script`](https://github.com/kata-containers/tests/blob/master/.ci/kata-doc-to-script.sh) script.
1. Install the Kata Containers components with the following commands:

> **Note:** This installation channel is not secure since the repository currently
> redirects download URLs to `http`.
```bash
$ source /etc/os-release
$ sudo -E VERSION_ID=$VERSION_ID zypper addrepo "http://download.opensuse.org/repositories/home:/katacontainers:/release/openSUSE_Leap_${VERSION_ID}/home:katacontainers:release.repo"
$ sudo -E zypper -n --no-gpg-checks install kata-runtime kata-proxy kata-shim
```

2. Decide which container manager to use and select the corresponding link that follows:

- [Docker](docker/opensuse-docker-install.md)
- [Kubernetes](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#run-kata-containers-with-kubernetes)

0 comments on commit a2d8370

Please sign in to comment.