docs: simplify running examples in README

dkoshkin · dkoshkin · commit db8c954c43f2 · 2024-03-04T19:36:39.000-08:00
diff --git a/README.md b/README.md
@@ -72,8 +72,13 @@ EOF
 To create an example cluster:
 
 ```shell
-clusterctl generate cluster docker-quick-start-helm-addon-cilium \
-  --from examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml \
+export CLUSTER_NAME=docker-cluster-cilium-helm-addon
+export CLUSTER_FILE=examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml
+```
+
+```shell
+clusterctl generate cluster ${CLUSTER_NAME} \
+  --from ${CLUSTER_FILE} \
   --kubernetes-version v1.29.1 \
   --worker-machine-count 1 | \
   kubectl apply --server-side -f -
@@ -82,33 +87,33 @@ clusterctl generate cluster docker-quick-start-helm-addon-cilium \
 Wait until control plane is ready:
 
 ```shell
-kubectl wait clusters/docker-quick-start-helm-addon-cilium --for=condition=ControlPlaneInitialized --timeout=5m
+kubectl wait clusters/${CLUSTER_NAME} --for=condition=ControlPlaneInitialized --timeout=5m
 ```
 
 To get the kubeconfig for the new cluster, run:
 
 ```shell
-clusterctl get kubeconfig docker-quick-start-helm-addon-cilium > docker-kubeconfig
+clusterctl get kubeconfig ${CLUSTER_NAME} > ${CLUSTER_NAME}.conf
 ```
 
 If you are not on Linux, you will also need to fix the generated kubeconfig's `server`, run:
 
 ```shell
-kubectl config set-cluster docker-quick-start-helm-addon-cilium \
-  --kubeconfig docker-kubeconfig \
-  --server=https://$(docker container port docker-quick-start-helm-addon-cilium-lb 6443/tcp)
+kubectl config set-cluster ${CLUSTER_NAME} \
+  --kubeconfig ${CLUSTER_NAME}.conf \
+  --server=https://$(docker container port ${CLUSTER_NAME}-lb 6443/tcp)
 ```
 
 Wait until all nodes are ready (this indicates that CNI has been deployed successfully):
 
 ```shell
-kubectl --kubeconfig docker-kubeconfig wait nodes --all --for=condition=Ready --timeout=5m
+kubectl --kubeconfig ${CLUSTER_NAME}.conf wait nodes --all --for=condition=Ready --timeout=5m
 ```
 
 Show that Cilium is running successfully on the workload cluster:
 
 ```shell
-kubectl --kubeconfig docker-kubeconfig get daemonsets -n kube-system cilium
+kubectl --kubeconfig ${CLUSTER_NAME}.conf get daemonsets -n kube-system cilium
 ```
 
 Deploy kube-vip to provide service load-balancer:
@@ -122,29 +127,29 @@ kubectl create configmap \
   --namespace kube-system kubevip \
   --from-literal "range-global=${kind_subnet_prefix}100.0-${kind_subnet_prefix}100.20" \
   --dry-run=client -oyaml |
-  kubectl --kubeconfig docker-kubeconfig apply --server-side -n kube-system -f -
+  kubectl --kubeconfig ${CLUSTER_NAME}.conf apply --server-side -n kube-system -f -
 
 helm upgrade kube-vip-cloud-provider kube-vip/kube-vip-cloud-provider --version 0.2.2 \
   --install \
   --wait --wait-for-jobs \
   --namespace kube-system \
-  --kubeconfig docker-kubeconfig \
+  --kubeconfig ${CLUSTER_NAME}.conf \
   --set-string=image.tag=v0.0.6
 
 helm upgrade kube-vip kube-vip/kube-vip --version 0.4.2 \
   --install \
   --wait --wait-for-jobs \
   --namespace kube-system \
-  --kubeconfig docker-kubeconfig \
+  --kubeconfig ${CLUSTER_NAME}.conf \
   --set-string=image.tag=v0.6.0
 ```
 
 Deploy traefik as a LB service:
 
 ```shell
-helm --kubeconfig docker-kubeconfig repo add traefik https://helm.traefik.io/traefik
+helm --kubeconfig ${CLUSTER_NAME}.conf repo add traefik https://helm.traefik.io/traefik
 helm repo update &>/dev/null
-helm --kubeconfig docker-kubeconfig upgrade --install traefik traefik/traefik \
+helm --kubeconfig ${CLUSTER_NAME}.conf upgrade --install traefik traefik/traefik \
   --version v10.9.1 \
   --wait --wait-for-jobs \
   --set ports.web.hostPort=80 \
@@ -155,13 +160,13 @@ helm --kubeconfig docker-kubeconfig upgrade --install traefik traefik/traefik \
 Watch for traefik LB service to get an external address:
 
 ```shell
-watch -n 0.5 kubectl --kubeconfig docker-kubeconfig get service/traefik
+watch -n 0.5 kubectl --kubeconfig ${CLUSTER_NAME}.conf get service/traefik
 ```
 
 To delete the workload cluster, run:
 
 ```shell
