feat: generalize container tool usage (#6932)

To allow also the usage of podman, a $(CONTAINER_TOOL) var is include in teh Makefile generation. This aligns with the changes in kubebuilder. Signed-off-by: Roland Huß <rhuss@redhat.com>

Author: rhuss

changelog/fragments/generalize-container-tool.yaml

@@ -0,0 +1,5 @@
+entries:
+ - description: >
+ The bundle build target now respects the CONTAINER_TOOL variable, allowing users to use alternative container tools like podman instead of docker.
+ kind: "change"
+ breaking: false 

internal/plugins/helm/v1/scaffolds/internal/templates/makefile.go

@@ -65,6 +65,9 @@ func (f *Makefile) SetTemplateDefaults() error {
 }
 
 const makefileTemplate = `
+# Container tool to use for building and pushing images
+CONTAINER_TOOL ?= docker
+
 # Image URL to use all building/pushing image targets
 IMG ?= {{ .Image }}
 
@@ -96,11 +99,11 @@ run: helm-operator ## Run against the configured Kubernetes cluster in ~/.kube/c
 
 .PHONY: docker-build
 docker-build: ## Build docker image with the manager.
-docker build -t ${IMG} .
+$(CONTAINER_TOOL) build -t ${IMG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
-docker push ${IMG}
+$(CONTAINER_TOOL) push ${IMG}
 
 # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
 # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
@@ -111,10 +114,10 @@ docker-push: ## Push docker image with the manager.
 PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 .PHONY: docker-buildx
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
-- docker buildx create --name project-v3-builder
-docker buildx use project-v3-builder
-- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile .
-- docker buildx rm project-v3-builder
+- $(CONTAINER_TOOL) buildx create --name project-v3-builder
+$(CONTAINER_TOOL) buildx use project-v3-builder
+- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile .
+- $(CONTAINER_TOOL) buildx rm project-v3-builder
 
 ##@ Deployment
 

internal/plugins/manifests/v2/init.go

@@ -230,6 +230,7 @@ bundle: manifests kustomize operator-sdk ## Generate bundle manifests and metada
 `
 
 makefileBundleFragmentNonGo = `
+
 .PHONY: bundle
 bundle: kustomize operator-sdk ## Generate bundle manifests and metadata, then validate generated files.
 $(OPERATOR_SDK) generate kustomize manifests -q
@@ -241,7 +242,7 @@ bundle: kustomize operator-sdk ## Generate bundle manifests and metadata, then v
 makefileBundleBuildPushFragment = `
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.
-docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
+$(CONTAINER_TOOL) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
 
 .PHONY: bundle-push
 bundle-push: ## Push the bundle image.
@@ -303,7 +304,7 @@ endif
 # https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
 .PHONY: catalog-build
 catalog-build: opm ## Build a catalog image.
-$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+$(OPM) index add --container-tool $(CONTAINER_TOOL) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
 
 # Push the catalog image.
 .PHONY: catalog-push

testdata/go/v4/memcached-operator/Makefile

@@ -279,7 +279,7 @@ bundle: manifests kustomize operator-sdk ## Generate bundle manifests and metada
 
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.
-docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
+$(CONTAINER_TOOL) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
 
 .PHONY: bundle-push
 bundle-push: ## Push the bundle image.
@@ -319,7 +319,7 @@ endif
 # https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
 .PHONY: catalog-build
 catalog-build: opm ## Build a catalog image.
-$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+$(OPM) index add --container-tool $(CONTAINER_TOOL) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
 
 # Push the catalog image.
 .PHONY: catalog-push

testdata/go/v4/monitoring/memcached-operator/Makefile

@@ -294,7 +294,7 @@ bundle: manifests kustomize operator-sdk ## Generate bundle manifests and metada
 
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.
-docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
+$(CONTAINER_TOOL) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
 
 .PHONY: bundle-push
 bundle-push: ## Push the bundle image.
@@ -334,7 +334,7 @@ endif
 # https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
 .PHONY: catalog-build
 catalog-build: opm ## Build a catalog image.
-$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+$(OPM) index add --container-tool $(CONTAINER_TOOL) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
 
 # Push the catalog image.
 .PHONY: catalog-push

testdata/helm/memcached-operator/Makefile

@@ -50,6 +50,9 @@ endif
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
 OPERATOR_SDK_VERSION ?= v1.39.2
 
+# Container tool to use for building and pushing images
+CONTAINER_TOOL ?= docker
+
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
 
@@ -81,11 +84,11 @@ run: helm-operator ## Run against the configured Kubernetes cluster in ~/.kube/c
 
 .PHONY: docker-build
 docker-build: ## Build docker image with the manager.
-docker build -t ${IMG} .
+$(CONTAINER_TOOL) build -t ${IMG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
-docker push ${IMG}
+$(CONTAINER_TOOL) push ${IMG}
 
 # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
 # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
@@ -96,10 +99,10 @@ docker-push: ## Push docker image with the manager.
 PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 .PHONY: docker-buildx
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
-- docker buildx create --name project-v3-builder
-docker buildx use project-v3-builder
-- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile .
-- docker buildx rm project-v3-builder
+- $(CONTAINER_TOOL) buildx create --name project-v3-builder
+$(CONTAINER_TOOL) buildx use project-v3-builder
+- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile .
+- $(CONTAINER_TOOL) buildx rm project-v3-builder
 
 ##@ Deployment
 
@@ -171,6 +174,7 @@ OPERATOR_SDK = $(shell which operator-sdk)
 endif
 endif
 
+
 .PHONY: bundle
 bundle: kustomize operator-sdk ## Generate bundle manifests and metadata, then validate generated files.
 $(OPERATOR_SDK) generate kustomize manifests --interactive=false -q
@@ -180,7 +184,7 @@ bundle: kustomize operator-sdk ## Generate bundle manifests and metadata, then v
 
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.
-docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
+$(CONTAINER_TOOL) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
 
 .PHONY: bundle-push
 bundle-push: ## Push the bundle image.
@@ -219,7 +223,7 @@ endif
 # https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
 .PHONY: catalog-build
 catalog-build: opm ## Build a catalog image.
-$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+$(OPM) index add --container-tool $(CONTAINER_TOOL) --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
 
 # Push the catalog image.
 .PHONY: catalog-push