Merge pull request #1002 from syself/tg/installimage-create-event-con…

…taining-debug-txt

🌱 Installimage: create events containing debug.txt and cloud-init-output.log

.gitignore

@@ -73,3 +73,5 @@ __pycache__/
 /_output
 tmp_*
 
+# baremetal hosts
+baremetalhosts*yaml

Makefile

@@ -191,7 +191,7 @@ install-cilium-in-wl-cluster:
 install-ccm-in-wl-cluster:
 	helm repo add syself https://charts.syself.com
 	helm repo update syself
-	KUBECONFIG=$(WORKER_CLUSTER_KUBECONFIG) helm upgrade --install ccm syself/ccm-hetzner --version 1.1.8 \
+	KUBECONFIG=$(WORKER_CLUSTER_KUBECONFIG) helm upgrade --install ccm syself/ccm-hetzner --version 1.1.10 \
 	--namespace kube-system \
 	--set privateNetwork.enabled=$(PRIVATE_NETWORK)
 	@echo 'run "kubectl --kubeconfig=$(WORKER_CLUSTER_KUBECONFIG) ..." to work with the new target cluster'
@@ -749,8 +749,12 @@ lint: lint-golang lint-yaml lint-dockerfile lint-links ## Lint Codebase
 .PHONY: format
 format: format-starlark format-golang format-yaml ## Format Codebase
 
+.PHONY: generate-mocks
+generate-mocks: ## Generate Mocks
+	cd pkg/services/baremetal/client; go run github.com/vektra/mockery/[email protected]
+
 .PHONY: generate
-generate: generate-manifests generate-go-deepcopy generate-boilerplate generate-modules ## Generate Files
+generate: generate-manifests generate-go-deepcopy generate-boilerplate generate-modules generate-mocks ## Generate Files
 
 ALL_VERIFY_CHECKS = boilerplate shellcheck starlark
 .PHONY: verify

api/v1beta1/hetznerbaremetalhost_types.go

@@ -137,7 +137,7 @@ const (
 	// StateProvisioning means we are sending userData to the host and boot the machine.
 	StateProvisioning ProvisioningState = "provisioning"
 
-	// StateEnsureProvisioned means we are ensuring the reboot worked and cloud init is installed.
+	// StateEnsureProvisioned means we are ensuring the reboot worked and cloud init was executed successfully.
 	StateEnsureProvisioned ProvisioningState = "ensure-provisioned"
 
 	// StateProvisioned means we have sent userData to the host and booted the machine.

controllers/hetznerbaremetalhost_controller_test.go

@@ -173,6 +173,8 @@ var _ = Describe("HetznerBareMetalHostReconciler", func() {
 			StdErr: "",
 			Err:    nil,
 		})
+		osSSHClientAfterInstallImage.On("GetCloudInitOutput").Return(sshclient.Output{StdOut: "dummy content of /var/log/cloud-init-output.log"})
+
 		osSSHClientAfterCloudInit.On("Reboot").Return(sshclient.Output{})
 		osSSHClientAfterCloudInit.On("GetHostName").Return(sshclient.Output{
 			StdOut: infrav1.BareMetalHostNamePrefix + bmMachineName,
@@ -182,6 +184,7 @@ var _ = Describe("HetznerBareMetalHostReconciler", func() {
 		osSSHClientAfterCloudInit.On("CloudInitStatus").Return(sshclient.Output{StdOut: "status: done"})
 		osSSHClientAfterCloudInit.On("CheckCloudInitLogsForSigTerm").Return(sshclient.Output{})
 		osSSHClientAfterCloudInit.On("ResetKubeadm").Return(sshclient.Output{})
+		osSSHClientAfterCloudInit.On("GetCloudInitOutput").Return(sshclient.Output{StdOut: "dummy content of /var/log/cloud-init-output.log"})
 	})
 
 	AfterEach(func() {
@@ -333,6 +336,7 @@ var _ = Describe("HetznerBareMetalHostReconciler", func() {
 				}, timeout, time.Second).Should(BeNil())
 
 				Eventually(func() bool {
+					// TODO: Add logging to trace flaky unit-test.
 					if err := testEnv.Get(ctx, key, host); err != nil {
 						return false
 					}
@@ -693,7 +697,7 @@ var _ = Describe("HetznerBareMetalHostReconciler - missing secrets", func() {
 			}, timeout).Should(BeTrue())
 		})
 
-		It("gives the right error if secret is invalid", func() {
+		It("gives the right error if secret if rescue-ssh is invalid", func() {
 			rescueSSHSecret = &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "rescue-ssh-secret",
@@ -828,4 +832,5 @@ name="eth0" model="Realtek Semiconductor Co., Ltd. RTL8111/8168/8411 PCI Express
 	sshClient.On("CreatePostInstallScript", mock.Anything).Return(sshclient.Output{})
 	sshClient.On("ExecuteInstallImage", mock.Anything).Return(sshclient.Output{})
 	sshClient.On("Reboot").Return(sshclient.Output{})
+	sshClient.On("GetCloudInitOutput").Return(sshclient.Output{StdOut: "dummy content of /var/log/cloud-init-output.log"})
 }

controllers/hetznerbaremetalmachine_controller_test.go

@@ -159,6 +159,8 @@ var _ = Describe("HetznerBareMetalMachineReconciler", func() {
 			StdErr: "",
 			Err:    nil,
 		})
+		osSSHClient.On("GetCloudInitOutput").Return(sshclient.Output{StdOut: "dummy content of /var/log/cloud-init-output.log"})
+
 	})
 
 	AfterEach(func() {

docs/topics/quickstart.md

@@ -127,7 +127,7 @@ KUBECONFIG=$CAPH_WORKER_CLUSTER_KUBECONFIG helm upgrade --install ccm syself/ccm
 helm repo add syself https://charts.syself.com
 helm repo update syself
 
-KUBECONFIG=$CAPH_WORKER_CLUSTER_KUBECONFIG helm upgrade --install ccm syself/ccm-hetzner --version 1.1.8 \
+KUBECONFIG=$CAPH_WORKER_CLUSTER_KUBECONFIG helm upgrade --install ccm syself/ccm-hetzner --version 1.1.10 \
 --namespace kube-system \
 --set privateNetwork.enabled=false
 ```

pkg/services/baremetal/client/.mockery.yaml

@@ -0,0 +1,16 @@
+# This config was choosen, so that the output matches to old structure (pre config file .mockery.yaml).
+# If you are here to copy this config to a new project, then it might
+# make sense to choose a structure which needs less config by using
+# the default values of Mockery.
+all: True
+filename: "{{.InterfaceName}}.go"
+mockname: "{{.InterfaceName}}"
+outpkg: mocks
+packages:
+  github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/ssh:
+    config:
+      dir: mocks/ssh
+
+  github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/robot:
+    config:
+      dir: mocks/robot