diff --git a/.github/workflows/run-test-cases.yml b/.github/workflows/run-test-cases.yml index 5146cf700..23492c7ff 100644 --- a/.github/workflows/run-test-cases.yml +++ b/.github/workflows/run-test-cases.yml @@ -91,12 +91,15 @@ jobs: kube-runtime: - K3s-1.18 - K3s-1.19 + - K3s-1.20 - MicroK8s-1.18 - MicroK8s-1.19 + - MicroK8s-1.20 - Kubernetes-1.16 - Kubernetes-1.17 - Kubernetes-1.18 - Kubernetes-1.19 + - Kubernetes-1.20 test-case: - end-to-end include: @@ -104,10 +107,14 @@ jobs: kube-version: 1.18/stable - kube-runtime: MicroK8s-1.19 kube-version: 1.19/stable + - kube-runtime: MicroK8s-1.20 + kube-version: 1.20/stable - kube-runtime: K3s-1.18 kube-version: v1.18.9+k3s1 - kube-runtime: K3s-1.19 kube-version: v1.19.4+k3s1 + - kube-runtime: K3s-1.20 + kube-version: v1.20.0+k3s2 - kube-runtime: Kubernetes-1.16 kube-version: 1.16.15-00 - kube-runtime: Kubernetes-1.17 @@ -116,6 +123,8 @@ jobs: kube-version: 1.18.12-00 - kube-runtime: Kubernetes-1.19 kube-version: 1.19.4-00 + - kube-runtime: Kubernetes-1.20 + kube-version: 1.20.1-00 - test-case: end-to-end test-file: test/run-end-to-end.py diff --git a/docs/user-guide.md b/docs/user-guide.md index aba2abaae..b8de8321b 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -40,10 +40,18 @@ helm install akri akri-helm-charts/akri ``` 1. Provide runtime-specific configuration to enable Akri and Helm - 1. If using **K3s**, point to `kubeconfig` for Helm and configure Akri to use the K3s embedded crictl. + 1. If using **K3s**, point to `kubeconfig` for Helm, install crictl, and configure Akri to use K3s' CRI socket. ```sh + # Install crictl locally (note: there are no known version limitations, any crictl version is expected to work). + # This step is not necessary if using a K3s version below 1.19, in which case K3s' embedded crictl can be used. + VERSION="v1.17.0" + curl -L https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/crictl-${VERSION}-linux-amd64.tar.gz --output crictl-${VERSION}-linux-amd64.tar.gz + sudo tar zxvf crictl-$VERSION-linux-amd64.tar.gz -C /usr/local/bin + rm -f crictl-$VERSION-linux-amd64.tar.gz + # Helm uses $KUBECONFIG to find the Kubernetes configuration export KUBECONFIG=/etc/rancher/k3s/k3s.yaml + # Configure Akri to use K3s' embedded crictl and CRI socket export AKRI_HELM_CRICTL_CONFIGURATION="--set agent.host.crictl=/usr/local/bin/crictl --set agent.host.dockerShimSock=/run/k3s/containerd/containerd.sock" ```