Merge pull request #6254 from Jont828/tilt-flavors

✨ Add support for deploying Cluster templates and ClusterClasses on Tilt

Author: k8s-ci-robot

Tiltfile

@@ -1,6 +1,13 @@
 # -*- mode: Python -*-
 
-load("ext://uibutton", "cmd_button", "text_input")
+envsubst_cmd = "./hack/tools/bin/envsubst"
+clusterctl_cmd = "./bin/clusterctl"
+kubectl_cmd = "kubectl"
+
+if str(local("command -v " + kubectl_cmd + " || true", quiet = True)) == "":
+    fail("Required command '" + kubectl_cmd + "' not found in PATH")
+
+load("ext://uibutton", "cmd_button", "location", "text_input")
 
 # set defaults
 version_settings(True, ">=0.22.2")
@@ -108,6 +115,9 @@ COPY --from=tilt-helper /usr/bin/kubectl /usr/bin/kubectl
     },
 }
 
+def ensure_clusterctl():
+    local("make clusterctl")
+
 # Reads a provider's tilt-provider.json file and merges it into the providers map.
 # A list of dictionaries is also supported by enclosing it in brackets []
 # An example file looks like this:
@@ -388,10 +398,110 @@ def prepare_all():
     )
     local(cmd, env = settings.get("kustomize_substitutions", {}))
 
+# create cluster template resources from cluster-template files in the templates directory
+def cluster_templates():
+    substitutions = settings.get("kustomize_substitutions", {})
+
+    template_dirs = settings.get("template_dirs", {
+        "docker": ["./test/infrastructure/docker/templates"],
+    })
+
+    for provider, provider_dirs in template_dirs.items():
+        for template_dir in provider_dirs:
+            template_list = [filename for filename in listdir(template_dir) if os.path.basename(filename).endswith("yaml")]
+            for filename in template_list:
+                deploy_templates(filename, provider, substitutions)
+
+def deploy_templates(filename, provider, substitutions):
+    # validate filename exists
+    if not os.path.exists(filename):
+        fail(filename + " not found")
+
+    os.environ["NAMESPACE"] = substitutions.get("NAMESPACE", "default")
+    os.environ["KUBERNETES_VERSION"] = substitutions.get("KUBERNETES_VERSION", "v1.24.0")
+    os.environ["CONTROL_PLANE_MACHINE_COUNT"] = substitutions.get("CONTROL_PLANE_MACHINE_COUNT", "1")
+    os.environ["WORKER_MACHINE_COUNT"] = substitutions.get("WORKER_MACHINE_COUNT", "3")
+
+    basename = os.path.basename(filename)
+    if basename.endswith(".yaml"):
+        if basename.startswith("clusterclass-"):
+            template_name = basename.replace("clusterclass-", "").replace(".yaml", "")
+            deploy_clusterclass(template_name, provider, filename)
+        elif basename.startswith("cluster-template-"):
+            clusterclass_name = basename.replace("cluster-template-", "").replace(".yaml", "")
+            deploy_cluster_template(clusterclass_name, provider, filename)
+
+def deploy_clusterclass(clusterclass_name, provider, filename):
+    apply_clusterclass_cmd = "cat " + filename + " | " + envsubst_cmd + " | " + kubectl_cmd + " apply -f - && echo \"ClusterClass created from\'" + filename + "\', don't forget to delete\n\""
+    delete_clusterclass_cmd = kubectl_cmd + " delete clusterclass " + clusterclass_name + ' --ignore-not-found=true; echo "\n"'
+
+    local_resource(
+        name = clusterclass_name,
+        cmd = ["bash", "-c", apply_clusterclass_cmd],
+        auto_init = False,
+        trigger_mode = TRIGGER_MODE_MANUAL,
+        labels = [provider + "-clusterclasses"],
+    )
+
+    cmd_button(
+        clusterclass_name + ":apply",
+        argv = ["bash", "-c", apply_clusterclass_cmd],
+        resource = clusterclass_name,
+        icon_name = "note_add",
+        text = "Apply ClusterClass",
+    )
+
+    cmd_button(
+        clusterclass_name + ":delete",
+        argv = ["bash", "-c", delete_clusterclass_cmd],
+        resource = clusterclass_name,
+        icon_name = "delete_forever",
+        text = "Delete ClusterClass",
+    )
+
+def deploy_cluster_template(template_name, provider, filename):
+    apply_cluster_template_cmd = "CLUSTER_NAME=" + template_name + "-$RANDOM; " + clusterctl_cmd + " generate cluster $CLUSTER_NAME --from " + filename + " | " + kubectl_cmd + " apply -f - && echo \"Cluster '$CLUSTER_NAME' created, don't forget to delete\n\""
+
+    delete_clusters_cmd = 'DELETED=$(echo "$(bash -c "' + kubectl_cmd + ' get clusters --no-headers -o custom-columns=":metadata.name"")" | grep -E "^' + template_name + '-[[:digit:]]{1,5}$"); if [ -z "$DELETED" ]; then echo "Nothing to delete for cluster template ' + template_name + '"; else echo "Deleting clusters:\n$DELETED\n"; echo $DELETED | xargs -L1 ' + kubectl_cmd + ' delete cluster; fi; echo "\n"'
+
+    local_resource(
+        name = template_name,
+        cmd = ["bash", "-c", apply_cluster_template_cmd],
+        auto_init = False,
+        trigger_mode = TRIGGER_MODE_MANUAL,
+        labels = [provider + "-cluster-templates"],
+    )
+
+    cmd_button(
+        template_name + ":apply",
+        argv = ["bash", "-c", apply_cluster_template_cmd],
+        resource = template_name,
+        icon_name = "add_box",
+        text = "Create `" + template_name + "` cluster",
+    )
+
+    cmd_button(
+        template_name + ":delete",
+        argv = ["bash", "-c", delete_clusters_cmd],
+        resource = template_name,
+        icon_name = "delete_forever",
+        text = "Delete `" + template_name + "` clusters",
+    )
+
+    cmd_button(
+        template_name + ":delete-all",
+        argv = ["bash", "-c", kubectl_cmd + " delete clusters --all --wait=false"],
+        resource = template_name,
+        icon_name = "delete_sweep",
+        text = "Delete all workload clusters",
+    )
+
 ##############################
 # Actual work happens here
 ##############################
 
