Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
274 lines (227 loc) · 10.3 KB
/
Copy pathMakefile
File metadata and controls
274 lines (227 loc) · 10.3 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
.DEFAULT_GOAL := help
SERVICE ?=
MINIKUBE_PROFILE ?= minikube
PMON_HELM_RELEASE ?= pmon
PMON_NAMESPACE ?= pmon-local
PMON_CHART := kubernetes/chart/pmon
SCRIPTS_DIR := scripts
GCLOUD_PROJECT ?= perpmon
GCLOUD_REGION ?= us-central1
GCLOUD_ZONE ?= us-central1-a
GCLOUD_CLUSTER ?= pmon-cluster
GCLOUD_NAMESPACE ?= pmon-prod
K8S_NAMESPACE ?= $(GCLOUD_NAMESPACE)
SHARD ?= prices
LB_HOST ?= api.perps.gmbh
LOG_LIMIT ?= 50
LOG_FRESHNESS ?= 5m
KAFKA_SECRET_NAME ?= kafka-credentials
REDIS_SECRET_NAME ?= redis-credentials
CONFIGMAP_NAME ?= pmon-ingest-manifest
INGEST_MANIFEST_PATH ?= kubernetes/chart/pmon/files/manifest.yaml
RELEASE_VERSION ?= $(shell cat VERSION 2>/dev/null || git rev-parse --short HEAD)
IMAGE_TAG ?= $(RELEASE_VERSION)
IMAGE_REGISTRY ?= gcr.io/$(GCLOUD_PROJECT)/pmon
KAFKA_USERNAME ?=
KAFKA_PASSWORD ?=
REDIS_URL ?=
HELM_VALUES ?= kubernetes/chart/pmon/values-prod.yaml
HELM_ARGS ?=
GKE_HELM_RELEASE ?= pmon
UI_DOMAIN ?=
API_DOMAIN ?=
UI_IP_NAME ?= pmon-ui-ip
GATEWAY_IP_NAME ?= pmon-gateway-ip
UI_CERT_NAME ?= pmon-ui-cert
GATEWAY_CERT_NAME ?= pmon-gateway-cert
export DOCKER_BUILDKIT ?= 1
export COMPOSE_DOCKER_CLI_BUILD ?= 1
export BUILDKIT_PROGRESS ?= plain
.PHONY: help bootstrap dev build clean lint format smoke docker-build docker-up \
docker-down docker-logs docker-ps docker-restart docker-dev-up \
docker-dev-up-detached docker-dev-down docker-dev-watch minikube-build \
minikube-deploy minikube-port-forward minikube-destroy minikube-status \
minikube-stop \
gcloud-bootstrap gcloud-get-credentials gcloud-configure-docker \
gcloud-push-images gke-prepare-resources gke-deploy set-version release \
cut-release \
gcloud-reserve-addresses gke-managed-certificates gcloud-seed-secrets \
terraform-init terraform-plan terraform-apply terraform-destroy \
logs-gateway logs-ingestor logs-gclb
help: ## Display this help message with the most common targets.
@echo "Usage: make [target]" && echo && \
grep -E '^[a-zA-Z0-9_.-]+:.*?##' $(MAKEFILE_LIST) | sort | \
awk 'BEGIN {FS = ":.*?##"} {printf " %-26s %s\n", $$1, $$2}'
bootstrap: ## Install workspace dependencies via yarn workspaces.
yarn bootstrap
dev: ## Start all services locally with hot reload via yarn workspaces.
yarn dev
build: ## Build all workspaces (services + UI).
yarn build
clean: ## Run each workspace clean script (if available).
yarn clean
lint: ## Run the monorepo lint checks.
yarn lint
format: ## Check formatting across the repo.
yarn format
smoke: ## Execute the repository smoke tests (set SERVICE=gateway for gateway-specific checks).
@if [ "$(SERVICE)" = "gateway" ]; then \
yarn workspace @pmon/gateway smoke; \
elif [ -n "$(SERVICE)" ]; then \
echo "Unknown SERVICE=$(SERVICE) for smoke target" && exit 1; \
else \
yarn smoke; \
fi
docker-build: ## Build Docker images defined in docker-compose.yml (optionally set SERVICE=<name>).
docker compose build $(SERVICE)
docker-up: ## Start the Docker Compose stack in the background (optionally set SERVICE=<name>).
docker compose up --build -d $(SERVICE)
docker-down: ## Stop the Docker Compose stack and remove containers.
docker compose down --remove-orphans
docker-logs: ## Tail logs from the Docker Compose stack (optionally set SERVICE=<name>).
docker compose logs -f $(SERVICE)
docker-ps: ## Show status for Docker Compose services.
docker compose ps
docker-restart: ## Restart services managed by Docker Compose (optionally set SERVICE=<name>).
docker compose restart $(SERVICE)
docker-dev-up: ## Start the dev-friendly Docker Compose stack with hot reload (requires Docker Compose v2.22+).
docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build --watch $(SERVICE)
docker-dev-up-detached: ## Start the dev stack in the background (for use with docker-dev-watch).
docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build -d $(SERVICE)
docker-dev-down: ## Stop the dev stack and remove containers.
docker compose -f docker-compose.yml -f docker-compose.dev.yml down --remove-orphans
docker-dev-watch: ## Sync source changes into the running dev containers (run alongside docker-dev-up-detached).
docker compose -f docker-compose.yml -f docker-compose.dev.yml watch
minikube-build: ## Build local Docker images inside the Minikube registry.
MINIKUBE_PROFILE=$(MINIKUBE_PROFILE) $(SCRIPTS_DIR)/k8s/build-images.sh
minikube-deploy: ## Deploy the stack to Minikube using Helm.
MINIKUBE_PROFILE=$(MINIKUBE_PROFILE) PMON_HELM_RELEASE=$(PMON_HELM_RELEASE) \
PMON_NAMESPACE=$(PMON_NAMESPACE) PMON_CHART_DIR=$(PMON_CHART) \
$(SCRIPTS_DIR)/k8s/deploy.sh $(ARGS)
minikube-port-forward: ## Forward UI (5173) and gateway (4000) services from Minikube.
PMON_NAMESPACE=$(PMON_NAMESPACE) $(SCRIPTS_DIR)/k8s/port-forward.sh
minikube-destroy: ## Remove the Minikube Helm release.
PMON_HELM_RELEASE=$(PMON_HELM_RELEASE) PMON_NAMESPACE=$(PMON_NAMESPACE) \
$(SCRIPTS_DIR)/k8s/destroy.sh
minikube-status: ## Show the current workload status inside the Minikube namespace.
kubectl -n $(PMON_NAMESPACE) get pods
minikube-stop: ## Stop the Minikube profile without deleting it.
minikube stop -p $(MINIKUBE_PROFILE)
gcloud-bootstrap: ## Configure gcloud defaults for the pmon project.
GCLOUD_PROJECT=$(GCLOUD_PROJECT) \
GCLOUD_REGION=$(GCLOUD_REGION) \
GCLOUD_ZONE=$(GCLOUD_ZONE) \
$(SCRIPTS_DIR)/gcloud/bootstrap.sh
gcloud-get-credentials: ## Download kubeconfig credentials for the target GKE cluster.
GCLOUD_PROJECT=$(GCLOUD_PROJECT) \
GCLOUD_REGION=$(GCLOUD_REGION) \
GCLOUD_CLUSTER=$(GCLOUD_CLUSTER) \
$(SCRIPTS_DIR)/gcloud/get-credentials.sh
gcloud-configure-docker: ## Configure Docker to push to gcr.io using gcloud auth.
CLOUDSDK_PYTHON=/opt/homebrew/opt/python@3.12/bin/python3.12 \
gcloud auth configure-docker gcr.io
gcloud-push-images: ## Build and push service images to gcr.io/perpmon (override IMAGE_TAG=<tag>).
GCLOUD_PROJECT=$(GCLOUD_PROJECT) \
IMAGE_TAG=$(IMAGE_TAG) \
$(SCRIPTS_DIR)/gcloud/push-images.sh
gke-prepare-resources: ## Create namespace, secrets, and manifest configmap on the target cluster.
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
KAFKA_SECRET_NAME=$(KAFKA_SECRET_NAME) \
KAFKA_USERNAME=$(KAFKA_USERNAME) \
KAFKA_PASSWORD=$(KAFKA_PASSWORD) \
REDIS_SECRET_NAME=$(REDIS_SECRET_NAME) \
REDIS_URL=$(REDIS_URL) \
CONFIGMAP_NAME=$(CONFIGMAP_NAME) \
INGEST_MANIFEST_PATH=$(INGEST_MANIFEST_PATH) \
$(SCRIPTS_DIR)/gcloud/prepare-resources.sh
gcloud-reserve-addresses: ## Reserve (or describe) global static IPs for UI/Gateway load balancers.
GCLOUD_PROJECT=$(GCLOUD_PROJECT) \
UI_IP_NAME=$(UI_IP_NAME) \
GATEWAY_IP_NAME=$(GATEWAY_IP_NAME) \
$(SCRIPTS_DIR)/gcloud/reserve-addresses.sh
gke-managed-certificates: ## Apply GKE ManagedCertificates for HTTPS (requires domains).
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
UI_CERT_NAME=$(UI_CERT_NAME) \
GATEWAY_CERT_NAME=$(GATEWAY_CERT_NAME) \
UI_DOMAIN=$(UI_DOMAIN) \
API_DOMAIN=$(API_DOMAIN) \
$(SCRIPTS_DIR)/gcloud/apply-managed-certificates.sh
gcloud-seed-secrets: ## Seed Google Secret Manager secrets with internal defaults.
GCLOUD_PROJECT=$(GCLOUD_PROJECT) \
PMON_NAMESPACE=$(GCLOUD_NAMESPACE) \
$(SCRIPTS_DIR)/gcloud/seed-secrets.sh
terraform-init: ## Initialise Terraform backend/providers under infra/
cd infra && terraform init
terraform-plan: ## Show Terraform plan for the infra/ stack
cd infra && terraform plan
terraform-apply: ## Apply Terraform configuration for infra/
cd infra && terraform apply
terraform-destroy: ## Destroy Terraform managed resources in infra/
cd infra && terraform destroy
gke-deploy: ## Deploy the Helm release to GKE using the current IMAGE_TAG.
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
HELM_RELEASE=$(GKE_HELM_RELEASE) \
HELM_VALUES=$(HELM_VALUES) \
IMAGE_TAG=$(IMAGE_TAG) \
IMAGE_REGISTRY=$(IMAGE_REGISTRY) \
HELM_ARGS=$(HELM_ARGS) \
PMON_CHART_DIR=$(PMON_CHART) \
$(SCRIPTS_DIR)/gcloud/deploy-helm.sh
set-version: ## Update VERSION and all workspace package versions (VERSION=x.y.z)
@if [ -z "$(VERSION)" ]; then \
echo "Usage: make set-version VERSION=x.y.z" && exit 1; \
fi
node $(SCRIPTS_DIR)/release/set-version.js $(VERSION)
release: ## Build, push, seed resources, and deploy to the target GKE environment.
$(MAKE) gcloud-push-images GCLOUD_PROJECT=$(GCLOUD_PROJECT) IMAGE_TAG=$(IMAGE_TAG) IMAGE_REGISTRY=$(IMAGE_REGISTRY)
$(MAKE) gke-prepare-resources \
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
KAFKA_SECRET_NAME=$(KAFKA_SECRET_NAME) \
KAFKA_USERNAME="$(KAFKA_USERNAME)" \
KAFKA_PASSWORD="$(KAFKA_PASSWORD)" \
REDIS_SECRET_NAME=$(REDIS_SECRET_NAME) \
REDIS_URL="$(REDIS_URL)" \
CONFIGMAP_NAME=$(CONFIGMAP_NAME) \
INGEST_MANIFEST_PATH=$(INGEST_MANIFEST_PATH)
$(MAKE) gke-managed-certificates \
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
UI_CERT_NAME=$(UI_CERT_NAME) \
GATEWAY_CERT_NAME=$(GATEWAY_CERT_NAME) \
UI_DOMAIN="$(UI_DOMAIN)" \
API_DOMAIN="$(API_DOMAIN)"
$(MAKE) gke-deploy \
GCLOUD_NAMESPACE=$(GCLOUD_NAMESPACE) \
HELM_RELEASE=$(GKE_HELM_RELEASE) \
HELM_VALUES=$(HELM_VALUES) \
IMAGE_TAG=$(IMAGE_TAG) \
IMAGE_REGISTRY=$(IMAGE_REGISTRY) \
HELM_ARGS="$(HELM_ARGS)"
cut-release: ## Bump version, commit, tag, and push (requires clean main); usage: make cut-release VERSION=x.y.z
@if [ -z "$(VERSION)" ]; then \
echo "Usage: make cut-release VERSION=x.y.z"; \
exit 1; \
fi
@if [ "$$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then \
echo "[cut-release] Please switch to the main branch before cutting a release"; \
exit 1; \
fi
@if [ -n "$$(git status --porcelain)" ]; then \
echo "[cut-release] Working tree is dirty. Commit or stash changes first."; \
exit 1; \
fi
$(MAKE) set-version VERSION=$(VERSION)
git add -A
git commit -m "chore: release v$(VERSION)"
git tag -a "v$(VERSION)" -m "Release v$(VERSION)"
git push origin HEAD
git push origin "v$(VERSION)"
logs-gateway: ## Tail logs for the gateway deployment (override K8S_NAMESPACE).
kubectl -n $(K8S_NAMESPACE) logs -f -l app.kubernetes.io/component=gateway
logs-ingestor: ## Tail logs for an ingestor shard (set SHARD=<name>, default=prices).
kubectl -n $(K8S_NAMESPACE) logs -f -l app.kubernetes.io/component=ingestor,pmon.dev/shard=$(SHARD)
logs-gclb: ## Read recent Cloud Load Balancer requests for a host (set LB_HOST=<host>).
gcloud logging read 'resource.type="http_load_balancer" AND jsonPayload.requestHost="$(LB_HOST)"' \
--project $(GCLOUD_PROJECT) \
--limit $(LOG_LIMIT) \
--freshness $(LOG_FRESHNESS) \
--format json