feat: improve tiltfile, cleanup makefile (#117)

Author: rafalgalaw

.dockerignore

@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: MIT
+
+# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
+
+# Ignore build and test binaries
+bin/
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.test
+*.out
+
+# Ignore Go workspace and vendor files
+go.work
+go.work.sum
+vendor/
+
+# Ignore project directories not needed in container
+docs/
+hack/
+config/
+examples/
+scripts/
+tools/
+.github/
+.gitlab/
+
+# Ignore test files and directories
+*_test.go
+testdata/
+test/
+
+# Ignore IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Ignore OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Ignore Git and CI/CD files
+.git/
+.gitignore
+.gitattributes
+
+# Ignore Docker files (except main Dockerfile)
+.dockerignore
+docker-compose*.yml
+
+# Ignore documentation and config files
+*.md
+README*
+LICENSE*
+CONTRIBUTING*
+CHANGELOG*
+.env
+.env.*
+
+# Ignore temporary and log files
+tmp/
+temp/
+*.tmp
+*.log

Makefile

@@ -56,21 +56,15 @@ GOLANGCI_LINT_VERSION ?= v1.59.1
 GORELEASER_VERSION ?= v1.21.0
 MDTOC_VERSION ?= v1.1.0
 NANCY_VERSION ?= v1.0.46
-KIND_VERSION ?= v0.22.0
+KIND_VERSION ?= v0.30.0
 
 ##@ Build
-.PHONY: all build copy run clean
+.PHONY: all
 all: clean build copy docker-build apply
 
 build:
 	@go mod tidy
-	@if [ "$(OS)" = "mac" ]; then \
-		echo "Building $(BINARY_NAME) for mac..." && \
-		GOOS="darwin" CGO_ENABLED=0 go build $(GO_BUILD_FLAGS) -o $(BIN_DIR)/$(BINARY_NAME) $(PKG_PATH); \
-	else \
-	  	echo "Building $(BINARY_NAME) for linux..." && \
-		GOOS="linux" CGO_ENABLED=0 go build $(GO_BUILD_FLAGS) -o $(BIN_DIR)/$(BINARY_NAME) $(PKG_PATH); \
-	fi
+	go build $(GO_BUILD_FLAGS) -o $(BIN_DIR)/$(BINARY_NAME) $(PKG_PATH); \
 
 test:
 	@echo "Testing App..."
@@ -90,13 +84,13 @@ DEBUG = 0
 
 ##@ Local Development
 .PHONY: docker-build
-docker-build: ## Build a garm image with the k8s provider
-	docker build -t localhost:5000/garm-with-k8s:latest ./hack
+docker-build: ## Build image with the k8s provider
+	docker build -f ./hack/Dockerfile -t localhost:5000/garm-with-k8s:latest .
 	docker push localhost:5000/garm-with-k8s:latest
 
 .PHONY: docker-build-summerwind-runner
 docker-build-summerwind-runner: ## Build the used runner image
-	$(eval RUNNER_IMAGE ?= $(shell echo "localhost:5000/runner:linux-ubuntu-22.04-$(shell uname -m)"))
+	$(eval RUNNER_IMAGE ?= $(shell echo "localhost:5000/runner:linux-ubuntu-22.04"))
 	docker build -t $(RUNNER_IMAGE) ./runner/summerwind
 	docker push $(RUNNER_IMAGE)
 
@@ -127,7 +121,7 @@ endif
 	GARM_GITHUB_ORGANIZATION=$(GARM_GITHUB_ORGANIZATION) \
 	GARM_GITHUB_TOKEN=$(shell echo -n $(GARM_GITHUB_TOKEN) | base64) \
 	GARM_GITHUB_WEBHOOK_SECRET=$(shell echo -n $(GARM_GITHUB_WEBHOOK_SECRET) | base64) \
-	RUNNER_IMAGE=$(shell echo "localhost:5000/runner:linux-ubuntu-22.04-$(shell uname -m)") \
+	RUNNER_IMAGE=$(shell echo "localhost:5000/runner:linux-ubuntu-22.04") \
 	envsubst < hack/local-development/kubernetes/garm-operator-crs-envsubst.yaml > hack/local-development/kubernetes/garm-operator-crs.yaml
 
 .PHONY: prepare-operator
@@ -150,7 +144,7 @@ delete-kind-cluster:
 
 .PHONY: tilt-up
 tilt-up: kind-cluster ## Start tilt and build kind cluster
-	tilt up
+	tilt up --port $(or $(PORT),10350)
 
 ##@ Release
 .PHONY: release

Tiltfile

@@ -12,25 +12,15 @@ deploy_cert_manager(
     version='v1.15.3' # the version of cert-manager to deploy
 )
 
-# build garm-provider-k8s binary with 'make build copy'
-local_resource(
-    "build provider",
-    cmd="make build copy",
-    auto_init=True,
-    trigger_mode=TRIGGER_MODE_MANUAL,
-    labels=["garm-k8s-provider"],
-    deps=["."]
-)
-
-# build garm image garm-with-k8s and push to localhost:5000/garm-with-k8s in ./hack context
+# build image localhost:5000/garm-provider-k8s:latest in current context
 docker_build(
-    'localhost:5000/garm-with-k8s',
-    './hack'
+    "localhost:5000/garm-with-k8s",
+    ".",
+    dockerfile="./hack/Dockerfile"
 )
 
 # build gh action runner  image in ./runner context
-cpu_arch = str(local('uname -m')).strip()
-image_tag="localhost:5000/runner:linux-ubuntu-22.04-" + cpu_arch
+image_tag="localhost:5000/runner:linux-ubuntu-22.04"
 
 local_resource(
     "build runner",
@@ -57,16 +47,13 @@ k8s_resource(
         'garm-kubernetes-provider-config:ConfigMap:garm-server',
         'garm-data:PersistentVolumeClaim:garm-server',
         'garm-home:PersistentVolumeClaim:garm-server'
-
     ],
     labels=["garm-server"],
 )
 
-# deploy the garm-operator and CRs
+# deploy the garm-operator
 k8s_yaml('hack/local-development/kubernetes/garm-operator-all.yaml')
 
-k8s_yaml('hack/local-development/kubernetes/garm-operator-crs.yaml')
-
 k8s_resource(
     "garm-operator-controller-manager",
     objects=[
@@ -90,14 +77,32 @@ k8s_resource(
         'garm-operator-serving-cert:Certificate:garm-operator-system',
         'garm-operator-selfsigned-issuer:Issuer:garm-operator-system',
         'garm-operator-validating-webhook-configuration:ValidatingWebhookConfiguration:default',
-        'garm-server-config:GarmServerConfig:garm-operator-system',
-        'github:GitHubEndpoint:garm-operator-system',
-        'github-pat:GitHubCredential:garm-operator-system',
-        'github-pat:Secret:garm-operator-system',
-        'test-workflows:Repository:garm-operator-system',
-        'repo-webhook-secret:Secret:garm-operator-system',
-        'runner-default:Image:garm-operator-system',
-        'kubernetes-pool-repo:Pool:garm-operator-system'
     ],
     labels=["operator"],
 )
+
+# Extract all resource names and kinds dynamically from the garm-operator-crs.yaml
+k8s_yaml('hack/local-development/kubernetes/garm-operator-crs.yaml')
+
+def get_operator_objects():
+    result = []
+    yaml_content = read_yaml_stream('hack/local-development/kubernetes/garm-operator-crs.yaml')
+    for resource in yaml_content:
+        if 'kind' in resource and 'metadata' in resource:
+            kind = resource['kind']
+            metadata = resource['metadata']
+            if 'name' in metadata:
+                name = metadata['name']
+                namespace = metadata.get('namespace', 'garm-operator-system') if 'namespace' in metadata else 'garm-operator-system'
+                result.append(name + ':' + kind + ':' + namespace)
+    print('Total objects returned: %s' % len(result))
+    return result
+
+operator_objects = get_operator_objects()
+
+k8s_resource(
+    new_name='garm-operator-crs',
+    objects=operator_objects,
+    labels=["operator"],
+    resource_deps=['garm-operator-controller-manager']
+)

hack/.dockerignore

@@ -1,39 +1,41 @@
 # SPDX-License-Identifier: MIT
 
+ARG garm_repo_ref=v0.1.5
+
 FROM golang:1.24.2 AS build
 
-ARG garm_repo=https://github.com/cloudbase/garm
-ARG garm_repo_ref=v0.1.5
+WORKDIR /app
 
-# build garm binary
-# primarly used to get the binary build for
-# the local CPU architecture
-RUN git clone $garm_repo garm_repo && \
-  cd garm_repo && \
-  git checkout $garm_repo_ref && \
-  CGO_ENABLED=1 go install -ldflags "-linkmode external -extldflags '-static' -X github.com/cloudbase/garm/util/appdefaults.Version=$garm_repo_ref" ./cmd/garm && \
-  CGO_ENABLED=1 go install -ldflags "-linkmode external -extldflags '-static' -X github.com/cloudbase/garm/util/appdefaults.Version=$garm_repo_ref" ./cmd/garm-cli
+# Get default value from ARG assigned before FROM
+ARG garm_repo_ref
 
+RUN ARCH=$(uname -m) && \
+    case ${ARCH} in \
+      x86_64) ARCH=amd64 ;; \
+      aarch64) ARCH=arm64 ;; \
+      *) echo "Unsupported architecture: ${ARCH}" ;; \
+    esac && \
+    wget -q https://github.com/cloudbase/garm/releases/download/${garm_repo_ref}/garm-cli-linux-${ARCH}.tgz && \
+    tar -xzf garm-cli-linux-${ARCH}.tgz && \
+    mv garm-cli /go/bin/garm-cli && \
+    chmod +x /go/bin/garm-cli && \
+    rm garm-cli-linux-${ARCH}.tgz
 
-FROM alpine:3.18
 
-WORKDIR /opt/garm/
+COPY go.mod go.sum ./
 
-ENV PATH="${PATH}:/opt/garm/bin"
+RUN go mod download
 
-COPY --from=build /go/bin/garm ./bin/garm
-COPY --from=build /go/bin/garm-cli ./bin/garm-cli
+COPY . .
+
+RUN CGO_ENABLED=0 go build -ldflags="-s -w" -o ./garm-provider-k8s ./cmd/garm-provider-k8s
 
-COPY ./scripts/entrypoint.sh ./bin/entrypoint.sh
-COPY ./bin/garm-provider-k8s ./bin/garm-provider-k8s
+RUN chmod +x ./garm-provider-k8s && \
+    chmod +x /go/bin/garm-cli
 
-RUN chmod +x ./bin/entrypoint.sh && \
-  chmod +x ./bin/garm && \
-  chmod +x ./bin/garm-cli && \
-  chmod +x ./bin/garm-provider-k8s
 
-USER 65543:65543
+FROM ghcr.io/cloudbase/garm:${garm_repo_ref}
 
-EXPOSE 9997
+COPY --from=build /go/bin/garm-cli ./bin/garm-cli
 
-ENTRYPOINT ["/opt/garm/bin/entrypoint.sh"]
+COPY --from=build /app/garm-provider-k8s /opt/garm/providers.d/garm-provider-k8s

