Make development with Tilt easier

Signed-off-by: michal.gubricky <[email protected]>

Author: michal-gubricky

.envrc.sample

@@ -10,3 +10,6 @@ export CLUSTER_TOPOLOGY=true
 export EXP_RUNTIME_SDK=true
 export EXP_MACHINE_SET_PREFLIGHT_CHECKS=true
 export CLUSTER_NAME=test-dfkhje
+export SECRET_NAME=supersecret
+export CLOUD_NAME=test
+export ENCODED_CLOUDS_YAML=mybase64encodedcloudsyamlfile

Makefile

@@ -166,7 +166,7 @@ all-tools: $(GOTESTSUM) $(go-cover-treemap) $(go-binsize-treemap) $(KIND) $(PACK
 ##@ Development
 
 env-vars-for-wl-cluster:
-	@./hack/ensure-env-variables.sh GIT_PROVIDER_B64 GIT_ACCESS_TOKEN_B64 GIT_ORG_NAME_B64 GIT_REPOSITORY_NAME_B64 EXP_CLUSTER_RESOURCE_SET CLUSTER_TOPOLOGY CLUSTER_NAME
+	@./hack/ensure-env-variables.sh GIT_PROVIDER_B64 GIT_ACCESS_TOKEN_B64 GIT_ORG_NAME_B64 GIT_REPOSITORY_NAME_B64 EXP_CLUSTER_RESOURCE_SET CLUSTER_TOPOLOGY CLUSTER_NAME SECRET_NAME CLOUD_NAME ENCODED_CLOUDS_YAML
 
 .PHONY: cluster
 cluster: $(CTLPTL) $(KUBECTL) ## Creates kind-dev Cluster 
@@ -569,6 +569,9 @@ builder-image-push: ## Build $(CONTROLLER_SHORT)-builder to a new version. For m
 # .PHONY: test
 # test: test-unit test-integration ## Runs all unit and integration tests.
 
+create-workload-cluster-openstack: $(ENVSUBST) $(KUBECTL)
+	cat .cluster.yaml | $(ENVSUBST) - | $(KUBECTL) apply -f -
+
 .PHONY: tilt-up
 tilt-up: env-vars-for-wl-cluster $(ENVSUBST) $(KUBECTL) $(KUSTOMIZE) $(TILT) cluster  ## Start a mgt-cluster & Tilt. Installs the CRDs and deploys the controllers
 	EXP_CLUSTER_RESOURCE_SET=true $(TILT) up --port=10351

Tiltfile

@@ -77,13 +77,19 @@ def prepare_environment():
     local("kubectl create namespace cluster --dry-run=client -o yaml | kubectl apply -f -")
 
     # if it's already present then don't copy
-    # if not os.path.exists('.clusterstack.yaml'):
-        # local("cp config/cspo/clusterstack.yaml .clusterstack.yaml")
+    if not os.path.exists('.clusterstack.yaml'):
+        local("cp config/cspo/clusterstack.yaml .clusterstack.yaml")
 
-    # k8s_yaml('.clusterstack.yaml')
+    k8s_yaml('.clusterstack.yaml')
 
-    # if not os.path.exists('.cluster.yaml'):
-        # local("cp config/cspo/cluster.yaml .cluster.yaml")
+    if not os.path.exists('.secret.yaml'):
+        local("cp config/cspo/secret.yaml .secret.yaml")
+
+    if not os.path.exists('.cluster.yaml'):
+        local("cp config/cspo/cluster.yaml .cluster.yaml")
+
+    if not os.path.exists('.clusterstacktemplate.yaml'):
+        local("cp config/cspo/clusterstacktemplate.yaml .clusterstacktemplate.yaml")
 
 def patch_args_with_extra_args(namespace, name, extra_args):
     args_str = str(local("kubectl get deployments {} -n {} -o jsonpath='{{.spec.template.spec.containers[0].args}}'".format(name, namespace)))
@@ -193,8 +199,16 @@ def deploy_cspo():
         labels = ["cspo"],
     )
 
-# def clusterstack():
-    # k8s_resource(objects = ["clusterstack:clusterstack"], new_name = "clusterstack", labels = ["CLUSTERSTACK"])
+def create_secret():
+    cmd = "cat .secret.yaml | {} | kubectl apply -f -".format(envsubst_cmd)
+    local_resource('supersecret', cmd, labels=["clouds-yaml-secret"])    
+
+def clusterstack_template():
+    cmd = "cat .clusterstacktemplate.yaml | {} | kubectl apply -f -".format(envsubst_cmd)
+    local_resource('cspotemplate', cmd, labels=["cspo-template"])  
+
+def clusterstack():
+    k8s_resource(objects = ["clusterstack:clusterstack"], new_name = "clusterstack", labels = ["clusterstack"])
 
 def base64_encode(to_encode):
     encode_blob = local("echo '{}' | tr -d '\n' | base64 - | tr -d '\n'".format(to_encode), quiet = True)