-kubectl delete cluster docker-quick-start-helm-addon-cilium
+kubectl delete cluster ${CLUSTER_NAME}
 ```
 
 Notice that the traefik service is deleted before the cluster is actually finally deleted.
diff --git a/examples/capi-quick-start/aws-cluster-calico-crs.yaml b/examples/capi-quick-start/aws-cluster-calico-crs.yaml
@@ -53,3 +53,15 @@ spec:
         - class: default-worker
           name: md-0
           replicas: ${WORKER_MACHINE_COUNT}
+---
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSClusterStaticIdentity
+metadata:
+  labels:
+    cluster.x-k8s.io/provider: aws
+  name: ${CLUSTER_NAME}
+spec:
+  allowedNamespaces:
+    list:
+      - default
+  secretRef: aws-quick-start-creds
diff --git a/examples/capi-quick-start/aws-cluster-calico-helm-addon.yaml b/examples/capi-quick-start/aws-cluster-calico-helm-addon.yaml
@@ -53,3 +53,15 @@ spec:
         - class: default-worker
           name: md-0
           replicas: ${WORKER_MACHINE_COUNT}
+---
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSClusterStaticIdentity
+metadata:
+  labels:
+    cluster.x-k8s.io/provider: aws
+  name: ${CLUSTER_NAME}
+spec:
+  allowedNamespaces:
+    list:
+      - default
+  secretRef: aws-quick-start-creds
diff --git a/examples/capi-quick-start/aws-cluster-cilium-crs.yaml b/examples/capi-quick-start/aws-cluster-cilium-crs.yaml
@@ -53,3 +53,15 @@ spec:
         - class: default-worker
           name: md-0
           replicas: ${WORKER_MACHINE_COUNT}
+---
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSClusterStaticIdentity
+metadata:
+  labels:
+    cluster.x-k8s.io/provider: aws
+  name: ${CLUSTER_NAME}
+spec:
+  allowedNamespaces:
+    list:
+      - default
+  secretRef: aws-quick-start-creds
diff --git a/examples/capi-quick-start/aws-cluster-cilium-helm-addon.yaml b/examples/capi-quick-start/aws-cluster-cilium-helm-addon.yaml
@@ -53,3 +53,15 @@ spec:
         - class: default-worker
           name: md-0
           replicas: ${WORKER_MACHINE_COUNT}
+---
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSClusterStaticIdentity
+metadata:
+  labels:
+    cluster.x-k8s.io/provider: aws
+  name: ${CLUSTER_NAME}
+spec:
+  allowedNamespaces:
+    list:
+      - default
+  secretRef: aws-quick-start-creds
diff --git a/examples/capi-quick-start/aws-cluster-identity.yaml b/examples/capi-quick-start/aws-cluster-identity.yaml
diff --git a/hack/examples/bases/aws/AWSClusterStaticIdentity.yaml b/hack/examples/bases/aws/AWSClusterStaticIdentity.yaml
@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 ---
-apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
 kind: AWSClusterStaticIdentity
 metadata:
   name: "quick-start"
diff --git a/hack/examples/sync.sh b/hack/examples/sync.sh
@@ -19,7 +19,6 @@ mkdir -p "${EXAMPLE_CLUSTERCLASSES_DIR}"
 readonly EXAMPLE_CLUSTERS_DIR=examples/capi-quick-start
 mkdir -p "${EXAMPLE_CLUSTERS_DIR}"
 
-mkdir -p examples/capi-quick-start
 # Sync ClusterClasses (including Templates) and Clusters to separate files.
 kustomize build ./hack/examples |
   tee \
@@ -68,37 +67,32 @@ kustomize build ./hack/examples |
                                       )' >"${EXAMPLE_CLUSTERCLASSES_DIR}/aws-cluster-class.yaml"
     ) \
     >(
-      gojq --yaml-input --yaml-output 'select(.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
+      gojq --yaml-input --yaml-output 'select((.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
                                         and .kind == "Cluster"
                                         and .spec.topology.variables[0].value.addons.cni.provider == "Calico"
                                         and .spec.topology.variables[0].value.addons.cni.strategy == "ClusterResourceSet"
-                                      )' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-calico-crs.yaml"
+                                        ) or .kind == "AWSClusterStaticIdentity")' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-calico-crs.yaml"
     ) \
     >(
-      gojq --yaml-input --yaml-output 'select(.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
+      gojq --yaml-input --yaml-output 'select((.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
                                         and .kind == "Cluster"
                                         and .spec.topology.variables[0].value.addons.cni.provider == "Calico"
                                         and .spec.topology.variables[0].value.addons.cni.strategy == "HelmAddon"
-                                      )' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-calico-helm-addon.yaml"
+                                      ) or .kind == "AWSClusterStaticIdentity")' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-calico-helm-addon.yaml"
     ) \
     >(
-      gojq --yaml-input --yaml-output 'select(.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
+      gojq --yaml-input --yaml-output 'select((.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
                                         and .kind == "Cluster"
                                         and .spec.topology.variables[0].value.addons.cni.provider == "Cilium"
                                         and .spec.topology.variables[0].value.addons.cni.strategy == "ClusterResourceSet"
-                                      )' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-cilium-crs.yaml"
+                                      ) or .kind == "AWSClusterStaticIdentity")' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-cilium-crs.yaml"
     ) \
     >(
-      gojq --yaml-input --yaml-output 'select(.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
+      gojq --yaml-input --yaml-output 'select((.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
                                         and .kind == "Cluster"
                                         and .spec.topology.variables[0].value.addons.cni.provider == "Cilium"
                                         and .spec.topology.variables[0].value.addons.cni.strategy == "HelmAddon"
-                                      )' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-cilium-helm-addon.yaml"
-    ) \
-    >(
-      gojq --yaml-input --yaml-output 'select(.metadata.labels["cluster.x-k8s.io/provider"] == "aws"
-                                        and .kind == "AWSClusterStaticIdentity"
-                                      )' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-identity.yaml"
+                                      ) or .kind == "AWSClusterStaticIdentity")' >"${EXAMPLE_CLUSTERS_DIR}/aws-cluster-cilium-helm-addon.yaml"
     ) \
     >/dev/null
 