hack/Dockerfile

@@ -39,8 +39,8 @@ data:
     description = "kubernetes provider"
     provider_type = "external"
     [provider.external]
-    config_file = "/opt/garm/provider-config/garm-provider-k8s-config.yaml"
-    provider_executable = "/opt/garm/bin/garm-provider-k8s"
+    config_file = "/etc/garm/garm-provider-k8s-config.yaml"
+    provider_executable = "/opt/garm/providers.d/garm-provider-k8s"
     environment_variables = ["KUBERNETES_"]
 ---
 apiVersion: v1

hack/Dockerfile.debug

@@ -21,20 +21,22 @@ spec:
         - image: localhost:5000/garm-with-k8s:latest
           name: garm-server
           imagePullPolicy: Always
-          env:
-            - name: ARCH
-              value: <ARCH>
           volumeMounts:
             - name: data
               mountPath: /opt/garm/data
             - name: cli-config
               mountPath: /.local/share/garm-cli
             - name: garm-config
-              mountPath: /opt/garm/config
+              mountPath: /etc/garm/config.toml
+              subPath: config.toml
               readOnly: true
             - name: garm-kubernetes-provider-config
-              mountPath: /opt/garm/provider-config
+              mountPath: /etc/garm/garm-provider-k8s-config.yaml
+              subPath: garm-provider-k8s-config.yaml
+              readOnly: true
       securityContext:
+        runAsUser: 65534
+        runAsGroup: 65534
         runAsNonRoot: true
         fsGroup: 65534
       serviceAccountName: garm-server

hack/local-development/kubernetes/configmap.yaml

@@ -105,4 +105,4 @@ spec:
   runnerBootstrapTimeout: 2
   runnerPrefix: "garm-k8s"
   tags:
-    - linux-ubuntu-22.04-x86_64
+    - linux-ubuntu-22.04