diff --git a/docs/book/src/developers/development.md b/docs/book/src/developers/development.md index 3455fbbd312..9ae59192255 100644 --- a/docs/book/src/developers/development.md +++ b/docs/book/src/developers/development.md @@ -166,8 +166,6 @@ If you would like to enable these features, add `extra_args` as specified in [Th Once your kind management cluster is up and running, you can [deploy a workload cluster](#deploying-a-workload-cluster). -You can also [deploy a flavor cluster as a local tilt resource](../../../../templates/flavors/README.md#Running-flavor-clusters-as-a-tilt-resource). - To tear down the kind cluster built by the command above, just run: ```shell @@ -217,9 +215,12 @@ The cluster-api management components that are deployed are configured at the `/ ⚠️ Note that when developing with `tilt` as described above, some `clusterctl` commands won't work. Specifically, `clusterctl config` and `clusterctl generate` may fail. These commands expect specific releases of CAPI and CAPZ to be installed, but the `tilt` environment dynamically updates and installs these components from your local code. `clusterctl get kubeconfig` will still work, however. -After your kind management cluster is up and running with Tilt, you can [configure workload cluster settings](#customizing-the-cluster-deployment) and deploy a workload cluster by opening the `tilt` web UI and clicking the clockwise arrow icon ⟳ on a resource listed, such as "aks-aad," "ipv6," or "windows." +After your kind management cluster is up and running with Tilt, you can deploy a workload cluster by opening the `tilt` web UI and clicking the clockwise arrow icon ⟳ on a resource listed, such as "aks-aad," "ipv6," or "windows." + +Deploying a workload cluster from Tilt UI is also termed as flavor cluster deployment. +Please refer to [Running flavor clusters as a tilt resource](../../../../templates/flavors/README.md#Running-flavor-clusters-as-a-tilt-resource) to learn more about this. -Or you can deploy a workload cluster with the following command: +Or you can [configure workload cluster settings](#customizing-the-cluster-deployment) and deploy a workload cluster with the following command: ```bash make create-workload-cluster diff --git a/docs/book/theme/flavour-deploy-from-ui.png b/docs/book/theme/flavour-deploy-from-ui.png new file mode 100644 index 00000000000..97db16794a5 Binary files /dev/null and b/docs/book/theme/flavour-deploy-from-ui.png differ diff --git a/docs/book/theme/tilt-up.png b/docs/book/theme/tilt-up.png new file mode 100644 index 00000000000..13f3838cc2f Binary files /dev/null and b/docs/book/theme/tilt-up.png differ diff --git a/templates/flavors/README.md b/templates/flavors/README.md index 3479ba0fd71..d64c93b5479 100644 --- a/templates/flavors/README.md +++ b/templates/flavors/README.md @@ -18,9 +18,6 @@ To generate all CAPZ flavors, run `make generate-flavors`. ## Running flavor clusters as a tilt resource -#### From CLI -run ```tilt up ${flavors}``` to spin up worker clusters in Azure represented by a Tilt local resource. You can also modify flavors while Tilt is up by running ```tilt args ${flavors}``` - #### From Tilt Config Tilt will auto-detect all available flavors from the `templates` directory. @@ -36,7 +33,13 @@ Please note your tilt-settings.json must contain at minimum the following fields } } ``` +After updating tilt-settings.json, follow these two steps to deploy a workload cluster: +1. Run ``make tilt up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.json also resides here in the +root of this repo. After tilt has initialized, press `space` to open the tilt web UI in a browser. See the following example: + ![plot](../../docs/book/theme/tilt-up.png) +2. Once your browser is open, click the clockwise arrow icon ⟳ on a resource listed. For example, `default` to deploy a default flavor. + ![plot](../../docs/book/theme/flavour-deploy-from-ui.png) #### Defining Variable Overrides If you wish to override the default variables for flavor workers, you can specify them as part of your tilt-settings.json as seen in the example below. Please note, the precedence of variables is as follows: