-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathMakefile
354 lines (273 loc) · 12.1 KB
/
Makefile
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
.PHONY: setup test clean registry venv
# docker tag of images
TAG ?= 2.35.0
DOCKER_REGISTRY ?= ghcr.io
DOCKER_REGISTRY_NAMESPACE ?= theracetrack/racetrack
GHCR_PREFIX = ghcr.io/theracetrack/racetrack
DOCKER_GID=$(shell (getent group docker || echo 'docker:x:0') | cut -d: -f3 )
docker-compose = COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 DOCKER_SCAN_SUGGEST=false DOCKER_GID=${DOCKER_GID} \
docker compose
docker = DOCKER_BUILDKIT=1 docker
# function: docker_tag_and_push,<src_image>,<target_image>
define docker_tag_and_push
docker tag $(1) $(2)
docker push $(2)
endef
-include .local.env
setup:
uv venv venv &&\
. venv/bin/activate &&\
pip install --upgrade pip setuptools &&\
pip install -r requirements-test.txt -r requirements-dev.txt &&\
( cd racetrack_client && make setup ) &&\
( cd racetrack_commons && make setup ) &&\
( cd lifecycle && make setup ) &&\
( cd image_builder && make setup ) &&\
( cd dashboard && make setup )
@echo Activate your venv:
@echo . venv/bin/activate
venv:
uv venv venv &&\
. venv/bin/activate &&\
uv pip install -r requirements-test.txt -r requirements-dev.txt \
-r racetrack_client/requirements.txt \
-r racetrack_commons/requirements.txt \
-r lifecycle/requirements.txt \
-r image_builder/requirements.txt \
-r dashboard/requirements.txt \
-e racetrack_client@racetrack_client \
-e racetrack_commons@racetrack_commons \
-e lifecycle@lifecycle \
-e image_builder@image_builder \
-e dashboard@dashboard
@echo Activate your venv:
@echo . venv/bin/activate
setup-racetrack-client:
python3 -m venv venv &&\
. venv/bin/activate &&\
pip install --upgrade pip setuptools &&\
( cd racetrack_client && make setup )
setup-test-unit:
uv venv venv &&\
. venv/bin/activate &&\
uv pip install -r requirements-test.txt \
-r racetrack_client/requirements.txt -e racetrack_client@racetrack_client \
-r racetrack_commons/requirements.txt -e racetrack_commons@racetrack_commons \
-r lifecycle/requirements.txt -e lifecycle@lifecycle \
-r image_builder/requirements.txt -e image_builder@image_builder \
-r dashboard/requirements.txt -e dashboard@dashboard
@echo Activate your venv: . venv/bin/activate
setup-test-e2e:
python3 -m venv venv &&\
. venv/bin/activate &&\
pip install -r tests/e2e/requirements.txt &&\
( cd racetrack_client && make setup ) &&\
( cd racetrack_commons && make setup )
@echo Activate your venv: . venv/bin/activate
install-racetrack-client:
( cd racetrack_client && pip install -e . )
lint:
-python -m mypy --ignore-missing-imports --exclude 'racetrack_client/build' racetrack_client
-python -m mypy --ignore-missing-imports racetrack_commons
-python -m mypy --ignore-missing-imports --exclude 'lifecycle/lifecycle/django/registry/migrations' lifecycle
-python -m mypy --ignore-missing-imports image_builder
-python -m mypy --ignore-missing-imports dashboard
-python -m flake8 --ignore E501 --per-file-ignores="__init__.py:F401" \
lifecycle image_builder dashboard
-python -m pylint --disable=R,C,W \
lifecycle/lifecycle image_builder/image_builder dashboard/dashboard
format:
python -m black -S --diff --color -l 120 \
racetrack_client racetrack_commons lifecycle image_builder dashboard
format-apply:
python -m black -S -l 120 \
racetrack_client racetrack_commons lifecycle image_builder dashboard
test: compose-test
test-unit: test-racetrack-client test-lifecycle test-image-builder test-dashboard test-pub test-utils
test-racetrack-client:
cd racetrack_client && make test
test-lifecycle:
cd lifecycle && make test
test-image-builder:
cd image_builder && make test
test-dashboard:
cd dashboard && make test
test-pub:
cd pub && make test
test-pub-1: # Run single unit test of Pub
cd pub && go test -v -run $(test) .
test-utils:
cd utils && python -m pytest -v --tb=short -ra
test-unit-coverage:
(cd racetrack_client &&\
python -m coverage run --omit 'tests/**/*.py' -m pytest -vv --tb=short -ra --color=yes)
(cd lifecycle/tests &&\
SECRET_KEY=dev AUTH_KEY=dev DJANGO_SETTINGS_MODULE="lifecycle.django.app.settings" \
DB_TYPE=sqlite-memory DB_PATH=../lifecycle/django/db.sqlite3 \
python -m coverage run --omit '../tests/**/*.py' -m pytest -vv --tb=short -ra --color=yes)
(cd image_builder &&\
python -m coverage run --omit 'tests/**/*.py' -m pytest -vv --tb=short -ra --color=yes)
(cd dashboard &&\
python -m coverage run --omit 'tests/**/*.py' -m pytest -vv --tb=short -ra --color=yes)
@echo "--- Combined Python coverage report:"
python -m coverage combine --keep racetrack_client/.coverage lifecycle/tests/.coverage image_builder/.coverage dashboard/.coverage &&\
python -m coverage report --show-missing --skip-empty --skip-covered
(cd pub &&\
go test -p 1 -coverprofile coverage.out . &&\
go tool cover -func=coverage.out)
test-e2e: compose-test-e2e
kind-test-e2e:
( cd tests/e2e && pytest -vv --tb=short -ra -s )
kind-test-e2e-auth:
( cd tests/e2e && TEST_SUITE=auth pytest -vv --tb=short -ra -s )
localhost-test-e2e-auth:
( cd tests/e2e && TEST_ENV=localhost TEST_SUITE=auth pytest -vv --tb=short -ra -s )
compose-test-e2e:
( cd tests/e2e && TEST_ENV=docker pytest -vv --tb=short -ra -s $(test))
compose-test-e2e-auth:
( cd tests/e2e && TEST_ENV=docker TEST_SUITE=auth pytest -vv --tb=short -ra -s )
compose-test-e2e-full:
( cd tests/e2e && TEST_ENV=docker TEST_SUITE=full pytest -vv --tb=short -ra -s )
compose-test: test-unit compose-test-e2e
kind-test: test-unit kind-test-e2e
up: compose-up
down: compose-down
compose-run: registry docker-build compose-volumes
$(docker-compose) up
compose-run-dev: registry docker-build compose-volumes
$(docker-compose) --profile dev up
compose-run-stress: registry docker-build docker-build-stress
$(docker-compose) -f docker-compose.yaml -f tests/stress/docker-compose.stress.yaml up
compose-up: registry docker-build compose-volumes
$(docker-compose) up -d
compose-up-dev: registry docker-build compose-volumes
$(docker-compose) --profile dev up -d
compose-up-service: compose-volumes
$(docker-compose) build \
--build-arg GIT_VERSION="`git describe --long --tags --dirty --always`" \
--build-arg DOCKER_TAG="$(TAG)" \
$(service)
$(docker-compose) up -d $(service)
compose-restart-service: compose-down-service compose-up-service
compose-down-service:
$(docker-compose) down $(service)
up-pub:
$(docker-compose) build \
--build-arg GIT_VERSION="`git describe --long --tags --dirty --always`" \
--build-arg DOCKER_TAG="$(TAG)" \
pub
$(docker-compose) up -d pub
# Start containers from pulled images (without building)
compose-up-pull: registry compose-volumes
$(docker-compose) up -d --no-build --pull=always
compose-up-docker-daemon: registry docker-build compose-volumes
$(docker-compose) -f docker-compose.yaml \
-f ./utils/docker-daemon/docker-compose.docker-daemon.yaml \
--project-directory . \
up -d
compose-volumes:
mkdir -p .plugins && chmod ugo+rw .plugins
mkdir -p .plugins/metrics && chmod ugo+rw .plugins/metrics
compose-down: docker-clean-job
$(docker-compose) --profile dev down
rm -rf .plugins
compose-deploy-sample:
LIFECYCLE_URL=http://127.0.0.1:7102 ./utils/wait-for-lifecycle.sh
racetrack deploy sample/python-class/ --remote http://127.0.0.1:7102 --force
compose-logs:
$(docker-compose) logs lifecycle lifecycle-supervisor image-builder dashboard pub -f
docker-build:
$(docker-compose) build \
--build-arg GIT_VERSION="`git describe --long --tags --dirty --always`" \
--build-arg DOCKER_TAG="$(TAG)"
docker-build-stress:
$(docker-compose) -f tests/stress/docker-compose.stress.yaml build
docker-push-private: docker-build
docker login ${DOCKER_REGISTRY}
docker buildx build -t ${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/lifecycle:${TAG} -f lifecycle/private.Dockerfile lifecycle
docker push ${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/lifecycle:${TAG}
$(call docker_tag_and_push,${GHCR_PREFIX}/image-builder:latest,${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/image-builder:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/dashboard:latest,${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/dashboard:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/pub:latest,${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/pub:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/pgbouncer:latest,${DOCKER_REGISTRY}/${DOCKER_REGISTRY_NAMESPACE}/pgbouncer:${TAG})
docker-push-public: docker-build
docker login ghcr.io
docker push ${GHCR_PREFIX}/lifecycle:latest
docker push ${GHCR_PREFIX}/image-builder:latest
docker push ${GHCR_PREFIX}/dashboard:latest
docker push ${GHCR_PREFIX}/pub:latest
docker push ${GHCR_PREFIX}/pgbouncer:latest
$(call docker_tag_and_push,${GHCR_PREFIX}/lifecycle:latest,${GHCR_PREFIX}/lifecycle:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/image-builder:latest,${GHCR_PREFIX}/image-builder:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/dashboard:latest,${GHCR_PREFIX}/dashboard:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/pub:latest,${GHCR_PREFIX}/pub:${TAG})
$(call docker_tag_and_push,${GHCR_PREFIX}/pgbouncer:latest,${GHCR_PREFIX}/pgbouncer:${TAG})
local-registry-push: docker-build
$(call docker_tag_and_push,${GHCR_PREFIX}/lifecycle:latest,127.0.0.1:5000/racetrack/lifecycle:latest)
$(call docker_tag_and_push,${GHCR_PREFIX}/image-builder:latest,127.0.0.1:5000/racetrack/image-builder:latest)
$(call docker_tag_and_push,${GHCR_PREFIX}/dashboard:latest,127.0.0.1:5000/racetrack/dashboard:latest)
$(call docker_tag_and_push,${GHCR_PREFIX}/pub:latest,127.0.0.1:5000/racetrack/pub:latest)
$(call docker_tag_and_push,${GHCR_PREFIX}/pgbouncer:latest,127.0.0.1:5000/racetrack/pgbouncer:latest)
docker-clean-job:
./utils/cleanup-jobs-docker.sh
registry:
./utils/setup-registry.sh
registry-down:
docker rm -f racetrack-registry || true
kind-cluster-up: registry
kind create cluster --name racetrack --config utils/kind-config.yaml || true
kind get clusters | grep -q 'racetrack' # make sure cluster exists
kubectl config use-context kind-racetrack
kubectl config set-context --current --namespace=racetrack
kubectl cluster-info --context kind-racetrack
# Enable service monitors in a cluster
kubectl apply -f utils/servicemonitors.yaml
kind-deploy:
kubectl apply -k kustomize/kind/ --context kind-racetrack
kind-up: kind-cluster-up local-registry-push kind-deploy
# Destroy kind cluster completely
kind-down:
kind delete cluster --name racetrack
kind-redeploy: local-registry-push kind-deploy kind-delete-pods
kind-redeploy-force: kind-clear local-registry-push kind-clear-await kind-deploy
kind-restart: kind-down kind-up kind-delete-pods
# Clean all deployed resources from a kind, leaving empty kind cluster running
kind-clear:
kubectl delete --wait=false --ignore-not-found=true -k kustomize/kind/ --context kind-racetrack
kind-clear-await:
kubectl delete --wait=true --ignore-not-found=true -k kustomize/kind/ --context kind-racetrack
# Delete all pods (to redeploy new image versions)
kind-delete-pods:
kubectl delete --wait=false --ignore-not-found=true pods -l app=racetrack
kind-logs:
kubectl logs -l 'app in (racetrack)' --all-containers --prefix=true --tail=200 -f --max-log-requests 10
clean: compose-down kind-down registry-down
MR ?= 0
version-bump:
./utils/version_bumper.py --mr $(MR)
version-bump-minor:
./utils/version_bumper.py --part=minor
version-bump-major:
./utils/version_bumper.py --part=major
version-bump-exact:
./utils/version_bumper.py --exact=$(VERSION)
# show current version
version-current:
./utils/version_bumper.py --current
# First line is needed to reload newest TAG value
version-release-private: TAG = $(shell ./utils/version_bumper.py --current)
version-release-private: docker-push-private
@echo "Racetrack version $(TAG) is released to registry ${DOCKER_REGISTRY}"
version-release-public: TAG = $(shell ./utils/version_bumper.py --current)
version-release-public: docker-push-public
@echo "Racetrack version $(TAG) is released to registry ghcr.io"
template-local-env:
cp -n utils/.local.env.template .local.env
@echo "Now fill in the .local.env file with your local settings"
mkdocs-local:
mkdocs serve
mkdocs-push:
mkdocs gh-deploy --force --clean --verbose
install-plugins:
racetrack plugin install github.com/TheRacetrack/plugin-docker-infrastructure
racetrack plugin install github.com/TheRacetrack/plugin-python-job-type