Merge pull request kubernetes-sigs#7968 from fabriziopandini/improve-tilt

🌱 Improve tilt-prepare for testing providers outside of the CAPI repository

Author: k8s-ci-robot

Tiltfile

@@ -49,7 +49,7 @@ always_enable_providers = ["core"]
 
 providers = {
     "core": {
-        "context": ".",
+        "context": ".",  # NOTE: this should be kept in sync with corresponding setting in tilt-prepare
         "image": "gcr.io/k8s-staging-cluster-api/cluster-api-controller",
         "live_reload_deps": [
             "main.go",
@@ -68,7 +68,7 @@ providers = {
         "label": "CAPI",
     },
     "kubeadm-bootstrap": {
-        "context": "bootstrap/kubeadm",
+        "context": "bootstrap/kubeadm",  # NOTE: this should be kept in sync with corresponding setting in tilt-prepare
         "image": "gcr.io/k8s-staging-cluster-api/kubeadm-bootstrap-controller",
         "live_reload_deps": [
             "main.go",
@@ -82,7 +82,7 @@ providers = {
         "label": "CABPK",
     },
     "kubeadm-control-plane": {
-        "context": "controlplane/kubeadm",
+        "context": "controlplane/kubeadm",  # NOTE: this should be kept in sync with corresponding setting in tilt-prepare
         "image": "gcr.io/k8s-staging-cluster-api/kubeadm-control-plane-controller",
         "live_reload_deps": [
             "main.go",
@@ -95,7 +95,7 @@ providers = {
         "label": "KCP",
     },
     "docker": {
-        "context": "test/infrastructure/docker",
+        "context": "test/infrastructure/docker",  # NOTE: this should be kept in sync with corresponding setting in tilt-prepare
         "image": "gcr.io/k8s-staging-cluster-api/capd-manager",
         "live_reload_deps": [
             "main.go",
@@ -121,7 +121,7 @@ COPY --from=tilt-helper /usr/bin/kubectl /usr/bin/kubectl
 """,
     },
     "test-extension": {
-        "context": "test/extension",
+        "context": "test/extension",  # NOTE: this should be kept in sync with corresponding setting in tilt-prepare
         "image": "gcr.io/k8s-staging-cluster-api/test-extension",
         "live_reload_deps": [
             "main.go",

docs/book/src/developer/tilt.md

@@ -394,6 +394,9 @@ build it.
 **live_reload_deps**: a list of files/directories to watch. If any of them changes, Tilt rebuilds the manager binary
 for the provider and performs a live update of the running container.
 
+**version**: allows to define the version to be used for the Provider CR. If empty, a default version will 
+be used.
+
 **additional_docker_helper_commands** (String, default=""): Additional commands to be run in the helper image
 docker build. e.g.
 
@@ -478,4 +481,4 @@ syntax highlighting and auto-formatting. To enable it for Tiltfile a file associ
 1. Set `build_engine` to `podman` in `tilt-settings.yaml` (optional, only if both docker & podman are installed)
 1. Define the env variable `DOCKER_HOST` to the right socket while running tilt (eg. `DOCKER_HOST=unix:///run/user/$(id -u)/podman/podman.sock tilt up`)
 
-NB: The socket defined by `DOCKER_HOST` is used only for the `hack/tools/tilt-prepare` command, the image build is running the `podman build`/`podman push` commands.
+NB: The socket defined by `DOCKER_HOST` is used only for the `hack/tools/tilt-prepare` command, the image build is running the `podman build`/`podman push` commands.