add support for IPAM and Runtime Extension provider in tilt

fabriziopandini · fabriziopandini · commit 5101f01147bf · 2022-10-05T13:01:50.000+02:00
diff --git a/Tiltfile b/Tiltfile
@@ -104,30 +104,30 @@ providers = {
             "internal",
             "third_party",
         ],
+        "label": "CAPD",
+        # Add kubectl to the docker image, CAPD manager requires it.
         "additional_docker_helper_commands": "RUN curl -LO https://dl.k8s.io/release/{KUBE}/bin/linux/{ARCH}/kubectl && chmod +x ./kubectl && mv ./kubectl /usr/bin/kubectl".format(
             ARCH = os_arch,
             KUBE = kubernetes_version,
         ),
         "additional_docker_build_commands": """
 COPY --from=tilt-helper /usr/bin/kubectl /usr/bin/kubectl
 """,
-        "label": "CAPD",
     },
-}
-
-# Create a data structure to hold information about addons.
-addons = {
     "test-extension": {
-        "context": "./test/extension",
+        "context": "test/extension",
         "image": "gcr.io/k8s-staging-cluster-api/test-extension",
-        "container_name": "extension",
-        "live_reload_deps": ["main.go", "handlers"],
+        "live_reload_deps": [
+            "main.go",
+            "handlers",
+        ],
         "label": "test-extension",
-        "resource_deps": ["capi_controller"],
+        # Add the ExtensionConfig for this Runtime extension; given that the ExtensionConfig can be installed only when capi_controller
+        # are up and running, it is required to set a resource_deps to ensure proper install order.
         "additional_resources": [
             "config/tilt/extensionconfig.yaml",
-            "config/tilt/hookresponses-configmap.yaml",
         ],
+        "resource_deps": ["capi_controller"],
     },
 }
 
@@ -165,27 +165,6 @@ def load_provider_tiltfiles():
                 provider_config["go_main"] = "main.go"
             providers[provider_name] = provider_config
 
