London KubeCon workshop (#11)

Add London KubeCon kcp workshop

Author: mjudeikis

.gitignore

@@ -22,3 +22,10 @@
 
 # Go workspace file
 go.work
+*.kubeconfig
+
+**/.kcp
+**/bin
+**.tar.gz
+kcp-operator
+.checkpoint-**

20250401-kubecon-london/workshop/00-prerequisites/01-install.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+export GOOS="$( uname | tr '[:upper:]' '[:lower:]' | grep -E 'linux|darwin' )"
+export GOARCH="$( uname -m | sed 's/x86_64/amd64/ ; s/aarch64/arm64/' | grep -E 'amd64|arm64' )"
+
+set -o errexit
+
+[[ -n "${GOOS}" ]] || { echo "Unsupported OS: $(uname)" 1>&2 ; exit 1 ; }
+[[ -n "${GOARCH}" ]] || { echo "Unsupported platform: $(uname -m)" 1>&2 ; exit 1 ; }
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-kcp" ]]; then
+  echo "🚀 Downloading kcp"
+  curl -L "https://github.com/kcp-dev/kcp/releases/download/v0.26.1/kcp_0.26.1_${GOOS}_${GOARCH}.tar.gz" \
+    | tar -C "${WORKSHOP_ROOT}" -xzf - bin/kcp
+  touch "${WORKSHOP_ROOT}/bin/.checkpoint-kcp"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-api-syncagent" ]]; then
+    echo "🚀 Downloading api-syncagent"
+    curl -L "https://github.com/kcp-dev/api-syncagent/releases/download/v0.2.0-alpha.1/api-syncagent_0.2.0-alpha.1_${GOOS}_${GOARCH}.tar.gz" \
+      | tar -C "${WORKSHOP_ROOT}/bin" -xzf - api-syncagent
+    touch "${WORKSHOP_ROOT}/bin/.checkpoint-api-syncagent"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-mcp-example-crd" ]]; then
+    echo "🚀 Downloading KCP's mcp-example-crd"
+    curl -L "https://github.com/mjudeikis/kcp-multicluster-provider-example/releases/download/v0.0.4/kcp-multicluster-provider-example_0.0.4_${GOOS}_${GOARCH}.tar.gz" \
+      | tar -C "${WORKSHOP_ROOT}/bin" -xzf - mcp-example-crd
+    touch "${WORKSHOP_ROOT}/bin/.checkpoint-mcp-example-crd"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-kind" ]]; then
+  echo "🚀 Downloading kind"
+  curl -Lo "${WORKSHOP_ROOT}/bin/kind" "https://github.com/kubernetes-sigs/kind/releases/download/v0.27.0/kind-${GOOS}-${GOARCH}"
+  chmod +x "${WORKSHOP_ROOT}/bin/kind"
+  touch "${WORKSHOP_ROOT}/bin/.checkpoint-kind"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-kubectl" ]]; then
+  echo "🚀 Downloading kubectl"
+  curl -Lo "${WORKSHOP_ROOT}/bin/kubectl" "https://dl.k8s.io/v1.31.7/bin/${GOOS}/${GOARCH}/kubectl"
+  chmod +x "${WORKSHOP_ROOT}/bin/kubectl"
+  touch "${WORKSHOP_ROOT}/bin/.checkpoint-kubectl"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-kubectl-krew" ]]; then
+  echo "🚀 Downloading kubectl-krew"
+  curl -L "https://github.com/kubernetes-sigs/krew/releases/latest/download/krew-${GOOS}_${GOARCH}.tar.gz" \
+    | tar -xzf - --strip-components=1 -C "${WORKSHOP_ROOT}/bin" "./krew-${GOOS}_${GOARCH}"
+  mv "${WORKSHOP_ROOT}/bin/krew-${GOOS}_${GOARCH}" "${WORKSHOP_ROOT}/bin/kubectl-krew"
+  touch "${WORKSHOP_ROOT}/bin/.checkpoint-kubectl-krew"
+fi
+
+if [[ ! -f "${WORKSHOP_ROOT}/bin/.checkpoint-jq" ]]; then
+  os="${GOOS}"
+  [[ "${os}" == "darwin" ]] && os="macos"
+  echo "🚀 Downloading jq"
+  curl -Lo "${WORKSHOP_ROOT}/bin/jq" "https://github.com/jqlang/jq/releases/download/jq-1.7.1/jq-${os}-${GOARCH}"
+  chmod +x "${WORKSHOP_ROOT}/bin/jq"
+  touch "${WORKSHOP_ROOT}/bin/.checkpoint-jq"
+fi
+
+"${EXERCISE_DIR}/99-highfive.sh"

20250401-kubecon-london/workshop/00-prerequisites/99-highfive.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+source "${WORKSHOP_ROOT}/lib/ensure.sh"
+
+function check_in_path {
+  prog="${1}"
+  args="${@:2}"
+  ensure::eval_with_msg "${prog} ${args}" \
+    "'${prog}' looks good!" \
+    "It seems '${prog}' is not available :(\n\tTIP: Make sure it's installed and available in your \$PATH or ${WORKSHOP_ROOT}/bin."
+}
+
+check_in_path "kcp" "--version"
+check_in_path "kind" "version"
+check_in_path "kubectl" "version --client"
+check_in_path "kubectl-krew" "version"
+check_in_path "mcp-example-crd" "-h" 2> /dev/null
+check_in_path "jq" "-h"
+
+touch "${WORKSHOP_ROOT}/.checkpoint-00"
+printf "\n\t🥳 High-five! Move onto the first exercise!\n\n"

20250401-kubecon-london/workshop/00-prerequisites/README.md

@@ -0,0 +1,64 @@
+---
+title: "00: Setting up your development environment"
+---
+# Pre-requisites
+
+In this chapter we'll set up our workshop-dedicated development environment.
+
+## Cloning the workshop repo
+
+Start by cloning the git repository we'll refer to throughout the workshop, and will be the place for the binaries, scripts and kubeconfigs we will create as we move forward.
+
+Important: We will need 4 terminal windows for long running programs & interactions to the same underlaying machine during this workshop.
+
+```shell
+git clone -b mjudeikis/kubecon.eu.workshop https://github.com/mjudeikis/kcp-contrib.git
+cd 20250401-kubecon-london/workshop/
+```
+
+Now, let's see what's inside.
+
+* `00-prerequisites/`
+* `01-deploy-kcp/`
+* `02-explore-workspaces/`
+* `03-dynamic-providers/`
+* `clean-all.sh`
+
+Notice the exercises in directories `<Sequence number>-<Exercise name>`. These are to be visited in sequence, and to complete one, all previous exercises need to be completed first to bring the system into the desired state. While it's best if you try to follow the tasks by yourself, if you ever get stuck, you can finish an exercise by running the scripts inside the respective exercise directory.
+
+Also take a note of the `clean-all.sh` script. If you ever get stuck and want to reset, run it and it will clean up and stop processes and containers used in the exercises.
+
+## Get your bins
+
+This one is easy. During the workshop we will make use of these programs:
+
+* [kcp](https://github.com/kcp-dev/kcp/releases/latest),
+* kcp's [api-syncagent](https://github.com/kcp-dev/api-syncagent/releases/latest),
+* kcp's [multicluster-controller runtime example binary](kcp-multicluster-provider-example),
+* [kind](https://github.com/kubernetes-sigs/kind/releases/latest),
+* [kubectl](https://kubernetes.io/docs/tasks/tools/),
+* and, [kubectl-krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/).
+
+You may visit the links, download and extract the respective binaries to a new directory called `bin/` in the workshop's root (e.g., `$WORKSHOP/bin/kubectl`). If you already have some of these installed and available in your `$PATH`, you may skip them--just make sure they are up-to-date.
+
+Alternatively, we've prepared a script that does just that:
+
+```shell
+00-prerequisites/01-install.sh
+```
+
+If you're going the manual way, please make sure the file names are stripped of OS and arch names they may contain (e.g. `mv kubectl-krew-linux_amd64 kubectl-krew`), as we'll refer to them using their system-agnostic names later on.
+
+And that's it!
+
+---
+
+## High-five! 🚀🚀🚀
+
+Done already? High-five! Check-in your completion with:
+
+```shell
+00-prerequisites/99-highfive.sh
+```
+
+If there were no errors, you may continue with the next exercise.

20250401-kubecon-london/workshop/01-deploy-kcp/01-start-kcp.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+set -o errexit
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+
+[[ -f "${WORKSHOP_ROOT}/.checkpoint-00" ]] || { printf "\n\t📜 You need to complete the previous exercise!\n\n" ; exit 1 ; }
+
+function try_with_timeout {
+  attempts=15
+  while [[ "${attempts}" -gt 0 ]]; do
+    kubectl version &> /dev/null && return
+    sleep 5
+    attempts=$((attempts-1))
+  done
+  printf "\n\t❌kcp takes too long to start, maybe something is wrong?\n"
+  exit 1
+}
+
+pgrep kcp &> /dev/null && { "${EXERCISE_DIR}/99-highfive.sh" ; exit $? ; }
+
+cd "${WORKSHOP_ROOT}"
+
+kcp start & kcp_pid=$!
+trap 'kill -TERM ${kcp_pid}' TERM INT EXIT
+export KUBECONFIG="${WORKSHOP_ROOT}/.kcp/admin.kubeconfig"
+try_with_timeout
+
+mkdir -p "${KUBECONFIGS_DIR}"
+
+cp "${WORKSHOP_ROOT}/.kcp/admin.kubeconfig" "${KUBECONFIGS_DIR}/admin.kubeconfig"
+cp "${WORKSHOP_ROOT}/.kcp/admin.kubeconfig" "${KUBECONFIGS_DIR}/internal-checkscript.kubeconfig"
+cp "${WORKSHOP_ROOT}/.kcp/admin.kubeconfig" "${KUBECONFIGS_DIR}/sync-agent.kubeconfig"
+cp "${WORKSHOP_ROOT}/.kcp/admin.kubeconfig" "${KUBECONFIGS_DIR}/mcp-controller.kubeconfig"
+
+"${EXERCISE_DIR}/99-highfive.sh"
+wait "${kcp_pid}"

20250401-kubecon-london/workshop/01-deploy-kcp/99-highfive.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+source "${WORKSHOP_ROOT}/lib/ensure.sh"
+
+[[ -f "${WORKSHOP_ROOT}/.checkpoint-00" ]] || { printf "\n\t📜 You need to complete the previous exercise!\n\n" ; exit 1 ; }
+
+ensure::process_exists "kcp"
+ensure::exists_in_kubeconfigs_dir "admin.kubeconfig"
+ensure::internal_checkscript_kubeconfig
+export KUBECONFIG="${KUBECONFIGS_DIR}/internal-checkscript.kubeconfig"
+ensure::eval_with_msg "kubectl version" "kcp is reachable!" "It seems kcp is down :("
+
+touch "${WORKSHOP_ROOT}/.checkpoint-01"
+printf "\n\t🥳 High-five! Move onto the second exercise!\n\n"

20250401-kubecon-london/workshop/01-deploy-kcp/README.md

@@ -0,0 +1,93 @@
+---
+title: "01: Deploying kcp"
+---
+# Deploy kcp
+
+kcp may be deployed via a [Helm chart](https://github.com/kcp-dev/helm-charts), an [operator](https://github.com/kcp-dev/helm-charts), or as a standalone process running on the host. Each of them has its uses as well as advantages and disadvantages. While the most preferable way to deploy kcp is using its dedicated operator, for the sake of simplicity, we've taken the liberty of making the choice for you :) .
+
+## Starting kcp as a standalone process
+
+!!! Important
+
+    **Attention**: during these exercises, we'll be making heavy use of environment variables. We will be switching back and forth between clusters, as well as needing access to the binaries we've set up in the previous chapter. Whenever you see this block, it means we are switching an environment. Make sure you `cd` into the workshop git repo, and copy-paste the commands to your terminal. Let's give it a try!
+
+
+!!! Important
+
+    === "Bash/ZSH"
+
+        ```shell
+        export WORKSHOP_ROOT="$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop"
+        export PATH="${WORKSHOP_ROOT}/bin:${PATH}"
+        ```
+
+    === "Fish"
+
+        ```fish
+        set WORKSHOP_ROOT (git rev-parse --show-toplevel)/20250401-kubecon-london/workshop
+        set PATH $WORKSHOP_ROOT/bin $PATH
+        ```
+
+Starting kcp in standalone mode is as easy as typing `kcp start` and pressing Enter.
+
+```shell
+cd $WORKSHOP_ROOT && kcp start
+```
+
+
+You should see the program running indefinitely, and outputting its logs--starting with some errors that should clean up in a couple of seconds as the different controllers start up. Leave the terminal window open, as we will keep using this kcp instance throughout the duration of the workshop. In this mode, all kcp's state is in-memory only. That means exiting the process (by, for example, pressing _Ctrl+C_ in this terminal), will lose all its etcd contents.
+
+Once kcp's output seems stable, we can start making simple kubectl calls against it. `kcp start` creates a hidden directory `.kcp`, where it places its kubeconfig and the certificates.
+
+Open a new terminal (termianl 2, same 01-deploy-kcp directory) now.
+
+!!! Important
+
+    === "Bash/ZSH"
+
+        ```shell
+        export WORKSHOP_ROOT="$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop"
+        export KUBECONFIG="${WORKSHOP_ROOT}/.kcp/admin.kubeconfig"
+        ```
+
+    === "Fish"
+
+        ```fish
+        set WORKSHOP_ROOT (git rev-parse --show-toplevel)/20250401-kubecon-london/workshop
+        set KUBECONFIG $WORKSHOP_ROOT/.kcp/admin.kubeconfig"
+        ```
+
+The following command should work now:
+
+```shell-session
+$ kubectl version
+Client Version: v1.32.1
+Kustomize Version: v5.5.0
+Server Version: v1.31.0+kcp-v0.26.1
+```
+
+We'll have a couple more kubeconfigs to switch between, and it will be convenient to have them all in one place. Let's do that now:
+
+```shell
+mkdir -p $WORKSHOP_ROOT/kubeconfigs
+ln -s $KUBECONFIG $WORKSHOP_ROOT/kubeconfigs
+```
+
+And that's it!
+
+---
+
+## High-five! 🚀🚀🚀
+
+Finished? High-five! Check-in your completion with:
+
+```shell
+01-deploy-kcp/99-highfive.sh
+```
+
+If there were no errors, you may continue with the next exercise.
+
+### Cheat-sheet
+
+You may fast-forward through this exercise by running:
+* `01-deploy-kcp/01-start-kcp.sh` in a new terminal

20250401-kubecon-london/workshop/02-explore-workspaces/00-install-krew-plugins.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+set -o errexit
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+
+[[ -f "${WORKSHOP_ROOT}/.checkpoint-01" ]] || { printf "\n\t📜 You need to complete the previous exercise!\n\n" ; exit 1 ; }
+
+[[ -z "$(kubectl krew index list | grep 'github.com/kcp-dev/krew-index.git')" ]] \
+  && kubectl krew index add kcp-dev https://github.com/kcp-dev/krew-index.git
+
+kubectl krew install kcp-dev/kcp
+kubectl krew install kcp-dev/ws
+kubectl krew install kcp-dev/create-workspace
+
+# IMPORTANT HACK: https://github.com/kubernetes-sigs/krew/issues/865
+cp $(which kubectl-create_workspace) $KREW_ROOT/bin/kubectl-create-workspace
+
+printf "\n\t🥳 krew plugins installed successfully! Continue with the next step, creating provider APIs! 💪\n\n"

20250401-kubecon-london/workshop/02-explore-workspaces/01-create-apis.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+set -o errexit
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+source "${WORKSHOP_ROOT}/lib/kubectl.sh"
+export KUBECONFIG="${KUBECONFIGS_DIR}/admin.kubeconfig"
+
+[[ -f "${WORKSHOP_ROOT}/.checkpoint-01" ]] || { printf "\n\t📜 You need to complete the previous exercise!\n\n" ; exit 1 ; }
+
+::kubectl::ws::use ":"
+
+::kubectl::ws::create_enter "providers" "root:organization"
+::kubectl::ws::create_enter "cowboys" "root:universal"
+
+::kubectl::create_from_file "${EXERCISE_DIR}/apis/apiresourceschema.yaml"
+::kubectl::create_from_file "${EXERCISE_DIR}/apis/apiexport.yaml"
+
+printf "\n\t🥳 Provider APIs created successfully! Continue with the next step, creating consumers! 💪\n\n"

20250401-kubecon-london/workshop/02-explore-workspaces/02-create-consumers.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o pipefail
+set -o errexit
+
+source "$(git rev-parse --show-toplevel)/20250401-kubecon-london/workshop/lib/env.sh" "$(cd "$(dirname "$0")" && pwd)"
+source "${WORKSHOP_ROOT}/lib/kubectl.sh"
+export KUBECONFIG="${KUBECONFIGS_DIR}/admin.kubeconfig"
+
+[[ -f "${WORKSHOP_ROOT}/.checkpoint-01" ]] || { printf "\n\t📜 You need to complete the previous exercise!\n\n" ; exit 1 ; }
+
+::kubectl::ws::use ":"
+
+::kubectl::ws::create_enter "consumers" "root:organization"
+::kubectl::ws::create_enter "wild-west" "root:universal"
+::kubectl::kcp::bind_with_permission_claims "root:providers:cowboys" "cowboys" "cowboys-consumer" "configmaps.core" ""
+
+::kubectl::create_from_file "${EXERCISE_DIR}/apis/consumer-wild-west.yaml"
+
+::kubectl::ws::use :root:consumers
+::kubectl::ws::create_enter "wild-north" "root:universal"
+::kubectl::kcp::bind_with_permission_claims "root:providers:cowboys" "cowboys" "cowboys-consumer" "configmaps.core" ""
+::kubectl::create_from_file "${EXERCISE_DIR}/apis/consumer-wild-north.yaml"
+
+"${EXERCISE_DIR}/99-highfive.sh"