Tiltfile: rename deploy_kustomizations to additional_kustomizations

Author: chrischdi

Tiltfile

@@ -482,8 +482,8 @@ def deploy_observability():
             objects = ["capi-visualizer:serviceaccount"],
         )
 
-def deploy_kustomizations():
-    for name in settings.get("deploy_kustomizations", []):
+def deploy_additional_kustomizations():
+    for name in settings.get("additional_kustomizations", []):
         yaml = read_file("./.tiltbuild/yaml/{}.kustomization.yaml".format(name))
         k8s_yaml(yaml)
         objs = decode_yaml_stream(yaml)
@@ -653,7 +653,7 @@ deploy_provider_crds()
 
 deploy_observability()
 
-deploy_kustomizations()
+deploy_additional_kustomizations()
 
 enable_providers()
 

docs/book/src/developer/tilt.md

@@ -214,11 +214,10 @@ Supported values are:
 
 \*: Note: the UI will be accessible via a link in the tilt console
 
-**deploy_kustomizations** (map[string]string, default={}): If set, installs the additional kustomizations to the cluster.
-
+**additional_kustomizations** (map[string]string, default={}): If set, install the additional resources built using kustomize to the cluster.
 Example:
 ```yaml
-deploy_kustomizations:
+additional_kustomizations:
   capv-metrics: ../cluster-api-provider-vsphere/config/metrics
 ```
 

hack/tools/internal/tilt-prepare/main.go

@@ -104,14 +104,14 @@ var (
 // Types used to de-serialize the tilt-settings.yaml/json file from the Cluster API repository.
 
 type tiltSettings struct {
-	Debug                map[string]tiltSettingsDebugConfig `json:"debug,omitempty"`
-	ExtraArgs            map[string]tiltSettingsExtraArgs   `json:"extra_args,omitempty"`
-	DeployCertManager    *bool                              `json:"deploy_cert_manager,omitempty"`
-	DeployObservability  []string                           `json:"deploy_observability,omitempty"`
-	DeployKustomizations map[string]string                  `json:"deploy_kustomizations,omitempty"`
-	EnableProviders      []string                           `json:"enable_providers,omitempty"`
-	AllowedContexts      []string                           `json:"allowed_contexts,omitempty"`
-	ProviderRepos        []string                           `json:"provider_repos,omitempty"`
+	Debug                    map[string]tiltSettingsDebugConfig `json:"debug,omitempty"`
+	ExtraArgs                map[string]tiltSettingsExtraArgs   `json:"extra_args,omitempty"`
+	DeployCertManager        *bool                              `json:"deploy_cert_manager,omitempty"`
+	DeployObservability      []string                           `json:"deploy_observability,omitempty"`
+	EnableProviders          []string                           `json:"enable_providers,omitempty"`
+	AllowedContexts          []string                           `json:"allowed_contexts,omitempty"`
+	ProviderRepos            []string                           `json:"provider_repos,omitempty"`
+	AdditionalKustomizations map[string]string                  `json:"additional_kustomizations,omitempty"`
 }
 
 type tiltSettingsDebugConfig struct {
@@ -309,7 +309,7 @@ func tiltResources(ctx context.Context, ts *tiltSettings) error {
 		)
 	}
 
-	for name, path := range ts.DeployKustomizations {
+	for name, path := range ts.AdditionalKustomizations {
 		name := fmt.Sprintf("%s.kustomization", name)
 		tasks[name] = sequential(
 			kustomizeTask(path, fmt.Sprintf("%s.yaml", name)),