Makefile 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594
  1. # set the shell to bash always
  2. SHELL := /usr/bin/env bash
  3. # set make and shell flags to exit on errors
  4. MAKEFLAGS += --warn-undefined-variables
  5. .SHELLFLAGS := -euo pipefail -c
  6. ARCH ?= amd64 arm64 ppc64le
  7. # Detect local architecture for e2e testing
  8. LOCAL_ARCH := $(shell uname -m)
  9. ifeq ($(LOCAL_ARCH),x86_64)
  10. LOCAL_GOARCH := amd64
  11. else ifeq ($(LOCAL_ARCH),aarch64)
  12. LOCAL_GOARCH := arm64
  13. else ifeq ($(LOCAL_ARCH),arm64)
  14. LOCAL_GOARCH := arm64
  15. else ifeq ($(LOCAL_ARCH),ppc64le)
  16. LOCAL_GOARCH := ppc64le
  17. else
  18. LOCAL_GOARCH := amd64
  19. endif
  20. BUILD_ARGS ?= CGO_ENABLED=0
  21. DOCKER_BUILD_ARGS ?=
  22. DOCKERFILE ?= Dockerfile
  23. DOCKER ?= docker
  24. # default target is build
  25. .DEFAULT_GOAL := all
  26. .PHONY: all
  27. all: $(addprefix build-,$(ARCH))
  28. # Image registry for build/push image targets
  29. export IMAGE_REGISTRY ?= ghcr.io
  30. export IMAGE_REPO ?= external-secrets/external-secrets
  31. export IMAGE_NAME ?= $(IMAGE_REGISTRY)/$(IMAGE_REPO)
  32. BUNDLE_DIR ?= deploy/crds
  33. CRD_DIR ?= config/crds
  34. HELM_DIR ?= deploy/charts/external-secrets
  35. TF_DIR ?= terraform
  36. OUTPUT_DIR ?= bin
  37. # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
  38. ifeq (,$(shell go env GOBIN))
  39. GOBIN=$(shell go env GOPATH)/bin
  40. else
  41. GOBIN=$(shell go env GOBIN)
  42. endif
  43. # check if there are any existing `git tag` values
  44. ifeq ($(shell git tag),)
  45. # no tags found - default to initial tag `v0.0.0`
  46. export VERSION := $(shell echo "v0.0.0-$$(git rev-list HEAD --count)-g$$(git describe --dirty --always)" | sed 's/-/./2' | sed 's/-/./2')
  47. else
  48. # use tags
  49. export VERSION := $(shell git describe --dirty --always --tags --exclude 'helm*' | sed 's/-/./2' | sed 's/-/./2')
  50. endif
  51. TAG_SUFFIX ?=
  52. export IMAGE_TAG ?= $(VERSION)$(TAG_SUFFIX)
  53. # ====================================================================================
  54. # Colors
  55. BLUE := $(shell printf "\033[34m")
  56. YELLOW := $(shell printf "\033[33m")
  57. RED := $(shell printf "\033[31m")
  58. GREEN := $(shell printf "\033[32m")
  59. CNone := $(shell printf "\033[0m")
  60. # ====================================================================================
  61. # Logger
  62. TIME_LONG = `date +%Y-%m-%d' '%H:%M:%S`
  63. TIME_SHORT = `date +%H:%M:%S`
  64. TIME = $(TIME_SHORT)
  65. INFO = echo ${TIME} ${BLUE}[ .. ]${CNone}
  66. WARN = echo ${TIME} ${YELLOW}[WARN]${CNone}
  67. ERR = echo ${TIME} ${RED}[FAIL]${CNone}
  68. OK = echo ${TIME} ${GREEN}[ OK ]${CNone}
  69. FAIL = (echo ${TIME} ${RED}[FAIL]${CNone} && false)
  70. # ====================================================================================
  71. # Protobuf
  72. .PHONY: proto
  73. proto: ## Generate protobuf code
  74. @$(INFO) generating protobuf code
  75. @protoc --go_out=. --go_opt=paths=source_relative \
  76. --go-grpc_out=. --go-grpc_opt=paths=source_relative \
  77. -I. \
  78. providers/v2/common/proto/provider/secretstore.proto
  79. @protoc --go_out=. --go_opt=paths=source_relative \
  80. --go-grpc_out=. --go-grpc_opt=paths=source_relative \
  81. -I. \
  82. providers/v2/common/proto/generator/generator.proto
  83. @for file in \
  84. providers/v2/common/proto/provider/secretstore.pb.go \
  85. providers/v2/common/proto/provider/secretstore_grpc.pb.go \
  86. providers/v2/common/proto/generator/generator.pb.go \
  87. providers/v2/common/proto/generator/generator_grpc.pb.go; do \
  88. tmp=$$(mktemp); \
  89. cat hack/boilerplate.go.txt "$$file" > "$$tmp"; \
  90. mv "$$tmp" "$$file"; \
  91. done
  92. @$(OK) protobuf code generated
  93. # ====================================================================================
  94. # Conformance
  95. reviewable: generate docs manifests helm.generate helm.schema.update helm.docs lint license.check helm.test.update test.crds.update tf.fmt generate-providers verify-providers ## Ensure a PR is ready for review.
  96. @for module in . e2e apis runtime $$(find providers/v1 generators/v1 providers/v2 -name go.mod -not -path '*/vendor/*' -exec dirname {} \; | sort); do \
  97. (cd "$$module" && GOWORK=off go mod tidy); \
  98. done
  99. check-diff: reviewable ## Ensure branch is clean.
  100. @$(INFO) checking that branch is clean
  101. @test -z "$$(git status --porcelain)" || (echo "$$(git status --porcelain)" && $(FAIL))
  102. @$(OK) branch is clean
  103. update-deps: ## Update dependencies across all modules (root, apis, runtime, e2e, providers, generators)
  104. @./hack/update-deps.sh
  105. .PHONY: license.check
  106. license.check:
  107. $(DOCKER) run --rm -u $(shell id -u) -v $(shell pwd):/github/workspace apache/skywalking-eyes:0.6.0 header check
  108. # ====================================================================================
  109. # Golang
  110. .PHONY: go-work ## Creates go workspace and syncs it
  111. go-work:
  112. @$(INFO) creating go workspace
  113. @rm -rf go.work go.work.sum
  114. @GOWORK=off go work init
  115. @GOWORK="$(shell pwd)/go.work" go work use -r .
  116. @GOWORK="$(shell pwd)/go.work" go work edit -dropuse ./e2e
  117. @GOWORK="$(shell pwd)/go.work" go work sync
  118. @$(OK) created go workspace
  119. .PHONY: test
  120. test: generate envtest ## Run tests
  121. @$(INFO) go test unit-tests
  122. @set -e; \
  123. snap=$$(mktemp); \
  124. ./hack/modfiles.sh snapshot "$$snap"; \
  125. trap "./hack/modfiles.sh restore $$snap" EXIT INT TERM; \
  126. $(MAKE) go-work; \
  127. KUBEBUILDER_ASSETS="$$($(ENVTEST) use $(KUBERNETES_VERSION) -p path --bin-dir $(LOCALBIN))" \
  128. go test -tags $(PROVIDER) work -v -race -coverprofile cover.out
  129. @$(OK) go test unit-tests
  130. .PHONY: test.e2e
  131. test.e2e: generate ## Run e2e tests
  132. @$(INFO) go test e2e-tests
  133. $(MAKE) -C ./e2e test
  134. @$(OK) go test e2e-tests
  135. .PHONY: test.e2e.managed
  136. test.e2e.managed: generate ## Run e2e tests managed
  137. @$(INFO) go test e2e-tests-managed
  138. $(MAKE) -C ./e2e test.managed
  139. @$(OK) go test e2e-tests-managed
  140. .PHONY: test.e2e.v2
  141. test.e2e.v2: generate ## Run V2 E2E tests
  142. @$(INFO) go test v2 e2e-tests
  143. $(MAKE) -C ./e2e test.v2
  144. @$(OK) go test v2 e2e-tests
  145. .PHONY: test.e2e.v2.operational
  146. test.e2e.v2.operational: generate ## Run focused V2 operational E2E tests
  147. @$(INFO) go test v2 operational e2e-tests
  148. $(MAKE) -C ./e2e test.v2.operational
  149. @$(OK) go test v2 operational e2e-tests
  150. .PHONY: test.crds
  151. test.crds: cty crds.generate.tests ## Test CRDs for modification and backwards compatibility
  152. @$(INFO) $(CTY) test tests
  153. $(CTY) test tests
  154. @$(OK) No breaking CRD changes detected
  155. .PHONY: test.crds.update
  156. test.crds.update: cty crds.generate.tests ## Update the snapshots used by the CRD tests
  157. @$(INFO) $(CTY) test tests -u
  158. $(CTY) test tests -u
  159. @$(OK) Successfully updated all test snapshots
  160. .PHONY: build
  161. build: $(addprefix build-,$(ARCH)) ## Build binary
  162. PROVIDER ?= all_providers
  163. .PHONY: build-%
  164. build-%: generate ## Build binary for the specified arch
  165. @$(INFO) go build $*
  166. $(BUILD_ARGS) GOOS=linux GOARCH=$* \
  167. go build -tags $(PROVIDER) -o '$(OUTPUT_DIR)/external-secrets-linux-$*' main.go
  168. @$(OK) go build $*
  169. lint: golangci-lint ## Run golangci-lint (set LINT_TARGET to run on specific module, LINT_JOBS for parallel jobs)
  170. @if [ -n "$(LINT_TARGET)" ]; then \
  171. $(INFO) Running golangci-lint on $(LINT_TARGET); \
  172. (cd $(LINT_TARGET) && $(GOLANGCI_LINT) run ./...) || exit 1; \
  173. $(OK) Finished linting $(LINT_TARGET); \
  174. else \
  175. $(INFO) Running golangci-lint on all modules in parallel; \
  176. JOBS=$${LINT_JOBS:-1}; \
  177. TMPDIR=$$(mktemp -d); \
  178. GOLANGCI=$(GOLANGCI_LINT); \
  179. trap "rm -rf $$TMPDIR" EXIT; \
  180. export TMPDIR GOLANGCI; \
  181. find . -name go.mod -not -path "*/vendor/*" -not -path "*/e2e/*" -not -path "*/node_modules/*" -exec dirname {} \; | \
  182. xargs -n 1 -P $$JOBS sh -c ' \
  183. module="$$0"; \
  184. name=$$(echo "$$module" | sed "s/[\/\.]/_/g"); \
  185. echo "Linting $$module"; \
  186. if (cd "$$module" && $$GOLANGCI run ./... 2>&1); then \
  187. echo "✓ $$module" > "$$TMPDIR/$$name.success"; \
  188. else \
  189. echo "✗ $$module" > "$$TMPDIR/$$name.failed"; \
  190. exit 1; \
  191. fi \
  192. '; \
  193. FAILED=$$(find $$TMPDIR -name "*.failed" 2>/dev/null | wc -l | tr -d " "); \
  194. SUCCESS=$$(find $$TMPDIR -name "*.success" 2>/dev/null | wc -l | tr -d " "); \
  195. echo "Results: $$SUCCESS passed, $$FAILED failed"; \
  196. if [ $$FAILED -ne 0 ]; then \
  197. echo "Failed modules:"; \
  198. cat $$TMPDIR/*.failed 2>/dev/null || true; \
  199. $(ERR) Linting failed in $$FAILED module\(s\); \
  200. exit 1; \
  201. fi; \
  202. $(OK) Finished linting all modules; \
  203. fi
  204. generate: ## Generate code and crds
  205. @./hack/crd.generate.sh $(BUNDLE_DIR) $(CRD_DIR)
  206. @$(OK) Finished generating deepcopy and crds
  207. generate-providers: ## Generate provider main.go and Dockerfile files from provider.yaml configs
  208. @$(INFO) Generating provider files
  209. @cd providers/v2/hack && go run generate-provider-main.go -providers-dir=..
  210. @$(OK) Generated provider files
  211. verify-providers: ## Verify that provider files are up to date
  212. @$(INFO) Verifying provider files are up to date
  213. @cd providers/v2/hack && go run generate-provider-main.go -providers-dir=.. -dry-run
  214. @if ! git diff --quiet providers/v2/*/main.go providers/v2/*/Dockerfile 2>/dev/null; then \
  215. echo "Provider files are out of date. Run 'make generate-providers' to update them."; \
  216. git diff providers/v2/*/main.go providers/v2/*/Dockerfile; \
  217. exit 1; \
  218. fi
  219. @$(OK) Provider files are up to date
  220. # ====================================================================================
  221. # Local Utility
  222. # This is for running out-of-cluster locally, and is for convenience.
  223. # For more control, try running the binary directly with different arguments.
  224. run: generate ## Run app locally (without a k8s cluster)
  225. go run -tags $(PROVIDER) ./main.go
  226. manifests: helm.generate ## Generate manifests from helm chart
  227. mkdir -p $(OUTPUT_DIR)/deploy/manifests
  228. helm dependency build $(HELM_DIR)
  229. helm template external-secrets $(HELM_DIR) -f deploy/manifests/helm-values.yaml > $(OUTPUT_DIR)/deploy/manifests/external-secrets.yaml
  230. crds.install: generate ## Install CRDs into a cluster. This is for convenience
  231. kubectl apply -f $(BUNDLE_DIR) --server-side --force-conflicts
  232. crds.uninstall: ## Uninstall CRDs from a cluster. This is for convenience
  233. kubectl delete -f $(BUNDLE_DIR)
  234. crds.generate.tests:
  235. ./hack/test.crds.generate.sh $(BUNDLE_DIR) tests/crds
  236. @$(OK) Finished generating crds for testing
  237. tilt-up: tilt manifests ## Generates the local manifests that tilt will use to deploy the controller's objects.
  238. $(LOCALBIN)/tilt up
  239. # ====================================================================================
  240. # Helm Chart
  241. helm.docs: ## Generate helm docs
  242. @cd $(HELM_DIR); \
  243. $(DOCKER) run --rm -v $(shell pwd)/$(HELM_DIR):/helm-docs -u $(shell id -u) docker.io/jnorwood/helm-docs:v1.14.2
  244. HELM_VERSION ?= $(shell helm show chart $(HELM_DIR) | grep '^version:' | sed 's/version: //g')
  245. helm.build: helm.generate ## Build helm chart
  246. @$(INFO) helm package
  247. @helm package $(HELM_DIR) --dependency-update --destination $(OUTPUT_DIR)/chart
  248. @mv $(OUTPUT_DIR)/chart/external-secrets-$(HELM_VERSION).tgz $(OUTPUT_DIR)/chart/external-secrets.tgz
  249. @$(OK) helm package
  250. # install_helm_plugin is for installing the provided plugin, if it doesn't exist
  251. # $1 - plugin name
  252. # $2 - plugin version
  253. # $3 - plugin url
  254. define install_helm_plugin
  255. @v=$$(helm plugin list | awk '$$1=="$(1)"{print $$2}'); \
  256. if [ -z "$$v" ]; then \
  257. $(INFO) "Installing $(1) v$(2)"; \
  258. helm plugin install --version $(2) $(3); \
  259. $(OK) "Installed $(1) v$(2)"; \
  260. elif [ "$$v" != "$(2)" ]; then \
  261. $(INFO) "Found $(1) $$v. Reinstalling v$(2)"; \
  262. helm plugin remove $(1); \
  263. helm plugin install --version $(2) $(3); \
  264. $(OK) "Reinstalled $(1) v$(2)"; \
  265. else \
  266. $(OK) "$(1) already at v$(2)"; \
  267. fi
  268. endef
  269. HELM_SCHEMA_NAME := schema
  270. HELM_SCHEMA_VER := 2.2.1
  271. HELM_SCHEMA_URL := https://github.com/losisin/helm-values-schema-json.git
  272. helm.schema.plugin:
  273. $(call install_helm_plugin,$(HELM_SCHEMA_NAME),$(HELM_SCHEMA_VER), $(HELM_SCHEMA_URL))
  274. HELM_UNITTEST_PLUGIN_NAME := unittest
  275. HELM_UNITTEST_PLUGIN_VER := 1.0.0
  276. HELM_UNITTEST_PLUGIN_URL := https://github.com/helm-unittest/helm-unittest.git
  277. helm.unittest.plugin:
  278. $(call install_helm_plugin,$(HELM_UNITTEST_PLUGIN_NAME),$(HELM_UNITTEST_PLUGIN_VER), $(HELM_UNITTEST_PLUGIN_URL))
  279. helm.schema.update: helm.schema.plugin
  280. @$(INFO) Generating values.schema.json
  281. @helm schema -f $(HELM_DIR)/values.yaml -o $(HELM_DIR)/values.schema.json
  282. @$(OK) Generated values.schema.json
  283. helm.generate:
  284. ./hack/helm.generate.sh $(BUNDLE_DIR) $(HELM_DIR)
  285. @$(OK) Finished generating helm chart files
  286. helm.test: helm.unittest.plugin helm.generate
  287. @helm unittest deploy/charts/external-secrets/
  288. helm.test.update: helm.unittest.plugin helm.generate
  289. @helm unittest -u deploy/charts/external-secrets/
  290. helm.update.appversion:
  291. @chartversion=$$(yq .version ./deploy/charts/external-secrets/Chart.yaml) ; \
  292. chartappversion=$$(yq .appVersion ./deploy/charts/external-secrets/Chart.yaml) ; \
  293. chartname=$$(yq .name ./deploy/charts/external-secrets/Chart.yaml) ; \
  294. $(INFO) Update chartname and chartversion string in test snapshots.; \
  295. sed -s -i "s/^\([[:space:]]\+helm\.sh\/chart:\).*/\1 $${chartname}-$${chartversion}/" ./deploy/charts/external-secrets/tests/__snapshot__/*.yaml.snap ; \
  296. sed -s -i "s/^\([[:space:]]\+app\.kubernetes\.io\/version:\).*/\1 $${chartappversion}/" ./deploy/charts/external-secrets/tests/__snapshot__/*.yaml.snap ; \
  297. sed -s -i "s/^\([[:space:]]\+image: ghcr\.io\/external-secrets\/external-secrets:\).*/\1$${chartappversion}/" ./deploy/charts/external-secrets/tests/__snapshot__/*.yaml.snap ; \
  298. $(OK) "Version strings updated"
  299. # ====================================================================================
  300. # Documentation
  301. .PHONY: docs
  302. docs: generate ## Generate docs
  303. $(MAKE) -C ./hack/api-docs build
  304. .PHONY: docs.publish
  305. docs.publish: generate ## Generate and deploys docs
  306. $(MAKE) -C ./hack/api-docs build.publish
  307. .PHONY: docs.serve
  308. docs.serve: ## Serve docs
  309. $(MAKE) -C ./hack/api-docs serve
  310. DOCS_VERSION ?= $(VERSION)
  311. .PHONY: docs.update
  312. docs.update: ## Update docs
  313. $(MAKE) -C ./hack/api-docs stability-support.update DOCS_VERSION=$(DOCS_VERSION)
  314. # ====================================================================================
  315. # Build Artifacts
  316. .PHONY: build.all
  317. build.all: docker.build helm.build ## Build all artifacts (docker image, helm chart)
  318. .PHONY: docker.image
  319. docker.image: ## Emit IMAGE_NAME:IMAGE_TAG
  320. @echo $(IMAGE_NAME):$(IMAGE_TAG)
  321. .PHONY: docker.imagename
  322. docker.imagename: ## Emit IMAGE_NAME
  323. @echo $(IMAGE_NAME)
  324. .PHONY: docker.tag
  325. docker.tag: ## Emit IMAGE_TAG
  326. @echo $(IMAGE_TAG)
  327. .PHONY: docker.build
  328. docker.build: docker.build.controller docker.build.providers ## Build all docker images (controller + providers)
  329. .PHONY: docker.build.e2e
  330. docker.build.e2e: docker.build.controller.e2e ## Build docker images for local e2e testing (local arch only)
  331. .PHONY: docker.build.controller
  332. docker.build.controller: $(addprefix build-,$(ARCH)) ## Build the controller docker image
  333. @$(INFO) $(DOCKER) build controller
  334. @echo $(DOCKER) build -f $(DOCKERFILE) . $(DOCKER_BUILD_ARGS) -t $(IMAGE_NAME):$(IMAGE_TAG)
  335. @DOCKER_BUILDKIT=1 $(DOCKER) build -f $(DOCKERFILE) . $(DOCKER_BUILD_ARGS) -t $(IMAGE_NAME):$(IMAGE_TAG)
  336. @$(OK) $(DOCKER) build controller
  337. .PHONY: docker.build.controller.e2e
  338. docker.build.controller.e2e: build-$(LOCAL_GOARCH) ## Build the controller docker image for local arch only
  339. @$(INFO) $(DOCKER) build controller for $(LOCAL_GOARCH)
  340. @echo $(DOCKER) build -f $(DOCKERFILE) . $(DOCKER_BUILD_ARGS) -t $(IMAGE_NAME):$(IMAGE_TAG)
  341. @DOCKER_BUILDKIT=1 $(DOCKER) build -f $(DOCKERFILE) . $(DOCKER_BUILD_ARGS) -t $(IMAGE_NAME):$(IMAGE_TAG)
  342. @$(OK) $(DOCKER) build controller for $(LOCAL_GOARCH)
  343. .PHONY: docker.build.providers
  344. docker.build.providers: docker.build.provider.kubernetes docker.build.provider.aws docker.build.provider.fake ## Build all provider images
  345. .PHONY: docker.build.provider.kubernetes
  346. docker.build.provider.kubernetes: ## Build Kubernetes provider image
  347. @$(INFO) $(DOCKER) build kubernetes provider
  348. @DOCKER_BUILDKIT=1 $(DOCKER) build \
  349. -f providers/v2/kubernetes/Dockerfile \
  350. . \
  351. $(DOCKER_BUILD_ARGS) \
  352. -t $(IMAGE_REGISTRY)/external-secrets/provider-kubernetes:$(IMAGE_TAG)
  353. @$(OK) $(DOCKER) build kubernetes provider
  354. .PHONY: docker.build.provider.aws
  355. docker.build.provider.aws: ## Build AWS provider image
  356. @$(INFO) $(DOCKER) build AWS provider
  357. @DOCKER_BUILDKIT=1 $(DOCKER) build \
  358. -f providers/v2/aws/Dockerfile \
  359. . \
  360. $(DOCKER_BUILD_ARGS) \
  361. -t $(IMAGE_REGISTRY)/external-secrets/provider-aws:$(IMAGE_TAG)
  362. @$(OK) $(DOCKER) build AWS provider
  363. .PHONY: docker.build.provider.fake
  364. docker.build.provider.fake: ## Build Fake provider image
  365. @$(INFO) $(DOCKER) build Fake provider
  366. @DOCKER_BUILDKIT=1 $(DOCKER) build \
  367. -f providers/v2/fake/Dockerfile \
  368. . \
  369. $(DOCKER_BUILD_ARGS) \
  370. -t $(IMAGE_REGISTRY)/external-secrets/provider-fake:$(IMAGE_TAG)
  371. @$(OK) $(DOCKER) build Fake provider
  372. .PHONY: docker.push
  373. docker.push: docker.push.controller docker.push.providers ## Push all docker images to the registry
  374. .PHONY: docker.push.controller
  375. docker.push.controller: ## Push the controller docker image to the registry
  376. @$(INFO) $(DOCKER) push controller
  377. @$(DOCKER) push $(IMAGE_NAME):$(IMAGE_TAG)
  378. @$(OK) $(DOCKER) push controller
  379. .PHONY: docker.push.providers
  380. docker.push.providers: docker.push.provider.kubernetes docker.push.provider.aws docker.push.provider.fake ## Push all provider images
  381. .PHONY: docker.push.provider.kubernetes
  382. docker.push.provider.kubernetes: ## Push Kubernetes provider image
  383. @$(INFO) $(DOCKER) push kubernetes provider
  384. @$(DOCKER) push $(IMAGE_REGISTRY)/external-secrets/provider-kubernetes:$(IMAGE_TAG)
  385. @$(OK) $(DOCKER) push kubernetes provider
  386. .PHONY: docker.push.provider.aws
  387. docker.push.provider.aws: ## Push AWS provider image
  388. @$(INFO) $(DOCKER) push AWS provider
  389. @$(DOCKER) push $(IMAGE_REGISTRY)/external-secrets/provider-aws:$(IMAGE_TAG)
  390. @$(OK) $(DOCKER) push AWS provider
  391. .PHONY: docker.push.provider.fake
  392. docker.push.provider.fake: ## Push Fake provider image
  393. @$(INFO) $(DOCKER) push Fake provider
  394. @$(DOCKER) push $(IMAGE_REGISTRY)/external-secrets/provider-fake:$(IMAGE_TAG)
  395. @$(OK) $(DOCKER) push Fake provider
  396. # RELEASE_TAG is tag to promote. Default is promoting to main branch, but can be overriden
  397. # to promote a tag to a specific version.
  398. RELEASE_TAG ?= $(IMAGE_TAG)
  399. SOURCE_TAG ?= $(VERSION)$(TAG_SUFFIX)
  400. .PHONY: docker.promote
  401. docker.promote: ## Promote the docker image to the registry
  402. @$(INFO) promoting $(SOURCE_TAG) to $(RELEASE_TAG)
  403. $(DOCKER) manifest inspect --verbose $(IMAGE_NAME):$(SOURCE_TAG) > .tagmanifest
  404. for digest in $$(jq -r 'if type=="array" then .[] | select(.Descriptor.platform.architecture != "unknown") | .Descriptor.digest else .Descriptor.digest end' < .tagmanifest); do \
  405. $(DOCKER) pull $(IMAGE_NAME)@$$digest; \
  406. done
  407. $(DOCKER) manifest create $(IMAGE_NAME):$(RELEASE_TAG) \
  408. $$(jq -j 'if type=="array" then [.[] | select(.Descriptor.platform.architecture != "unknown")] | map("--amend $(IMAGE_NAME)@" + .Descriptor.digest) | join(" ") else "--amend $(IMAGE_NAME)@" + .Descriptor.digest end' < .tagmanifest)
  409. $(DOCKER) manifest push $(IMAGE_NAME):$(RELEASE_TAG)
  410. @$(OK) $(DOCKER) push $(RELEASE_TAG) \
  411. # ====================================================================================
  412. # Terraform
  413. define run_terraform
  414. @cd $(TF_DIR)/$1/infrastructure && \
  415. terraform init && \
  416. $2 && \
  417. cd ../kubernetes && \
  418. terraform init && \
  419. $3
  420. endef
  421. tf.plan.%:
  422. $(call run_terraform,$*,terraform plan,terraform plan)
  423. tf.apply.%:
  424. $(call run_terraform,$*,terraform apply -auto-approve,terraform apply -auto-approve)
  425. tf.destroy.%:
  426. @cd $(TF_DIR)/$*/kubernetes && \
  427. terraform init && \
  428. terraform destroy -auto-approve && \
  429. cd ../infrastructure && \
  430. terraform init && \
  431. terraform destroy -auto-approve
  432. tf.fmt:
  433. @cd $(TF_DIR) && \
  434. terraform fmt -recursive
  435. # ====================================================================================
  436. # Help
  437. .PHONY: help
  438. # only comments after make target name are shown as help text
  439. help: ## Displays this help message
  440. @echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/|/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s'|' | sort)"
  441. .PHONY: clean
  442. clean: ## Clean bins
  443. @$(INFO) clean
  444. @rm -f $(OUTPUT_DIR)/external-secrets-linux-*
  445. @$(OK) go build $*
  446. # ====================================================================================
  447. # Build Dependencies
  448. detected_OS := $(shell uname -s)
  449. real_OS := $(detected_OS)
  450. arch := $(shell uname -m)
  451. ifeq ($(detected_OS),Darwin)
  452. detected_OS := mac
  453. real_OS := darwin
  454. endif
  455. ifeq ($(detected_OS),Linux)
  456. detected_OS := linux
  457. real_OS := linux
  458. endif
  459. ## Location to install dependencies to
  460. LOCALBIN ?= $(shell pwd)/bin
  461. $(LOCALBIN):
  462. mkdir -p $(LOCALBIN)
  463. ## Tool Binaries
  464. TILT ?= $(LOCALBIN)/tilt
  465. CTY ?= $(LOCALBIN)/cty
  466. ENVTEST ?= $(LOCALBIN)/setup-envtest
  467. GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
  468. LINT_TARGET ?= ""
  469. ## Tool Versions
  470. GOLANGCI_VERSION := 2.11.3
  471. KUBERNETES_VERSION := 1.33.x
  472. TILT_VERSION := 0.33.21
  473. CTY_VERSION := 1.1.3
  474. .PHONY: envtest
  475. envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
  476. $(ENVTEST): $(LOCALBIN)
  477. test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
  478. .PHONY: golangci-lint
  479. .PHONY: $(GOLANGCI_LINT)
  480. golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
  481. $(GOLANGCI_LINT): $(LOCALBIN)
  482. test -s $(LOCALBIN)/golangci-lint && $(LOCALBIN)/golangci-lint version | grep -q $(GOLANGCI_VERSION) || \
  483. curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(LOCALBIN) v$(GOLANGCI_VERSION)
  484. .PHONY: tilt
  485. .PHONY: $(TILT)
  486. tilt: $(TILT) ## Download tilt locally if necessary. Architecture is locked at x86_64.
  487. $(TILT): $(LOCALBIN)
  488. test -s $(LOCALBIN)/tilt || curl -fsSL https://github.com/tilt-dev/tilt/releases/download/v$(TILT_VERSION)/tilt.$(TILT_VERSION).$(detected_OS).$(arch).tar.gz | tar -xz -C $(LOCALBIN) tilt
  489. .PHONY: cty
  490. .PHONY: $(CTY)
  491. cty: $(CTY) ## Download cty locally if necessary. Architecture is locked at x86_64.
  492. $(CTY): $(LOCALBIN)
  493. test -s $(LOCALBIN)/cty || curl -fsSL https://github.com/Skarlso/crd-to-sample-yaml/releases/download/v$(CTY_VERSION)/cty_$(real_OS)_amd64.tar.gz | tar -xz -C $(LOCALBIN) cty