+ensure_clusterctl()
+
 include_user_tilt_files()
 
 load_provider_tiltfiles()
@@ -403,3 +513,5 @@ deploy_provider_crds()
 deploy_observability()
 
 enable_providers()
+
+cluster_templates()

docs/book/src/developer/tilt.md

@@ -71,8 +71,26 @@ documentation](https://docs.tilt.dev/api.html#api.default_registry) for more det
 **enable_providers** (Array[]String, default=['docker']): A list of the providers to enable. See [available providers](#available-providers)
 for more details.
 
+**template_dirs** (Map{String: Array[]String}, default={"docker": [
+"./test/infrastructure/docker/templates"]}): A map of providers to directories containing cluster templates. An example of the field is given below. See [Deploying a workload cluster](#deploying-a-workload-cluster) for how this is used.
+
+```yaml
+template_dirs:
+  docker:
+  - ./test/infrastructure/docker/templates
+  - <other-template-dir>
+  azure:
+  - <azure-template-dir>
+  aws:
+  - <aws-template-dir>
+  gcp:
+  - <gcp-template-dir>
+```
+
 **kustomize_substitutions** (Map{String: String}, default={}): An optional map of substitutions for `${}`-style placeholders in the
-provider's yaml. **Note**: When running E2E tests locally using an existing cluster managed by Tilt, the following substitutions are required for successful tests:
+provider's yaml. These substitutions are also used when deploying cluster templates. See [Deploying a workload cluster](#deploying-a-workload-cluster).
+
+**Note**: When running E2E tests locally using an existing cluster managed by Tilt, the following substitutions are required for successful tests:
 ```yaml
 kustomize_substitutions:
   CLUSTER_TOPOLOGY: "true"
@@ -258,7 +276,27 @@ create a cluster. There are [example worker cluster
 configs](https://github.com/kubernetes-sigs/cluster-api/tree/main/test/infrastructure/docker/examples) available.
 These can be customized for your specific needs.
 
-<aside class="note">
+### Deploying a workload cluster
+
+After your kind management cluster is up and running with Tilt, you can deploy a workload clusters in the Tilt web UI based off of YAML templates from specified directories. By default, templates are read from `./test/infrastructure/docker/templates`.
+
+These deployment resources are found in the Tilt web UI under the label grouping `<provider>-cluster-templates` and `<provider>-clusterclasses` for each specified provider, i.e. `docker-cluster-templates` and `docker-clusterclasses`.
+
+The `<provider>-cluster-templates` category contains cluster templates, you can create a cluster by clicking "Create cluster" or the clockwise arrow icon ⟳. Note that each time a cluster template is deployed, it deploys a new workload cluster in addition to the existing ones. To delete all clusters based off of a template, click on "Delete \<cluster-template\> cluster," and click on "Delete all workload clusters" to delete all workload clusters.
+
+The `<provider>-clusterclasses` category contains ClusterClass definitions and you can create them by clicking on the "Create clusterclass" or the clockwise arrow icon ⟳ and delete them by clicking on "Delete clusterclass".
+
+Variables in a cluster template are substituted with values from `kustomize_substitutions` in `tilt-settings.yaml`. The default substitutions are:
+
+```yaml
+kustomize_substitutions:
+  NAMESPACE: default
+  KUBERNETES_VERSION: v1.24.0
+  CONTROL_PLANE_MACHINE_COUNT: 1
+  WORKER_MACHINE_COUNT: 3
+```
+
+Lastly, cluster template directories can be specified from the `template_dirs` field in `tilt-settings.yaml`. See [tilt-settings fields](#tilt-settings-fields) for an example.
 
 <h1>Use of clusterctl</h1>