-# load_addon_tiltfiles looks for tilt-addon.[yaml|json] files in the repositories listed in "addon_repos" in tilt settings and loads their config.
-def load_addon_tiltfiles():
-    addon_repos = settings.get("addon_repos", [])
-    for repo in addon_repos:
-        file = repo + "/tilt-addon.yaml" if os.path.exists(repo + "/tilt-addon.yaml") else repo + "/tilt-addon.json"
-        if not os.path.exists(file):
-            fail("Failed to load provider. No tilt-addon.{yaml|json} file found in " + repo)
-        addon_details = read_yaml(file, default = {})
-        if type(addon_details) != type([]):
-            addon_details = [addon_details]
-        for item in addon_details:
-            addon_name = item["name"]
-            addon_config = item["config"]
-            if "context" in addon_config:
-                addon_config["context"] = repo + "/" + addon_config["context"]
-            else:
-                addon_config["context"] = repo
-            if "go_main" not in addon_config:
-                addon_config["go_main"] = "main.go"
-            addons[addon_name] = addon_config
-
 tilt_helper_dockerfile_header = """
 # Tilt image
 FROM golang:1.19.0 as tilt-helper
@@ -312,7 +291,6 @@ def get_port_forwards(debug):
 # 2. Configures a docker build for the provider, with live updating of the manager binary
 # 3. Runs kustomize for the provider's config/default and applies it
 def enable_provider(name, debug):
-    deployment_kind = "provider"
     p = providers.get(name)
     label = p.get("label")
 
@@ -336,77 +314,26 @@ def enable_provider(name, debug):
         port_forwards = port_forwards,
     )
 
+    additional_objs = []
+    p_resources = p.get("additional_resources", [])
+    for resource in p_resources:
+        k8s_yaml(p.get("context") + "/" + resource)
+        additional_objs = additional_objs + decode_yaml_stream(read_file(p.get("context") + "/" + resource))
+
     if p.get("kustomize_config", True):
-        yaml = read_file("./.tiltbuild/yaml/{}.{}.yaml".format(name, deployment_kind))
+        yaml = read_file("./.tiltbuild/yaml/{}.provider.yaml".format(name))
         k8s_yaml(yaml)
         objs = decode_yaml_stream(yaml)
         k8s_resource(
             workload = find_object_name(objs, "Deployment"),
-            objects = [find_object_qualified_name(objs, "Provider")],
+            objects = [find_object_qualified_name(objs, "Provider")] + find_all_objects_names(additional_objs),
             new_name = label.lower() + "_controller",
             labels = [label, "ALL.controllers"],
             port_forwards = port_forwards,
             links = links,
-            resource_deps = ["provider_crd"],
-        )
-
-# Configures an addon by doing the following:
-#
-# 1. Enables a local_resource go build of the addon's manager binary
-# 2. Configures a docker build for the addon, with live updating of the binary
-# 3. Runs kustomize for the addons's config/default and applies it
-def enable_addon(name, debug):
-    addon = addons.get(name)
-    deployment_kind = "addon"
-    label = addon.get("label")
-    port_forwards, links = get_port_forwards(debug)
-
-    build_go_binary(
-        context = addon.get("context"),
-        reload_deps = addon.get("live_reload_deps"),
-        debug = debug,
-        go_main = addon.get("go_main", "main.go"),
-        binary_name = "extension",
-        label = label,
-    )
-
-    build_docker_image(
-        image = addon.get("image"),
-        context = addon.get("context"),
-        binary_name = "extension",
-        additional_docker_helper_commands = addon.get("additional_docker_helper_commands", ""),
-        additional_docker_build_commands = addon.get("additional_docker_build_commands", ""),
-        port_forwards = port_forwards,
-    )
-
-    additional_objs = []
-    addon_resources = addon.get("additional_resources", [])
-    for resource in addon_resources:
-        k8s_yaml(addon.get("context") + "/" + resource)
-        additional_objs = additional_objs + decode_yaml_stream(read_file(addon.get("context") + "/" + resource))
-
-    if addon.get("kustomize_config", True):
-        yaml = read_file("./.tiltbuild/yaml/{}.{}.yaml".format(name, deployment_kind))
-        objs = decode_yaml_stream(yaml)
-        k8s_yaml(yaml)
-        k8s_resource(
-            workload = find_object_name(objs, "Deployment"),
-            new_name = label.lower() + "_addon",
-            labels = [label, "ALL.addons"],
-            port_forwards = port_forwards,
-            links = links,
-            objects = find_all_objects_names(additional_objs),
-            resource_deps = addon.get("resource_deps", {}),
+            resource_deps = ["provider_crd"] + p.get("resource_deps", []),
         )
 
-def enable_addons():
-    for name in get_addons():
-        enable_addon(name, settings.get("debug").get(name, {}))
-
-def get_addons():
-    user_enable_addons = settings.get("enable_addons", [])
-    return {k: "" for k in user_enable_addons}.keys()
-
 def find_object_name(objs, kind):
     for o in objs:
         if o["kind"] == kind:
@@ -634,8 +561,6 @@ include_user_tilt_files()
 
 load_provider_tiltfiles()
 
-load_addon_tiltfiles()
-
 prepare_all()
 
 deploy_provider_crds()
@@ -644,6 +569,4 @@ deploy_observability()
 
 enable_providers()
 
-enable_addons()
-
 cluster_templates()
diff --git a/docs/book/src/developer/tilt.md b/docs/book/src/developer/tilt.md
@@ -338,8 +338,13 @@ you are interested in testing clusterctl workflows, you should refer to the
 
 The following providers are currently defined in the Tiltfile:
 
-* **core**: cluster-api itself (Cluster/Machine/MachineDeployment/MachineSet/KubeadmConfig/KubeadmControlPlane)
-* **docker**: Docker provider (DockerCluster/DockerMachine)
+* **core**: cluster-api itself
+* **kubeadm-bootstrap**: kubeadm bootstrap provider
+* **kubeadm-control-plane**: kubeadm control-plane provider
+* **docker**: Docker infrastructure provider
+* **test-extension**: Runtime extension used by CAPI E2E tests
+
+Additional providers can be added by following the procedure described in following paragraphs:
 
 ### tilt-provider configuration
 
@@ -395,6 +400,12 @@ Set to `false` if your provider does not have a ./config folder or you do not wa
 in tilt version >= v0.22.2 (see https://blog.tilt.dev/2021/08/09/resource-grouping.html); as a convention,
 provider abbreviation should be used (CAPD, KCP etc.).
 
+**additional_resources** ([]string, default=[]): A list of paths to yaml file to be loaded into the tilt cluster;
+e.g. use this to deploy an ExtensionConfig object for a RuntimeExtension provider.
+
+**resource_deps** ([]string, default=[]): A list of tilt resource names to be installed before the current provider;
+e.g. set this to ["capi_controller"] to ensure that this provider gets installed after Cluster API.
+
 ## Customizing Tilt
 
 If you need to customize Tilt's behavior, you can create files in cluster-api's `tilt.d` directory. This file is ignored
diff --git a/hack/tools/tilt-prepare/main.go b/hack/tools/tilt-prepare/main.go
@@ -77,22 +77,8 @@ type tiltSettings struct {
 	DeployCertManager   *bool                  `json:"deploy_cert_manager,omitempty"`
 	DeployObservability []string               `json:"deploy_observability,omitempty"`
 	EnableProviders     []string               `json:"enable_providers,omitempty"`
-	EnableAddons        []string               `json:"enable_addons,omitempty"`
 	AllowedContexts     []string               `json:"allowed_contexts,omitempty"`
 	ProviderRepos       []string               `json:"provider_repos,omitempty"`
-	AddonRepos          []string               `json:"addon_repos,omitempty"`
-}
-
-type addonSettings struct {
-	Name   string      `json:"name,omitempty"`
-	Config addonConfig `json:"config,omitempty"`
-}
-
-type addonConfig struct {
-	Image         string  `json:"image,omitempty"`
-	ContainerName string  `json:"container_name,omitempty"`
-	BinaryName    string  `json:"binary_name,omitempty"`
-	Context       *string `json:"context"`
 }
 
 type providerSettings struct {
@@ -277,6 +263,7 @@ func tiltResources(ctx context.Context, ts *tiltSettings) error {
 		"kubeadm-bootstrap":     "bootstrap/kubeadm",
 		"kubeadm-control-plane": "controlplane/kubeadm",
 		"docker":                "test/infrastructure/docker",
+		"test-extension":        "test/extension",
 	}
 
 	// Add all the provider paths to the providerpaths map
@@ -310,69 +297,9 @@ func tiltResources(ctx context.Context, ts *tiltSettings) error {
 		tasks[providerName] = workloadTask(providerName, "provider", "manager", "manager", ts, fmt.Sprintf("%s/config/default", path), getProviderObj)
 	}
 
-	addonPaths := map[string]string{}
-	for _, repo := range ts.AddonRepos {
-		addonContexts, err := loadAddon(repo)
-		if err != nil {
-			return err
-		}
-		for name, path := range addonContexts {
-			addonPaths[name] = path
-		}
-	}
-
-	// Add an addon task for each repo defined using enableAddons in the tilt-settings file.
-	for _, name := range ts.EnableAddons {
-		if name == "test-extension" {
-			tasks[name] = workloadTask(name, "addon", "extension", "extension", ts, fmt.Sprintf("%s/config/default", "./test/extension"), nil)
-			continue
-		}
-		path, ok := addonPaths[name]
-		if !ok {
-			return errors.Errorf("failed to obtain path for the addon %s", name)
-		}
-		as, err := readAddonSettings(path)
-		if err != nil {
-			return err
-		}
-		tasks[as.Name] = workloadTask(name, "addon", "extension", as.Config.ContainerName, ts, fmt.Sprintf("%s/config/default", path), nil)
-	}
 	return runTaskGroup(ctx, "resources", tasks)
 }
 
-func readAddonSettings(path string) (*addonSettings, error) {
-	path, err := checkWorkloadFileFormat(path, "addon")
-	if err != nil {
-		return nil, err
-	}
-	content, err := os.ReadFile(path) //nolint:gosec
-	if err != nil {
-		return nil, err
-	}
-	as := &addonSettings{}
-	if err := yaml.Unmarshal(content, as); err != nil {
-		return nil, errors.Wrap(err, "failed to unmarshal tilt-addons content")
-	}
-	return as, nil
-}
-
-func loadAddon(repo string) (map[string]string, error) {
-	var contextPath string
-	addonData, err := readAddonSettings(repo)
-	if err != nil {
-		return nil, err
-	}
-	addonContexts := map[string]string{}
-	if addonData.Config.Context != nil {
-		contextPath = repo + "/" + *addonData.Config.Context
-	} else {
-		contextPath = repo
-	}
-	addonContexts[addonData.Name] = contextPath
-
-	return addonContexts, nil
-}
-
 func loadProviders(r string) (map[string]string, error) {
 	var contextPath string
 	providerData, err := readProviderSettings(r)
@@ -940,20 +867,28 @@ func getProviderObj(prefix string, objs []unstructured.Unstructured) (*unstructu
 			clusterv1.ProviderLabelName)
 	}
 
-	providerType := "CoreProvider"
+	providerType := string(clusterctlv1.CoreProviderType)
 	providerName := manifestLabel
 	if strings.HasPrefix(manifestLabel, "infrastructure-") {
-		providerType = "InfrastructureProvider"
+		providerType = string(clusterctlv1.InfrastructureProviderType)
 		providerName = manifestLabel[len("infrastructure-"):]
 	}
 	if strings.HasPrefix(manifestLabel, "bootstrap-") {
-		providerType = "BootstrapProvider"
+		providerType = string(clusterctlv1.BootstrapProviderType)
 		providerName = manifestLabel[len("bootstrap-"):]
 	}
 	if strings.HasPrefix(manifestLabel, "control-plane-") {
-		providerType = "ControlPlaneProvider"
+		providerType = string(clusterctlv1.ControlPlaneProviderType)
 		providerName = manifestLabel[len("control-plane-"):]
 	}
+	if strings.HasPrefix(manifestLabel, "ipam-") {
+		providerType = string(clusterctlv1.IPAMProviderType)
+		providerName = manifestLabel[len("ipam-"):]
+	}
+	if strings.HasPrefix(manifestLabel, "runtime-extension-") {
+		providerType = string(clusterctlv1.RuntimeExtensionProviderType)
+		providerName = manifestLabel[len("runtime-extension-"):]
+	}
 
 	provider := &clusterctlv1.Provider{
 		TypeMeta: metav1.TypeMeta{
