Merge pull request #2666 from nojnhuh/tilt-settings-yaml

k8s-ci-robot · web-flow · commit 89b354a2ce91 · 2022-09-26T09:26:07.000-07:00
read tilt-settings.yaml
diff --git a/.gitignore b/.gitignore
@@ -56,6 +56,7 @@ bazel-*
 .tiltbuild
 /tilt.d
 tilt-settings.json
+tilt-settings.yaml
 tilt_config.json
 
 # e2e output
diff --git a/Tiltfile b/Tiltfile
@@ -28,8 +28,9 @@ settings = {
 keys = ["AZURE_SUBSCRIPTION_ID", "AZURE_TENANT_ID", "AZURE_CLIENT_SECRET", "AZURE_CLIENT_ID"]
 
 # global settings
-settings.update(read_json(
-    "tilt-settings.json",
+tilt_file = "./tilt-settings.yaml" if os.path.exists("./tilt-settings.yaml") else "./tilt-settings.json"
+settings.update(read_yaml(
+    tilt_file,
     default = {},
 ))
 
diff --git a/docs/book/src/developers/development.md b/docs/book/src/developers/development.md
@@ -148,18 +148,15 @@ development will span both CAPZ and CAPI, then follow the [CAPI and CAPZ instruc
 
 If you want to develop in CAPZ and get a local development cluster working quickly, this is the path for you.
 
-From the root of the CAPZ repository and after configuring the environment variables, you can run the following to generate your `tilt-settings.json` file:
+From the root of the CAPZ repository and after configuring the environment variables, you can run the following to generate your `tilt-settings.yaml` file:
 
 ```shell
-cat <<EOF > tilt-settings.json
-{
-  "kustomize_substitutions": {
-      "AZURE_SUBSCRIPTION_ID_B64": "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_TENANT_ID_B64": "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_SECRET_B64": "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_ID_B64": "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
-  }
-}
+cat <<EOF > tilt-settings.yaml
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID_B64: "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_TENANT_ID_B64: "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_SECRET_B64: "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_ID_B64: "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
 EOF
 ```
 
@@ -187,7 +184,7 @@ To use [Tilt](https://tilt.dev/) for a simplified development workflow, follow t
 
 > you may wish to checkout out the correct version of CAPI to match the [version used in CAPZ][go.mod]
 
-Note that `tilt up` will be run from the `cluster-api repository` directory and the `tilt-settings.json` file will point back to the `cluster-api-provider-azure` repository directory.  Any changes you make to the source code in `cluster-api` or `cluster-api-provider-azure` repositories will automatically redeployed to the `kind` cluster.
+Note that `tilt up` will be run from the `cluster-api repository` directory and the `tilt-settings.yaml` file will point back to the `cluster-api-provider-azure` repository directory.  Any changes you make to the source code in `cluster-api` or `cluster-api-provider-azure` repositories will automatically redeployed to the `kind` cluster.
 
 After you have cloned both repositories, your folder structure should look like:
 
@@ -196,21 +193,23 @@ After you have cloned both repositories, your folder structure should look like:
 |-- src/cluster-api (run `tilt up` here)
 ```
 
-After configuring the environment variables, run the following to generate your `tilt-settings.json` file:
+After configuring the environment variables, run the following to generate your `tilt-settings.yaml` file:
 
 ```shell
-cat <<EOF > tilt-settings.json
-{
-  "default_registry": "${REGISTRY}",
-  "provider_repos": ["../cluster-api-provider-azure"],
-  "enable_providers": ["azure", "docker", "kubeadm-bootstrap", "kubeadm-control-plane"],
-  "kustomize_substitutions": {
-      "AZURE_SUBSCRIPTION_ID_B64": "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_TENANT_ID_B64": "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_SECRET_B64": "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_ID_B64": "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
-  }
-}
+cat <<EOF > tilt-settings.yaml
+default_registry: "${REGISTRY}"
+provider_repos:
+- ../cluster-api-provider-azure
+enable_providers:
+- azure
+- docker
+- kubeadm-bootstrap
+- kubeadm-control-plane
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID_B64: "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_TENANT_ID_B64: "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_SECRET_B64: "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_ID_B64: "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
 EOF
 ```
 
@@ -270,26 +269,26 @@ To view cluster resources using the [Cluster API Visualizer](https://github.com/
 
 #### Debugging
 
-You can debug CAPZ (or another provider / core CAPI) by running the controllers with delve. When developing using Tilt this is easily done by using the **debug** configuration section in your **tilt-settings.json** file. For example:
-
-```json
-{
-  "default_registry": "${REGISTRY}",
-  "provider_repos": ["../cluster-api-provider-azure"],
-  "enable_providers": ["azure", "kubeadm-bootstrap", "kubeadm-control-plane"],
-  "kustomize_substitutions": {
-      "AZURE_SUBSCRIPTION_ID_B64": "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_TENANT_ID_B64": "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_SECRET_B64": "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')",
-      "AZURE_CLIENT_ID_B64": "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
-  },
-  "debug": {
-    "azure": {
-      "continue": true,
-      "port": 30000
-    }
-  }
-}
+You can debug CAPZ (or another provider / core CAPI) by running the controllers with delve. When developing using Tilt this is easily done by using the **debug** configuration section in your **tilt-settings.yaml** file. For example:
+
+```yaml
+default_registry: "${REGISTRY}"
+provider_repos:
+- ../cluster-api-provider-azure
+enable_providers:
+- azure
+- docker
+- kubeadm-bootstrap
+- kubeadm-control-plane
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID_B64: "$(echo "${AZURE_SUBSCRIPTION_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_TENANT_ID_B64: "$(echo "${AZURE_TENANT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_SECRET_B64: "$(echo "${AZURE_CLIENT_SECRET}" | tr -d '\n' | base64 | tr -d '\n')"
+  AZURE_CLIENT_ID_B64: "$(echo "${AZURE_CLIENT_ID}" | tr -d '\n' | base64 | tr -d '\n')"
+debug:
+  azure:
+    continue: true
+    port: 30000
 ```
 
 > Note you can list multiple controllers or **core** CAPI and expose metrics as well in the debug section. Full details of the options can be seen [here](https://cluster-api.sigs.k8s.io/developer/tilt.html).
diff --git a/hack/observability/opentelemetry/readme.md b/hack/observability/opentelemetry/readme.md
@@ -32,14 +32,11 @@ for "Instrumentation Key".
 ![Instrumentation Key](assets/portal_instrumentation_key.png)
 
 Paste the Instrumentation Key from the portal as `AZURE_INSTRUMENTATION_KEY`
-in `tilt-settings.json`:
-
-```json
-{
-  "kustomize_substitutions": {
-      "AZURE_INSTRUMENTATION_KEY": "12345678-1234-1234-1234-1234567890abc"
-  }
-}
+in `tilt-settings.yaml`:
+
+```yaml
+kustomize_substitutions:
+  AZURE_INSTRUMENTATION_KEY: "12345678-1234-1234-1234-1234567890abc"
 ```
 
 Once your management cluster is up, search for recent traces on the "Transaction search" page.
diff --git a/hack/observability/readme.md b/hack/observability/readme.md
@@ -19,7 +19,7 @@ the screen.
 
 To access traces in
 [Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview),
-specify an `AZURE_INSTRUMENTATION_KEY` in your `tilt-settings.json`, then navigate to the
+specify an `AZURE_INSTRUMENTATION_KEY` in your `tilt-settings.yaml`, then navigate to the
 App Insights resource in the Azure Portal and choose "Transaction search" to query for traces. See
 the tracing docs for more detail.
 
diff --git a/templates/flavors/README.md b/templates/flavors/README.md
@@ -22,88 +22,70 @@ To generate all CAPZ flavors, run `make generate-flavors`.
 Tilt will auto-detect all available flavors from the `templates` directory.
 
 #### Requirements
-Please note your tilt-settings.json must contain at minimum the following fields when using tilt resources to deploy cluster flavors:
-```json
-{
-    "kustomize_substitutions": {
-        "AZURE_SUBSCRIPTION_ID": "******",
-        "AZURE_TENANT_ID": "******",
-        "AZURE_CLIENT_SECRET": "******",
-        "AZURE_CLIENT_ID": "******"
-    }
-}
+Please note your tilt-settings.yaml must contain at minimum the following fields when using tilt resources to deploy cluster flavors:
+```yaml
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID: "******"
+  AZURE_TENANT_ID: "******"
+  AZURE_CLIENT_SECRET: "******"
+  AZURE_CLIENT_ID: "******"
 ```
-After updating tilt-settings.json, follow these two steps to deploy a workload cluster:
+After updating tilt-settings.yaml, 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 
+1. Run ``make tilt up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.yaml 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:
+If you wish to override the default variables for flavor workers, you can specify them as part of your tilt-settings.yaml as seen in the example below.  Please note, the precedence of variables is as follows:
 
 1. explicitly defined vars for each flavor i.e. worker-templates.flavors[0].AZURE_VNET_NAME
 2. vars defined at 'metadata' level-- spans workers i.e. metadata.AZURE_VNET_NAME
 3. programmatically defined default vars i.e. everything except azure tenant, client, subscription
 
 
-```json
-{
-    "kustomize_substitutions": {
-        "AZURE_SUBSCRIPTION_ID": "****",
-        "AZURE_TENANT_ID": "****",
-        "AZURE_CLIENT_SECRET": "****",
-        "AZURE_CLIENT_ID": "****"
-    },
-    "worker-templates": {
-        "flavors": {
-            "default": {
-                "CLUSTER_NAME": "example-default-cluster-name",
-                "AZURE_VNET_NAME": "example-vnet-one"
-            },
-            "system-assigned-identity": {
-                "CLUSTER_NAME": "example-SAI-cluster-name",
-                "AZURE_LOCATION": "westus",
-                "AZURE_VNET_NAME": "example-vnet-two"
-            }
-        },
-        "metadata": {
-            "AZURE_LOCATION": "eastus",
-            "AZURE_RESOURCE_GROUP": "test-resource-group-name",
-            "CONTROL_PLANE_MACHINE_COUNT": "1",
-            "KUBERNETES_VERSION": "v1.22.1",
-            "AZURE_CONTROL_PLANE_MACHINE_TYPE": "Standard_D2s_v3",
-            "WORKER_MACHINE_COUNT": "2",
-            "AZURE_NODE_MACHINE_TYPE": "Standard_D2s_v3"
-        }
-    }
-}
+```yaml
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID: "****"
+  AZURE_TENANT_ID: "****"
+  AZURE_CLIENT_SECRET: "****"
+  AZURE_CLIENT_ID: "****"
+worker-templates:
+  flavors:
+    default:
+      CLUSTER_NAME: example-default-cluster-name
+      AZURE_VNET_NAME: example-vnet-one
+    system-assigned-identity:
+      CLUSTER_NAME: example-SAI-cluster-name
+      AZURE_LOCATION: westus
+      AZURE_VNET_NAME: example-vnet-two
+  metadata:
+    AZURE_LOCATION: eastus
+    AZURE_RESOURCE_GROUP: test-resource-group-name
+    CONTROL_PLANE_MACHINE_COUNT: "1"
+    KUBERNETES_VERSION: v1.22.1
+    AZURE_CONTROL_PLANE_MACHINE_TYPE: Standard_D2s_v3
+    WORKER_MACHINE_COUNT: "2"
+    AZURE_NODE_MACHINE_TYPE: Standard_D2s_v3
 ```
 
 Here is a practical example: creating a GPU-enabled cluster requires N-series nodes. You can set an
-N-series node type just for the `nvidia-gpu` flavor in `tilt-settings.json` to override any default:
+N-series node type just for the `nvidia-gpu` flavor in `tilt-settings.yaml` to override any default:
 
-```json
-{
-    "kustomize_substitutions": {
-        "AZURE_SUBSCRIPTION_ID": "****",
-        "AZURE_TENANT_ID": "****",
-        "AZURE_CLIENT_SECRET": "****",
-        "AZURE_CLIENT_ID": "****"
-    },
-    "worker-templates": {
-        "flavors": {
-            "nvidia-gpu": {
-                "AZURE_NODE_MACHINE_TYPE": "Standard_NC6s_v3"
-            }
-        },
-        "metadata": {
-            "AZURE_CONTROL_PLANE_MACHINE_TYPE": "Standard_D2s_v3",
-            "AZURE_LOCATION": "southcentralus",
-            "KUBERNETES_VERSION": "v1.22.1",
-            "WORKER_MACHINE_COUNT": "1"
-        }
-    }
-}
+```yaml
+kustomize_substitutions:
+  AZURE_SUBSCRIPTION_ID: "****"
+  AZURE_TENANT_ID: "****"
+  AZURE_CLIENT_SECRET: "****"
+  AZURE_CLIENT_ID: "****"
+worker-templates:
+  flavors:
+    nvidia-gpu:
+      AZURE_NODE_MACHINE_TYPE: Standard_NC6s_v3
+  metadata:
+    AZURE_CONTROL_PLANE_MACHINE_TYPE: Standard_D2s_v3
+    AZURE_LOCATION: southcentralus
+    KUBERNETES_VERSION: v1.22.1
+    WORKER_MACHINE_COUNT: "1"
 ```
