-
Notifications
You must be signed in to change notification settings - Fork 107
Expand file tree
/
Copy pathMakefile
More file actions
682 lines (562 loc) · 25.8 KB
/
Makefile
File metadata and controls
682 lines (562 loc) · 25.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# fix for some Linux distros (i.e. WSL)
SHELL := /usr/bin/env bash
# CONTAINER ENGINE: docker | podman
CONTAINER_ENGINE?=docker
DOCKER_SBOM_PLUGIN_VERSION=0.6.1
# VERSION defines the project version for the bundle.
# Update this value when you upgrade the version of your project.
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION_FILE=version.json
VERSION ?= $(shell git describe --always --tags --dirty --broken | cut -c 2-)
BUILDTIME ?= $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
GITCOMMIT ?= $(shell git rev-parse --short HEAD 2> /dev/null || true)
VERSION_PACKAGE = github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/version
# LD_FLAGS
LD_FLAGS := -X $(VERSION_PACKAGE).Version=$(VERSION)
LD_FLAGS += -X $(VERSION_PACKAGE).GitCommit=$(GITCOMMIT)
LD_FLAGS += -X $(VERSION_PACKAGE).BuildTime=$(BUILDTIME)
ifdef EXPERIMENTAL
LD_FLAGS += -X $(VERSION_PACKAGE).Experimental=$(EXPERIMENTAL)
endif
# NEXT_VERSION represents a version that is higher than anything released
# VERSION default value does not play well with the run target which might end up failing
# with errors such as:
# "version of the resource $Resource is higher than the operator version $VERSION"
# This happens if you use exported YAMLs from CLI and the dirty version is deemed a pre-release
NEXT_VERSION = 99.99.99-next
# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
# To re-generate a bundle for other specific channels without changing the standard setup, you can:
# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=preview,fast,stable)
# - use environment variables to overwrite this value (e.g export CHANNELS="preview,fast,stable")
CHANNELS ?= beta
ifneq ($(origin CHANNELS), undefined)
BUNDLE_CHANNELS := --channels=$(CHANNELS)
endif
# Used by the olm-deploy if you running on Mac and deploy to K8S/Openshift
ifndef TARGET_ARCH
TARGET_ARCH := $(shell go env GOARCH)
endif
ifndef TARGET_OS
TARGET_OS := $(shell go env GOOS)
endif
GO_UNIT_TEST_FOLDERS=$(shell go list ./... |grep -v 'test/int\|test/e2e')
# DEFAULT_CHANNEL defines the default channel used in the bundle.
# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
# To re-generate a bundle for any other default channel without changing the default setup, you can:
# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
DEFAULT_CHANNEL ?= beta
ifneq ($(origin DEFAULT_CHANNEL), undefined)
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
endif
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
# Base registry for the operator, bundle, catalog images
REGISTRY ?= quay.io/mongodb
# BUNDLE_IMG defines the image:tag used for the bundle.
# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
BUNDLE_IMG ?= $(REGISTRY)/mongodb-atlas-kubernetes-operator-prerelease-bundle:$(VERSION)
#BUNDLE_REGISTRY ?= $(REGISTRY)/mongodb-atlas-operator-bundle
RELEASED_OPERATOR_IMAGE ?= mongodb/mongodb-atlas-kubernetes-operator
OPERATOR_REGISTRY ?= $(REGISTRY)/mongodb-atlas-kubernetes-operator-prerelease
CATALOG_REGISTRY ?= $(REGISTRY)/mongodb-atlas-kubernetes-operator-prerelease-catalog
OPERATOR_IMAGE ?= ${OPERATOR_REGISTRY}:${VERSION}
CATALOG_IMAGE ?= ${CATALOG_REGISTRY}:${VERSION}
TARGET_NAMESPACE ?= mongodb-atlas-operator-system-test
# Image URL to use all building/pushing image targets
ifndef IMG
IMG := ${OPERATOR_REGISTRY}:${VERSION}
endif
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
GOBIN=$(shell go env GOPATH)/bin
else
GOBIN=$(shell go env GOBIN)
endif
# Track changes to sources to avoid repeating operations on sourced when soruces did not change
TMPDIR ?= /tmp
TIMESTAMPS_DIR := $(TMPDIR)/mongodb-atlas-kubernetes
GO_SOURCES = $(shell find . -type f -name '*.go' -not -path './vendor/*' -not -path './tools/*')
# Defaults for make run
OPERATOR_POD_NAME = mongodb-atlas-operator
OPERATOR_NAMESPACE = mongodb-atlas-system
ATLAS_DOMAIN = https://cloud-qa.mongodb.com/
ATLAS_KEY_SECRET_NAME = mongodb-atlas-operator-api-key
# Envtest configuration params
ENVTEST_ASSETS_DIR ?= $(shell pwd)/bin
ENVTEST_K8S_VERSION ?= 1.31.0
KUBEBUILDER_ASSETS ?= $(ENVTEST_ASSETS_DIR)/k8s/$(ENVTEST_K8S_VERSION)-$(TARGET_OS)-$(TARGET_ARCH)
# Ginkgo configuration
GINKGO_NODES ?= 12
GINKGO_EDITOR_INTEGRATION ?= true
GINKGO_OPTS = -vv --randomize-all --output-interceptor-mode=none --trace --timeout 90m --race --nodes=$(GINKGO_NODES) --cover --coverpkg=github.com/mongodb/mongodb-atlas-kubernetes/v2/... --coverprofile=coverprofile.out
GINKGO_FILTER_LABEL ?=
ifneq ($(GINKGO_FILTER_LABEL),)
GINKGO_FILTER_LABEL_OPT := --label-filter="$(GINKGO_FILTER_LABEL)"
endif
GINKGO=ginkgo run $(GINKGO_OPTS) $(GINKGO_FILTER_LABEL_OPT) $(shell pwd)/$@
BASE_GO_PACKAGE = github.com/mongodb/mongodb-atlas-kubernetes/v2
GO_LICENSES = go-licenses
GO_LICENSES_VERSION = 1.6.0
KUSTOMIZE = kustomize
DISALLOWED_LICENSES = restricted,reciprocal
REPORT_TYPE = flakiness
SLACK_WEBHOOK ?= https://hooks.slack.com/services/...
# Signature definitions
SIGNATURE_REPO ?= OPERATOR_REGISTRY
AKO_SIGN_PUBKEY = https://cosign.mongodb.com/atlas-kubernetes-operator.pem
OPERATOR_POD_NAME=mongodb-atlas-operator
RUN_YAML= # Set to the YAML to run when calling make run
RUN_LOG_LEVEL ?= debug
LOCAL_IMAGE=mongodb-atlas-kubernetes-operator:compiled
CONTAINER_SPEC=.spec.template.spec.containers[0]
KONDUKTO_REPO="mongodb/mongodb-atlas-kubernetes"
# branch prefix 'main' is always used currently
KONDUKTO_BRANCH_PREFIX=$(shell git rev-parse --abbrev-ref HEAD)
HELM_REPO_URL = "https://mongodb.github.io/helm-charts"
HELM_AKO_INSTALL_NAME = local-ako-install
HELM_AKO_NAMESPACE = $(OPERATOR_NAMESPACE)
GH_RUN_ID=$(shell gh run list -w Test -b main -e schedule -s success --json databaseId | jq '.[0] | .databaseId')
SBOMS_DIR ?= temp
.DEFAULT_GOAL := help
.PHONY: help
help: ## Show this help screen
# adapted from https://github.com/operator-framework/operator-sdk
@echo 'Usage: make <OPTIONS> ... <TARGETS>'
@echo ''
@echo 'Available targets are:'
@echo ''
@awk 'BEGIN {FS = ":.*##"} /^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
.PHONY: all
all: manager ## Build all binaries
.PHONY: compute-labels
compute-labels:
mkdir -p bin
go build -o bin/ginkgo-labels tools/compute-test-labels/main.go
.PHONY: build-licenses.csv
build-licenses.csv: go.mod ## Track licenses in a CSV file
@echo "Tracking licenses into file $@"
@echo "========================================"
export GOOS=linux
export GOARCH=amd64
GOTOOLCHAIN=local \
go run github.com/google/$(GO_LICENSES)@v$(GO_LICENSES_VERSION) csv --include_tests $(BASE_GO_PACKAGE)/... > licenses.csv
.PHONY: check-licenses
check-licenses: ## Check licenses are compliant with our restrictions
@echo "Checking licenses not to be: $(DISALLOWED_LICENSES)"
@echo "============================================"
export GOOS=linux
export GOARCH=amd64
GOTOOLCHAIN=local \
go run github.com/google/$(GO_LICENSES)@v$(GO_LICENSES_VERSION) check --include_tests \
--disallowed_types $(DISALLOWED_LICENSES) $(BASE_GO_PACKAGE)/...
@echo "--------------------"
@echo "Licenses check: PASS"
.PHONY: unit-test
unit-test: manifests
go test -race -cover $(GO_UNIT_TEST_FOLDERS) $(GO_TEST_FLAGS)
## Run integration tests. Sample with labels: `make test/int GINKGO_FILTER_LABEL=AtlasProject`
test/int: envtest manifests
AKO_INT_TEST=1 KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS) $(GINKGO)
test/int/clusterwide: envtest manifests
AKO_INT_TEST=1 KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS) $(GINKGO)
envtest: envtest-assets
KUBEBUILDER_ASSETS=$(shell setup-envtest use $(ENVTEST_K8S_VERSION) --bin-dir $(ENVTEST_ASSETS_DIR) -p path)
envtest-assets:
echo "Env: $(env)"
mkdir -p $(ENVTEST_ASSETS_DIR)
.PHONY: e2e
e2e: run-kind ## Run e2e test. Command `make e2e label=cluster-ns` run cluster-ns test
./scripts/e2e_local.sh $(label) $(build)
.PHONY: e2e2
e2e2: run-kind manager install-credentials install-crds set-namespace ## Run e2e2 tests. Command `make e2e2 label=integrations-ctlr` run integrations-ctlr e2e2 test
NO_GORUN=1 \
AKO_E2E2_TEST=1 \
OPERATOR_NAMESPACE=$(OPERATOR_NAMESPACE) \
ginkgo --race --label-filter=$(label) -ldflags="$(LD_FLAGS)" --timeout 120m -vv test/e2e2/
.PHONY: e2e-openshift-upgrade
e2e-openshift-upgrade:
cd scripts && ./openshift-upgrade-test.sh
bin/$(TARGET_OS)/$(TARGET_ARCH):
mkdir -p $@
bin/$(TARGET_OS)/$(TARGET_ARCH)/manager: $(GO_SOURCES) bin/$(TARGET_OS)/$(TARGET_ARCH)
@echo "Building operator with version $(VERSION); $(TARGET_OS) - $(TARGET_ARCH)"
CGO_ENABLED=0 GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) go build -o $@ -ldflags="$(LD_FLAGS)" cmd/main.go
@touch $@
bin/manager: bin/$(TARGET_OS)/$(TARGET_ARCH)/manager
cp bin/$(TARGET_OS)/$(TARGET_ARCH)/manager $@
.PHONY: manager
manager: generate fmt vet bin/manager ## Build manager binary
.PHONY: install
install: manifests ## Install CRDs from a cluster
$(KUSTOMIZE) build config/crd | kubectl apply -f -
.PHONY: uninstall
uninstall: manifests ## Uninstall CRDs from a cluster
$(KUSTOMIZE) build config/crd | kubectl delete -f -
.PHONY: deploy
deploy: generate manifests run-kind ## Deploy controller in the configured Kubernetes cluster in ~/.kube/config
@./scripts/deploy.sh
.PHONY: manifests
# Produce CRDs that work back to Kubernetes 1.16 (so 'apiVersion: apiextensions.k8s.io/v1')
manifests: CRD_OPTIONS ?= "crd:crdVersions=v1,ignoreUnexportedFields=true"
manifests: ## Generate manifests e.g. CRD, RBAC etc.
controller-gen $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./api/..." paths="./internal/controller/..." output:crd:artifacts:config=config/crd/bases
touch config/crd/bases/kustomization.yaml
sh -c 'cd config/crd/bases; $(KUSTOMIZE) edit add resource *.yaml kustomization.yaml'
@./scripts/split_roles_yaml.sh
ifdef EXPERIMENTAL
@if [ -d internal/next-crds ] && find internal/next-crds -maxdepth 1 -name '*.yaml' | grep -q .; then \
controller-gen crd paths="./internal/nextapi/v1" output:crd:artifacts:config=internal/next-crds; \
else \
echo "No experimental CRDs found, skipping apply."; \
fi
endif
.PHONY: lint
lint: ## Run the lint against the code
golangci-lint run --timeout 10m
$(TIMESTAMPS_DIR)/fmt: $(GO_SOURCES)
go tool -modfile=tools/toolbox/go.mod gci write -s standard -s default -s localmodule $(GO_SOURCES)
@mkdir -p $(TIMESTAMPS_DIR) && touch $@
.PHONY: fmt
fmt: $(TIMESTAMPS_DIR)/fmt ## Run gci (stricter go fmt & imports) against code
$(TIMESTAMPS_DIR)/vet: $(GO_SOURCES)
go vet ./...
@mkdir -p $(TIMESTAMPS_DIR) && touch $@
.PHONY: vet
vet: $(TIMESTAMPS_DIR)/vet ## Run go vet against code
.PHONY: generate
generate: ${GO_SOURCES} ## Generate code
controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./api/..." paths="./internal/controller/..."
ifdef EXPERIMENTAL
controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./internal/nextapi/v1/..."
endif
mockery
$(MAKE) fmt
.PHONY: check-missing-files
check-missing-files: ## Check autogenerated runtime objects and manifest files are missing
$(info Checking autogenerated runtime objects and manifests)
$(info ============================================)
ifneq ($(shell git ls-files -o -m --directory --exclude-standard --no-empty-directory),)
$(info Detected files that need to be committed:)
$(info $(shell git ls-files -o -m --directory --exclude-standard --no-empty-directory | sed -e "s/^/ /"))
$(info )
$(info Try running: make generate manifests api-docs)
$(error Check: FAILED)
else
$(info Check: PASS)
endif
.PHONY: validate-manifests
validate-manifests: generate manifests
$(MAKE) check-missing-files
.PHONE: sync-crds-chart
sync-crds-chart: bundle
@cp -r bundle/manifests/atlas.mongodb.com_* helm-charts/atlas-operator-crds/templates/
.PHONY: validate-crds-chart
validate-crds-chart: ## Validate the CRDs in the Helm chart
@echo "Validating CRDs in the Helm chart"
@for file in bundle/manifests/atlas.mongodb.com_*.yaml; do \
helm_file=helm-charts/atlas-operator-crds/templates/$$(basename $$file); \
if ! cmp -s $$file $$helm_file; then \
echo "CRD files do not match: $$file and $$helm_file"; \
exit 1; \
fi; \
done
@echo "All CRD files match"
@cd helm-charts/atlas-operator-crds && helm template . > /dev/null
.PHONY: bundle
bundle: manifests ## Generate bundle manifests and metadata, then validate generated files.
INPUT_VERSION=$(VERSION) INPUT_ENV=prod INPUT_IMAGE_URL=$(IMG) sh ./.github/actions/gen-install-scripts/entrypoint.sh
.PHONY: image
image: ## Build an operator image for local development
$(MAKE) bin/linux/amd64/manager TARGET_OS=linux TARGET_ARCH=amd64 VERSION=$(VERSION)
$(MAKE) bin/linux/arm64/manager TARGET_OS=linux TARGET_ARCH=arm64 VERSION=$(VERSION)
$(CONTAINER_ENGINE) build -f fast.Dockerfile --build-arg VERSION=$(VERSION) -t $(OPERATOR_IMAGE) .
$(CONTAINER_ENGINE) push $(OPERATOR_IMAGE)
.PHONY: image-multiarch
image-multiarch: ## Build releaseable multi-architecture operator image
$(MAKE) bin/linux/amd64/manager TARGET_OS=linux TARGET_ARCH=amd64 VERSION=$(VERSION)
$(MAKE) bin/linux/arm64/manager TARGET_OS=linux TARGET_ARCH=arm64 VERSION=$(VERSION)
$(CONTAINER_ENGINE) buildx create --use --name multiarch-builder \
--driver docker-container --bootstrap || echo "reusing multiarch-builder"
$(CONTAINER_ENGINE) buildx build --platform linux/amd64,linux/arm64 --push \
-f fast.Dockerfile --build-arg VERSION=$(VERSION) -t $(OPERATOR_IMAGE) .
.PHONY: bundle-build
bundle-build: ## Build the bundle image.
$(CONTAINER_ENGINE) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
.PHONY: bundle-push
bundle-push:
$(CONTAINER_ENGINE) push $(BUNDLE_IMG)
.PHONY: catalog-build
CATALOG_DIR ?= ./scripts/openshift/atlas-catalog
catalog-build: image
CATALOG_DIR=$(CATALOG_DIR) \
CHANNEL=$(DEFAULT_CHANNEL) \
CATALOG_IMAGE=$(CATALOG_IMAGE) \
BUNDLE_IMAGE=$(BUNDLE_IMG) \
VERSION=$(VERSION) \
./scripts/build_catalog.sh
.PHONY: catalog-push
catalog-push:
$(CONTAINER_ENGINE) push $(CATALOG_IMAGE)
.PHONY: build-subscription
build-subscription:
CATALOG_DIR=$(shell dirname "$(CATALOG_DIR)") \
CHANNEL=$(DEFAULT_CHANNEL) \
TARGET_NAMESPACE=$(TARGET_NAMESPACE) \
./scripts/build_subscription.sh
.PHONY: build-catalogsource
build-catalogsource:
CATALOG_DIR=$(shell dirname "$(CATALOG_DIR)") \
CATALOG_IMAGE=$(CATALOG_IMAGE) \
CATALOG_DISPLAY_NAME="MongoDB Atlas operator $(VERSION)" \
./scripts/build_catalogsource.sh
.PHONY: deploy-olm
# Deploy atlas operator to the running openshift cluster with OLM
deploy-olm: bundle-build bundle-push catalog-build catalog-push build-catalogsource build-subscription
oc -n openshift-marketplace delete catalogsource mongodb-atlas-kubernetes-local --ignore-not-found
oc delete namespace $(TARGET_NAMESPACE) --ignore-not-found
oc create namespace $(TARGET_NAMESPACE)
oc -n openshift-marketplace apply -f ./scripts/openshift/catalogsource.yaml
oc -n $(TARGET_NAMESPACE) apply -f ./scripts/openshift/operatorgroup.yaml
oc -n $(TARGET_NAMESPACE) apply -f ./scripts/openshift/subscription.yaml
## Disabled for now
## .PHONY: docker-login-olm
## docker-login-olm:
## docker login -u $(shell oc whoami) -p $(shell oc whoami -t) $(REGISTRY)
.PHONY: image-push
image-push: ## Push the docker image
$(CONTAINER_ENGINE) push ${IMG}
# Additional make goals
.PHONY: run-kind
run-kind: ## Create a local kind cluster
bash ./scripts/create_kind_cluster.sh;
.PHONY: stop-kind
stop-kind: ## Stop the local kind cluster
kind delete cluster
.PHONY: log
log: ## View manager logs
kubectl logs deploy/mongodb-atlas-operator manager -n mongodb-atlas-system -f
.PHONY: clear-atlas
clear-atlas: export INPUT_ATLAS_PUBLIC_KEY=$(shell grep "ATLAS_PUBLIC_KEY" .actrc | cut -d "=" -f 2)
clear-atlas: export INPUT_ATLAS_PRIVATE_KEY=$(shell grep "ATLAS_PRIVATE_KEY" .actrc | cut -d "=" -f 2)
clear-atlas: ## Clear Atlas organization
bash .github/actions/cleanup/entrypoint.sh
.PHONY: post-install-hook
post-install-hook:
GOARCH=amd64 GOOS=linux CGO_ENABLED=0 go build -o bin/helm-post-install cmd/post-install/main.go
chmod +x bin/helm-post-install
.PHONY: x509-cert
x509-cert: ## Create X.509 cert at path tmp/x509/ (see docs/x509-user.md)
go run scripts/create_x509.go
clean: ## Clean built binaries
rm -rf bin/*
rm -rf config/manifests/bases/
rm -f config/crd/bases/*.yaml
rm -f config/rbac/clusterwide/role.yaml
rm -f config/rbac/namespaced/role.yaml
rm -f config/rbac/role.yaml
rm -rf deploy/
rm -rf bundle/
rm -f bundle.Dockerfile
rm -rf test/e2e/data/
.PHONY: all-platforms
all-platforms:
$(MAKE) bin/linux/amd64/manager TARGET_OS=linux TARGET_ARCH=amd64 VERSION=$(VERSION)
$(MAKE) bin/linux/arm64/manager TARGET_OS=linux TARGET_ARCH=arm64 VERSION=$(VERSION)
.PHONY: all-platforms-docker
all-platforms-docker: all-platforms
docker build --build-arg BINARY_PATH=bin/linux/amd64 -f fast.Dockerfile -t manager-amd64 .
docker build --build-arg BINARY_PATH=bin/linux/arm64 -f fast.Dockerfile -t manager-arm64 .
actions.txt: .github/workflows/ ## List GitHub Action dependencies
./scripts/list-actions.sh > $@
.PHONY: check-major-version
check-major-version: ## Check that VERSION starts with MAJOR_VERSION
@VERSION_MAJOR=$$(echo "$(VERSION)" | cut -d. -f1 | sed 's/v//'); \
CURRENT_MAJOR=$$(jq -r '.current' $(VERSION_FILE) | cut -d. -f1); \
[ "$$VERSION_MAJOR" = "$$CURRENT_MAJOR" ] || \
(echo "Bad major version for $$VERSION expected $$CURRENT_MAJOR"; exit 1)
tools/makejwt/makejwt: tools/makejwt/*.go
cd tools/makejwt && go test . && go build .
.PHONY: check-version
check-version: ## Check the version is correct & releasable (vX.Y.Z and not "*-dirty" or "unknown")
VERSION=$(VERSION) BINARY=bin/$(TARGET_OS)/$(TARGET_ARCH)/manager ./scripts/version-check.sh
.PHONY: release-helm
release-helm: tools/makejwt/makejwt ## kick the operator helm chart release
ifndef JWT_RSA_PEM_KEY_BASE64
@echo "Must set JWT_RSA_PEM_KEY_BASE64 and JWT_APP_ID to $@"
@exit 1
endif
@APP_ID=$(JWT_APP_ID) RSA_PEM_KEY_BASE64=$(JWT_RSA_PEM_KEY_BASE64) \
VERSION=$(VERSION) ./scripts/release-helm.sh
.PHONY: github-token
github-token: tools/makejwt/makejwt ## github-token gets a GitHub token from a key in env vars
ifndef JWT_RSA_PEM_KEY_BASE64
@echo "Must set JWT_RSA_PEM_KEY_BASE64 and JWT_APP_ID to get $@"
@exit 1
endif
@REPO=mongodb/mongodb-atlas-kubernetes APP_ID=$(JWT_APP_ID) \
RSA_PEM_KEY_BASE64=$(JWT_RSA_PEM_KEY_BASE64) ./scripts/gh-access-token.sh
tools/metrics/metrics: tools/metrics/*.go
cd tools/metrics && go test . && go build .
.PHONY: slack-report
slack-report: tools/metrics/metrics ## slack a report
ifndef GITHUB_TOKEN
echo "Getting GitHub token..."
$(eval GITHUB_TOKEN := $(shell $(MAKE) -s github-token))
endif
@echo "Computing and sending $(REPORT_TYPE) report to Slack..."
@GITHUB_TOKEN=$(GITHUB_TOKEN) FORMAT=summary ./tools/metrics/metrics $(REPORT_TYPE) | \
./scripts/slackit.sh $(SLACK_WEBHOOK)
.PHONY: test-clean
test-clean:
cd tools/clean && go test ./...
.PHONY: test-makejwt
test-makejwt:
cd tools/makejwt && go test ./...
.PHONY: test-metrics
test-metrics:
cd tools/metrics && go test ./...
.PHONY: test-tools ## Test all tools
test-tools: test-clean test-makejwt test-metrics
.PHONY: sign
sign: ## Sign an AKO multi-architecture image
@echo "Signing multi-architecture image $(IMG)..."
IMG=$(IMG) SIGNATURE_REPO=$(SIGNATURE_REPO) ./scripts/sign-multiarch.sh
./ako.pem:
curl $(AKO_SIGN_PUBKEY) > $@
.PHONY: verify
verify: ./ako.pem ## Verify an AKO multi-architecture image's signature
@echo "Verifying multi-architecture image signature $(IMG)..."
IMG=$(IMG) SIGNATURE_REPO=$(SIGNATURE_REPO) \
./scripts/sign-multiarch.sh verify && echo "VERIFIED OK"
.PHONY: helm-upd-crds
helm-upd-crds:
HELM_CRDS_PATH=$(HELM_CRDS_PATH) ./scripts/helm-upd-crds.sh
.PHONY: helm-upd-rbac
helm-upd-rbac:
HELM_RBAC_FILE=$(HELM_RBAC_FILE) ./scripts/helm-upd-rbac.sh
.PHONY: vulncheck
vulncheck: ## Run govulncheck to find vulnerabilities in code
@./scripts/vulncheck.sh ./vuln-ignore
.PHONY: generate-sboms
generate-sboms: ./ako.pem ## Generate a released version SBOMs
mkdir -p docs/releases/v$(VERSION) && \
./scripts/generate_upload_sbom.sh -i $(RELEASED_OPERATOR_IMAGE):$(VERSION) -o docs/releases/v$(VERSION) && \
ls -l docs/releases/v$(VERSION)
.PHONY: gen-sdlc-checklist
gen-sdlc-checklist: ## Generate the SDLC checklist
@VERSION="$(VERSION)" AUTHORS="$(AUTHORS)" ./scripts/gen-sdlc-checklist.sh
# TODO: avoid leaving leftovers in the first place
.PHONY: clear-e2e-leftovers
clear-e2e-leftovers: ## Clear the e2e test leftovers quickly
git restore bundle* config deploy
cd helm-charts && git restore .
git submodule update helm-charts
.PHONY: install-crds
install-crds: manifests ## Install CRDs in Kubernetes
kubectl apply -k config/crd
ifdef EXPERIMENTAL
@if [ -d internal/next-crds ] && find internal/next-crds -maxdepth 1 -name '*.yaml' | grep -q .; then \
kubectl apply -f internal/next-crds/*.yaml; \
else \
echo "No experimental CRDs found, skipping apply."; \
fi
endif
.PHONY: set-namespace
set-namespace:
kubectl create namespace $(OPERATOR_NAMESPACE) || echo "Namespace already in place"
.PHONY: install-credentials
install-credentials: set-namespace ## Install the Atlas credentials for the Operator
kubectl create secret generic $(ATLAS_KEY_SECRET_NAME) \
--from-literal="orgId=$(MCLI_ORG_ID)" \
--from-literal="publicApiKey=$(MCLI_PUBLIC_API_KEY)" \
--from-literal="privateApiKey=$(MCLI_PRIVATE_API_KEY)" \
-n "$(OPERATOR_NAMESPACE)" || echo "Secret already in place"
kubectl label secret -n "${OPERATOR_NAMESPACE}" \
$(ATLAS_KEY_SECRET_NAME) atlas.mongodb.com/type=credentials
.PHONY: prepare-run
prepare-run: generate vet manifests run-kind install-crds install-credentials
rm -f bin/manager
$(MAKE) manager VERSION=$(NEXT_VERSION)
.PHONY: run
run: prepare-run ## Run a freshly compiled manager against kind
ifdef RUN_YAML
kubectl apply -n $(OPERATOR_NAMESPACE) -f $(RUN_YAML)
endif
ifdef BACKGROUND
@bash -c '(VERSION=$(NEXT_VERSION) \
OPERATOR_POD_NAME=$(OPERATOR_POD_NAME) \
OPERATOR_NAMESPACE=$(OPERATOR_NAMESPACE) \
nohup bin/manager --object-deletion-protection=false --log-level=$(RUN_LOG_LEVEL) \
--atlas-domain=$(ATLAS_DOMAIN) \
--global-api-secret-name=$(ATLAS_KEY_SECRET_NAME) > ako.log 2>&1 & echo $$! > ako.pid \
&& echo "OPERATOR_PID=$$!")'
else
VERSION=$(NEXT_VERSION) \
OPERATOR_POD_NAME=$(OPERATOR_POD_NAME) \
OPERATOR_NAMESPACE=$(OPERATOR_NAMESPACE) \
bin/manager --object-deletion-protection=false --log-level=$(RUN_LOG_LEVEL) \
--atlas-domain=$(ATLAS_DOMAIN) \
--global-api-secret-name=$(ATLAS_KEY_SECRET_NAME)
endif
.PHONY: stop-ako
stop-ako:
@kill `cat ako.pid` && rm ako.pid || echo "AKO process not found or already stopped!"
.PHONY: local-docker-build
local-docker-build:
docker build -f fast.Dockerfile -t $(LOCAL_IMAGE) .
.PHONY: prepare-all-in-one
prepare-all-in-one: local-docker-build run-kind
kubectl create namespace mongodb-atlas-system || echo "Namespace already in place"
kind load docker-image $(LOCAL_IMAGE)
.PHONY: test-all-in-one
test-all-in-one: prepare-all-in-one install-credentials ## Test the deploy/all-in-one.yaml definition
# Test all in one with a local image and at $(ATLAS_DOMAIN) (cloud-qa)
kubectl apply -f deploy/all-in-one.yaml
yq deploy/all-in-one.yaml \
| yq 'select(.kind == "Deployment") | $(CONTAINER_SPEC).imagePullPolicy="IfNotPresent"' \
| yq 'select(.kind == "Deployment") | $(CONTAINER_SPEC).image="$(LOCAL_IMAGE)"' \
| yq 'select(.kind == "Deployment") | $(CONTAINER_SPEC).args[0]="--atlas-domain=$(ATLAS_DOMAIN)"' \
| kubectl apply -f -
.PHONY: upload-sbom-to-kondukto
upload-sbom-to-kondukto: ## Upload a given SBOM (lite) file to Kondukto
@KONDUKTO_REPO=$(KONDUKTO_REPO) KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) \
./scripts/upload-to-kondukto.sh $(SBOM_JSON_FILE)
.PHONY: augment-sbom
augment-sbom: ## augment the latest SBOM for a given architecture on a given directory
@KONDUKTO_REPO=$(KONDUKTO_REPO) KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) \
./scripts/augment-sbom.sh $(SBOM_JSON_FILE) tmp
.PHONY: store-augmented-sboms
store-augmented-sboms: ## Augment & Store the latest SBOM for a given version & architecture
KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) ./scripts/store-sbom-in-s3.sh $(VERSION) $(TARGET_ARCH) $(SBOMS_DIR)
.PHONY: install-ako-helm
install-ako-helm:
helm repo add mongodb $(HELM_REPO_URL)
helm upgrade $(HELM_AKO_INSTALL_NAME) mongodb/mongodb-atlas-operator --atomic --install \
--set-string atlasURI=$(MCLI_OPS_MANAGER_URL) \
--set objectDeletionProtection=false \
--set subobjectDeletionProtection=false \
--namespace=$(HELM_AKO_NAMESPACE) --create-namespace
kubectl get crds
tools/githubjobs/githubjobs: tools/githubjobs/*.go
cd tools/githubjobs && go build .
tools/scandeprecation/scandeprecation: tools/scandeprecation/*.go
cd tools/scandeprecation && go test . && go build .
.PHONY: slack-deprecations
slack-deprecations: tools/scandeprecation/scandeprecation tools/githubjobs/githubjobs
@echo "Computing and sending deprecation report to Slack..."
GH_RUN_ID=$(GH_RUN_ID) ./tools/githubjobs/githubjobs | grep "javaMethod" | ./tools/scandeprecation/scandeprecations | ./scripts/slackit.sh $(SLACK_WEBHOOK)
.PHONY: bump-version-file
bump-version-file:
@echo "Bumping version in $(VERSION_FILE)..."
jq '(.next | split(".") | map(tonumber) | .[1] += 1 | .[2] = 0 | map(tostring) | join(".")) as $$new_next | .current = .next | .next = $$new_next' $(VERSION_FILE) > $(VERSION_FILE).tmp && mv $(VERSION_FILE).tmp $(VERSION_FILE)
@echo "Version updated successfully:"
@cat $(VERSION_FILE)
.PHONY: api-docs
api-docs: manifests
go tool -modfile=tools/toolbox/go.mod crdoc --resources config/crd/bases --output docs/api-docs.md
.PHONY: validate-api-docs
validate-api-docs: api-docs
$(MAKE) check-missing-files