@@ -260,6 +274,19 @@ deploy_cspo()
 
 deploy_capo()
 
+clusterstack()
+
 waitforsystem()
 
-prepare_environment()
+prepare_environment()
+
+create_secret()
+
+clusterstack_template()
+
+cmd_button(
+    "create workload cluster",
+    argv=["make", "create-workload-cluster-openstack"],
+    location=location.NAV,
+    icon_name="add_circle",
+)

config/cspo/cluster.yaml

@@ -0,0 +1,27 @@
+apiVersion: cluster.x-k8s.io/v1beta1
+kind: Cluster
+metadata:
+  name: "${CLUSTER_NAME}"
+  namespace: cluster
+spec:
+  clusterNetwork:
+    services:
+      cidrBlocks: ["10.128.0.0/12"]
+    pods:
+      cidrBlocks: ["192.168.0.0/16"]
+    serviceDomain: "cluster.local"
+  topology:
+    class: openstack-ferrol-1-27-v1
+    controlPlane:
+      metadata: {}
+      replicas: 1
+    variables:
+      - name: imageRepository
+        value: ""
+    version: v1.27.3
+    workers:
+      machineDeployments:
+        - class: workeramd64
+          name: md-0
+          replicas: 1
+          failureDomain: nova

config/cspo/clusterstack.yaml

@@ -0,0 +1,17 @@
+apiVersion: clusterstack.x-k8s.io/v1alpha1
+kind: ClusterStack
+metadata:
+  name: clusterstack
+  namespace: cluster
+spec:
+  provider: openstack
+  name: ferrol
+  kubernetesVersion: "1.27"
+  channel: stable
+  autoSubscribe: false
+  providerRef:
+    apiVersion: infrastructure.clusterstack.x-k8s.io/v1alpha1
+    kind: OpenStackClusterStackReleaseTemplate
+    name: cspotemplate
+  versions:
+    - v1

config/cspo/clusterstacktemplate.yaml

@@ -0,0 +1,12 @@
+apiVersion: infrastructure.clusterstack.x-k8s.io/v1alpha1
+kind: OpenStackClusterStackReleaseTemplate
+metadata:
+  name: cspotemplate
+  namespace: cluster
+spec:
+  template:
+    spec:
+      cloudName: "${CLOUD_NAME}"
+      identityRef:
+        kind: Secret
+        name: "${SECRET_NAME}"

config/cspo/secret.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+data:
+  clouds.yaml: ${ENCODED_CLOUDS_YAML}
+kind: Secret
+metadata:
+  name: "${SECRET_NAME}"
+  namespace: cluster

docs/develop.md

@@ -24,32 +24,12 @@ make tilt-up
 
 > To access the Tilt UI please go to: `http://localhost:10351`
 
-You should make sure that everything in the UI looks green. If not, you can trigger the Tilt workflow again. To establish a connection to your OpenStack project, you must supply a secret containing the `clouds.yaml` file.
-
-```bash
-kubectl create secret generic <my-secret> --from-file=clouds.yaml=path/to/clouds.yaml
-```
-
-To transfer the credentials stored in the secret mentioned above to the operator, the user must create an `OpenStackClusterStackReleaseTemplate` object and specify this secret in the `identityRef` field. The `clouds.yaml` file may contain one or more clouds, so the user must specify desired connection to a specific cloud by using the `cloudName` field. Refer to the `examples/cspotemplate.yaml` file for more details. Afterward, apply this template to the local Kind cluster, which was built by the previous `make` command.
-
-```bash
-kubectl apply -f <path-to-openstack-clusterstack-release-template>
-```
-
-Now, proceed to apply the `ClusterStack` to the local Kind cluster. For more details see `examples/clusterstack.yaml`.
-
-```bash
-kubectl apply -f <path-to-openstack-clusterstack>
-```
-
-Please be patient and wait for the operator to execute the necessary tasks. In case your `ClusterStack` object encounters no errors and `openstacknodeimagereleases` is ready, you can deploy a workload cluster. This could be done by applying cluster-template. See the example of this template in `examples/cluster.yaml`.
-
-```bash
-kubectl apply -f <path-to-cluster-template>
-```
+You should make sure that everything in the UI looks green. If not, you can trigger the Tilt workflow again. In the case of the `cspotemplate`, this might be necessary, as it cannot be applied right after the startup of the cluster and fails. Tilt unfortunately does not include a waiting period.
 
 In case you want to change some code, you can do so and see that Tilt triggers on save. It will update the container of the operator automatically.
 
+If you want to change something in your ClusterStack or Cluster custom resources, you can have a look at `.cluster`.yaml and `.clusterstack.yaml`, which Tilt uses.
+
 To tear down the workload cluster press the "Delete Workload Cluster" button. After a few minutes, the resources should be deleted.
 
 To tear down the kind cluster, use: