secrets-manager/makefiles/VSecMHelp.mk at main · vmware/secrets-manager · GitHub

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
# /*
# |    Protect your secrets, protect your sensitive data.
# :    Explore VMware Secrets Manager docs at https://vsecm.com/
# </
# <>/  keep your secrets... secret
# >/
# <>/' Copyright 2023-present VMware Secrets Manager contributors.
# >/'  SPDX-License-Identifier: BSD-2-Clause
# */

help:
	@echo "--------------------------------------------------------------------"
	@echo "          🛡️ VMware Secrets Manager: Keep your secrets... secret."
	@echo "          🛡️ https://vsecm.com/"
	@echo "--------------------------------------------------------------------"
	@echo "        ℹ️ This Makefile assumes you use Minikube and Docker"
	@echo "        ℹ️ for most operations."
	@echo "--------------------------------------------------------------------"
	@echo "If you are on the build server, stop the cronjob first: \`crontab -e\`"
	@echo "Or \`sudo service cron stop\`"
	@echo "--------------------------------------------------------------------"

	@if [ "`uname`" = "Darwin" ]; then \
		if type docker > /dev/null 2>&1; then \
			echo "  Using Docker for Mac?"; \
			echo "        ➡ 'make mac-tunnel' to proxy to the internal registry."; \
		else \
			echo "  Docker is not installed on this Mac."; \
		fi; \
	fi

	@echo ""

	@if [ -z "$(DOCKER_HOST)" -o -z "$(MINIKUBE_ACTIVE_DOCKERD)" ]; then \
		echo "  Using Minikube? If DOCKER_HOST and MINIKUBE_ACTIVE_DOCKERD are"; \
		echo '  not set, then run: eval $$(minikube -p minikube docker-env)'; \
		echo "        ➡ \$$DOCKER_HOST            : ${DOCKER_HOST}"; \
		echo "        ➡ \$$MINIKUBE_ACTIVE_DOCKERD: ${MINIKUBE_ACTIVE_DOCKERD}"; \
	else \
	    echo "  Make sure DOCKER_HOST and MINIKUBE_ACTIVE_DOCKERD are current:"; \
		echo '          eval $$(minikube -p minikube docker-env)'; \
	    echo "          (they may change if you reinstall Minikube)"; \
		echo "        ➡ \$$DOCKER_HOST            : ${DOCKER_HOST}"; \
		echo "        ➡ \$$MINIKUBE_ACTIVE_DOCKERD: ${MINIKUBE_ACTIVE_DOCKERD}"; \
	fi

	@echo "--------------------------------------------------------------------"
	@echo "  Prep/Cleanup:"
	@echo "          ˃ make k8s-delete;make k8s-start;"
	@echo "          ˃ make clean;"
	@echo "   ⦿ Optional Minikube Settings:"
	@echo "          > make k8s-start CPU=4 MEMORY=4096 NODES=1"
	@echo "          or"
	@echo "          > make k8s-start VSECM_MINIKUBE_CPU_COUNT=4 "
	@echo "              VSECM_MINIKUBE_MEMORY=4096 VSECM_MINIKUBE_CPU_COUNT=1"
	@echo "   ⦿ Generate Proto files:"
	@if [ $$(command -v protoc-gen-go >/dev/null 2>&1; echo $$?) -eq 0 ] && [ $$(command -v protoc-gen-go-grpc >/dev/null 2>&1; echo $$?) -eq 0 ]; then \
		echo "          ˃ make generate-proto-files"; \
	else \
		echo "          ˃ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest"; \
		echo "          ˃ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest"; \
		echo "          ˃ make generate-proto-files"; \
	fi
	@echo "--------------------------------------------------------------------"
	@echo "  Installation:"
	@echo "    ⦿ Distroless images:"
	@echo "          ˃ make deploy;make test;"
	@echo "    ⦿ Distroless FIPS images:"
	@echo "          ˃ make deploy-fips;make test;"
	@echo "--------------------------------------------------------------------"
	@echo "  Example Use Cases:"
	@echo "    Using local images:"
	@echo "          ˃ make example-sidecar-deploy-local;"
	@echo "          ˃ make example-sdk-deploy-local;"
	@echo "          ˃ make example-multiple-secrets-deploy-local;"
	@echo "    Using remote images:"
	@echo "          ˃ make example-sidecar-deploy;"
	@echo "          ˃ make example-sdk-deploy;"
	@echo "          ˃ make example-multiple-secrets-deploy;"

h:
	@echo "➡ 'make mac-tunnel'";
	@echo "˃ make k8s-delete;make k8s-start;"
	@echo '⦿ eval $$(minikube -p minikube docker-env)';
	@echo "˃ make clean;"
	@if [ $$(command -v protoc-gen-go >/dev/null 2>&1; echo $$?) -eq 0 ] && \
		[ $$(command -v protoc-gen-go-grpc >/dev/null 2>&1; echo $$?) -eq 0 ]; then \
		echo "˃ make generate-proto-files"; \
	else \
		echo "˃ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest"; \
		echo "˃ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest"; \
		echo "˃ make generate-proto-files"; \
	fi
	@echo "˃ make build-local; make clean; make deploy-local; make test-local;"
	@echo "˃ make build      ; make clean; make deploy      ; make test;"
	@echo "˃ make tag;"
	@echo "--------------------------------------------------------------------"
	@echo "If you are on the build server, stop the cronjob first: \`crontab -e\`"
	@echo "Or \`sudo service cron stop\`"
	@echo "--------------------------------------------------------------------"
	@echo "˃ make build-local;make deploy-local;make test-local;"
	@echo "˃ make build-local;make deploy-fips-local;make test-local;"
	@echo "--------------------------------------------------------------------"
	@echo "Building and Remote Testing:"
	@echo "    > Make sure you 'export DOCKER_CONTENT_TRUST=1' first."
	@echo "    > --"
	@echo "    > make build;make deployABC; make test"
	@echo "    > (where ABC is one of: '-fips', '')"
	@echo "Tagging:"
	@echo "    ˃ make tag;"
	@echo "--------------------------------------------------------------------"