From 9d39362e30e7e988d21f6794677de99bb0c5f063 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Wed, 27 Apr 2022 19:01:21 +0200 Subject: [PATCH] kata-deploy: Reestructure the installing section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- tools/packaging/kata-deploy/README.md | 33 ++++++++++++++++----------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/tools/packaging/kata-deploy/README.md b/tools/packaging/kata-deploy/README.md index 088ebaae2..a1ef2b69b 100644 --- a/tools/packaging/kata-deploy/README.md +++ b/tools/packaging/kata-deploy/README.md @@ -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. @@ -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. @@ -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