Fix Tilt Setup/Config and Readme Instructions (#63)

* Initial working example.

* Cleanup instructions a bit further.

* Remove file and prefer to pull from CAPI.

* Move tilt stuff to makefile.

* Cleanup.

* Slight cleanup.

* Initial.

* Removed now excess file.

* Add dev context to tilt provider.

* Minor fixups.

* Minor fixups.

* Increase timeout for slower fargate containers.

Author: rejoshed

.gitignore

@@ -1,4 +1,3 @@
-
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -7,14 +6,18 @@
 *.dylib
 bin
 testbin/*
+
+# Various build/test artifacts.
 .tiltbuild
 *log
 *flag.mk
-
 out
 .build
 .DS_Store
 
+# CAPI used with Tilt.
+cluster-api
+
 # Ignore output of Makefile sed operations created when generating manifests.
 config/default/manager_image_patch_edited.yaml
 
@@ -24,16 +27,11 @@ config/default/manager_image_patch_edited.yaml
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# Kubernetes Generated files - skip generated files, except for vendored files
-
-!vendor/**/zz_generated.*
+# ACS Credentials file.
 cloud-config
 
-# editor and IDE paraphernalia
+# Editor and IDE paraphernalia
 .idea
 *.swp
 *.swo
 *~
-
-# generated from e2e testing
-_artifacts

Makefile

@@ -47,7 +47,7 @@ help: ## Display this help.
 MANIFEST_GEN_INPUTS=$(shell find ./api -type f -name "*test*" -prune -o -name "*zz_generated*" -prune -o -print)
 # Using a flag file here as config output is too complicated to be a target.
 # The following triggers manifest building if $(IMG) differs from that found in config/default/manager_image_patch.yaml.
-$(shell	grep -q "$(IMG)" config/default/manager_image_patch_edited.yaml || rm -f config/.flag.mk)
+$(shell	grep -qs "$(IMG)" config/default/manager_image_patch_edited.yaml || rm -f config/.flag.mk)
 .PHONY: manifests
 manifests: config/.flag.mk ## Generates crd, webhook, rbac, and other configuration manifests from kubebuilder instructions in go comments.
 config/.flag.mk: bin/controller-gen $(MANIFEST_GEN_INPUTS)
@@ -156,6 +156,7 @@ bin/kubectl bin/kube-apiserver bin/etcd &:
 clean: ## Clean.
 	rm -rf $(RELEASE_DIR)
 	rm -rf bin
+	rm -rf cluster-api
 
 ##@ Testing
 
@@ -173,3 +174,27 @@ test: lint generate-deepcopy generate-mocks bin/ginkgo bin/kubectl bin/kube-apis
 generate-mocks: bin/mockgen $(shell find ./pkg/mocks -type f -name "mock*.go") ## Generate mocks needed for testing. Primarily mocks of the cloud package.
 pkg/mocks/mock%.go: $(shell find ./pkg/cloud -type f -name "*test*" -prune -o -print)
 	go generate ./...
+
+##@ Tilt
+
+.PHONY: tilt-up 
+tilt-up: cluster-api kind-cluster cluster-api/tilt-settings.json manifests cloud-config # Setup and run tilt for development.
+	export CLOUDSTACK_B64ENCODED_SECRET=$(base64 -i cloud-config) && cd cluster-api && tilt up
+
+.PHONY: kind-cluster
+kind-cluster: cluster-api cluster-api/hack/kind-install-for-capd.sh # Create a kind cluster with a local Docker repository.
+	-./cluster-api/hack/kind-install-for-capd.sh
+
+cluster-api: # Clone cluster-api repository for tilt use.
+	git clone --branch v0.3.24 https://github.com/kubernetes-sigs/cluster-api.git
+
+# Need script from CAPI v1.0+
+# Can delete this target after upgrading to newer CAPI.
+cluster-api/hack/kind-install-for-capd.sh: cluster-api
+	cd cluster-api && git checkout v1.0.0 -- hack/kind-install-for-capd.sh
+
+# Need script from CAPI v1.0+
+# Can delete this target after upgrading to newer CAPI.
+cluster-api/tilt-settings.json: hack/tilt-settings.json cluster-api
+	cp ./hack/tilt-settings.json cluster-api
+

README.md

@@ -34,26 +34,7 @@ env var KUBEBUILDER_ASSETS should be enough for envtest to work.
 
 Install [tilt prerequisites](https://cluster-api.sigs.k8s.io/developer/tilt.html).
 
-Clone the capi repository at v1.0.0.
-
-`git clone https://github.com/kubernetes-sigs/cluster-api.git`
-`cd cluster-api`
-`git checkout v1.0.0`
-
-Setup a kind cluster using
-[capi repository]/hack/kind-install-for-capd.sh
-
-There is a tiltfile in the hack directory. Edit the relative repository to match the location of the capi repository.
-
-Copy the tiltfile into the capi repo.
-
-Note: Until a more automated tilt setup is built out, tilt will need the secret manually injected into 
-`config/default/credentials.yaml`. Use `base64 -i cloud-config | tr -d '\n'` to fill in 
-the `CLOUDSTACK_B64ENCODED_SECRET` that clusterctl would normally fill.
-
-  cloud-config: ${CLOUDSTACK_B64ENCODED_SECRET}
-
-Run `tilt up` from the capi repository.
+`make tilt-up`
 
 ## Running CAPC without Tilt - detailed instructions
 
@@ -91,7 +72,7 @@ Assuming your running environment is MacOS:
     2. Run the following command to save the above cloudstack connection info into an environment variable, to be used by `./config/default/credentials.yaml` and ultimately the generated `infrastructure-components.yaml`, where it gets passed to CAPC:
 
         ```
-        export CLOUDSTACK_B64ENCODED_SECRET=`base64 -i cloud-config`
+        export CLOUDSTACK_B64ENCODED_SECRET=$(base64 -i cloud-config)
         ```
 6. Set the IMG environment variable so that the Makefile knows where to push docker image (if building your own)
    1. `export IMG=localhost:5000/cluster-api-provider-capc`

config/dev/config/insecure_manager.yaml

@@ -0,0 +1,15 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller-manager
+  namespace: system
+  labels:
+    control-plane: capc-controller-manager
+spec:
+  template:
+    metadata:
+      labels:
+        control-plane: capc-controller-manager
+    spec:
+      securityContext:
+        runAsNonRoot: false

config/dev/config/kustomization.yaml

@@ -0,0 +1,4 @@
+bases:
+- ../../default
+patchesStrategicMerge:
+- insecure_manager.yaml

controllers/cloudstackcluster_controller_test.go

@@ -66,7 +66,7 @@ func getCapiCluster() *clusterv1.Cluster {
 }
 
 const (
-	timeout = time.Second * 30
+	timeout = time.Second * 60
 )
 
 var _ = Describe("CloudStackClusterReconciler", func() {