Skip to content

Commit

Permalink
kata-deploy: Reestructure the installing section
Browse files Browse the repository at this point in the history
Let's move the specific installation instructions, such as for k3s,
upper in the document.

This helps reading (and also skipping) according to what the user
is looking for.

Signed-off-by: Fabiano Fidêncio <fabiano@fidencio.org>
  • Loading branch information
fidencio committed Apr 27, 2022
1 parent 18d27f7 commit 9d39362
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions tools/packaging/kata-deploy/README.md
Expand Up @@ -11,7 +11,25 @@ be utilized to install Kata Containers on a running Kubernetes cluster.

### Install Kata on a running Kubernetes cluster

#### Installing the latest image
#### k3s cluster

For your [k3s](https://k3s.io/) cluster, run:

```sh
$ git clone github.com/kata-containers/kata-containers
```

Check and switch to the stable branch of your choice, if wanted, and then run:

```bash
$ cd kata-containers/kata-containers/tools/packaging/kata-deploy
$ kubectl apply -f kata-rbac/base/kata-rbac.yaml
$ kubectl apply -k kata-deploy/overlays/k3s
```

#### Vanilla Kubernetes cluster

##### Installing the latest image

The latest image refers to pre-release and release candidate content. For stable releases, please, use the "stable" instructions.

Expand All @@ -20,7 +38,7 @@ $ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-contai
$ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-containers/main/tools/packaging/kata-deploy/kata-deploy/base/kata-deploy.yaml
```

#### Installing the stable image
##### Installing the stable image

The stable image refers to the last stable releases content.

Expand All @@ -32,17 +50,6 @@ $ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-contai
$ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-containers/main/tools/packaging/kata-deploy/kata-deploy/base/kata-deploy-stable.yaml
```

#### For your [k3s](https://k3s.io/) cluster, do:

```sh
$ GO111MODULE=auto go get github.com/kata-containers/kata-containers
```

```bash
$ cd $GOPATH/src/github.com/kata-containers/kata-containers/tools/packaging/kata-deploy
$ kubectl apply -k kata-deploy/overlays/k3s
```

#### Ensure kata-deploy is ready
```bash
$ kubectl -n kube-system wait --timeout=10m --for=condition=Ready -l name=kata-deploy pod
Expand Down

0 comments on commit 9d39362

Please sign in to comment.