This repository has been archived by the owner on Dec 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 80
/
Makefile
646 lines (534 loc) · 22.9 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
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
#
# Makefile for developing using Docker
#
.DEFAULT_GOAL := help
# This variable is used in a few places, most notably
# docker-bake.hcl. You can read more about it there, but the TL;DR is
# that you'll need to set this to a proper version (not "", "latest",
# or "dev") in order to generate release builds of our services to use
# in a production deployment. Defaulting to `dev` is fine for
# day-to-day development and local testing, though (and in fact is
# required for our local usage of Nomad, because Nomad won't resolve a
# `latest` tag from the host machine.)
IMAGE_TAG ?= dev
# This is a build argument for our Python images, and is thus used in
# docker-bake.hcl
PYTHON_VERSION ?= $(shell build-support/python_version.sh)
# This is a build argument for our Rust images, and is thus used in
# docker-bake.hcl
RUST_VERSION ?= $(shell build-support/rust_version.sh)
# Also influences Rust image build via docker-bake.hcl
RUST_BUILD ?= dev-local-grapl
# Also influences Rust image build via docker-bake.hcl
PROTOC_VERSION ?= $(shell build-support/protoc_version.sh)
UID = $(shell id --user)
GID = $(shell id --group)
PWD = $(shell pwd)
GRAPL_ROOT = ${PWD}
DIST_DIR = $(GRAPL_ROOT)/dist
COMPOSE_USER=${UID}:${GID}
COMPOSE_IGNORE_ORPHANS=1
COMPOSE_PROJECT_NAME ?= grapl
export
export EVERY_COMPOSE_FILE=--file docker-compose.yml
# This is used to send docker traces to Jaeger. This is primarily useful for debugging build time performance
ifdef WITH_TRACING
buildx_builder_args := --builder=grapl-tracing-builder
endif
# Helper macro to invoke buildx with standard arguments. Prefer this
# over invoking `docker buildx bake` directly.
DOCKER_BUILDX_BAKE := docker buildx bake $(buildx_builder_args)
COMPOSE_PROJECT_PYTHON_INTEGRATION_TESTS := python-integration-tests
COMPOSE_PROJECT_RUST_INTEGRATION_TESTS := rust-integration-tests
# All the services defined in the docker-compose.check.yml file are
# run with the same general arguments; just supply the service name to
# run.
#
# While we would ultimately like to run all these containers as a
# non-root user, some currently seem to require that; to accommodate
# all such images, we provide two helpful macros.
DOCKER_COMPOSE_CHECK := docker compose --file=docker-compose.check.yml run --rm
NONROOT_DOCKER_COMPOSE_CHECK := ${DOCKER_COMPOSE_CHECK} --user=${COMPOSE_USER}
# Our images are labeled; we can use this to help filter various
# Docker prune / rm / etc. commands to only touch our stuff.
#
# This is set in docker-bake.hcl
DOCKER_FILTER_LABEL := org.opencontainers.image.vendor="Grapl, Inc."
# This filter should differentiate between data volumes, such as those once used
# for DGraph (grapl-data-dgraph), and those used for caching builds
# (grapl-frontend-view-yarn).
#
# Multiple filter arguments can be supplied here.
#
# We may want to stick to a naming convention where data volume should just
# prefix their name to match the filter here, but that doesn't necessarily need
# to be a strict requirement.
DOCKER_DATA_VOLUME_FILTERS := --filter=name=grapl-data
# Run a Pants goal across all proto files
PANTS_PROTO_FILTER := ./pants --filter-target-type=protobuf_source
# Run a Pants goal across all Python files
PANTS_PYTHON_FILTER := ./pants --filter-target-type=python_source,python_test
# Run a Pants goal across all shell files
PANTS_SHELL_FILTER := ./pants --filter-target-type=shell_source,shunit2_test
# Helper macro for invoking a target from src/rust/Makefile
RUST_MAKE = $(MAKE) --directory=src/rust
# Helper macro for invoking a target from src/js/frontend/Makefile
FRONTEND_MAKE = $(MAKE) --directory=src/js/frontend
# Use a single shell for each of our targets, which allows us to use the 'trap'
# built-in in our targets. We set the 'errexit' shell option to preserve
# execution behavior, where failure from one line in a target will result in
# Make error.
# https://www.gnu.org/software/make/manual/html_node/One-Shell.html
SHELL := bash
.ONESHELL:
# errexit nounset noclobber
.SHELLFLAGS := \
-e \
-u \
-o pipefail \
-c
FMT_BLUE = \033[36m
FMT_PURPLE = \033[35m
FMT_BOLD = \033[1m
FMT_END = \033[0m
VSC_DEBUGGER_DOCS_LINK = https://grapl.readthedocs.io/en/latest/debugging/vscode_debugger.html
.PHONY: help
help: ## Print this help
@printf -- '\n'
@printf -- ' __ \n'
@printf -- ' (≡) ____ _ _____ ____ _ ____ / / \n'
@printf -- ' \ / __ `// ___// __ `// __ \ / / \n'
@printf -- ' (≡) / /_/ // / / /_/ // /_/ // / \n'
@printf -- ' / \__, //_/ \__,_// .___//_/ \n'
@printf -- ' (≡) /____/ /_/ \n'
@printf -- '\n'
@printf -- '${FMT_BOLD}Useful environment variables (with examples):${FMT_END}\n'
@printf -- ' ${FMT_PURPLE}TARGETS${FMT_END}="typecheck-grapl-common" make typecheck\n'
@printf -- ' to only run a subset of test targets.\n'
@printf -- '\n'
@printf -- ' ${FMT_PURPLE}KEEP_TEST_ENV=1${FMT_END} make test-integration-rust\n'
@printf -- ' to keep the test environment around after a test suite.\n'
@printf -- '\n'
@printf -- ' ${FMT_PURPLE}WITH_PULUMI_TRACING=1${FMT_END} make up\n'
@printf -- ' to send pulumi traces to Jaeger (see docs/development/debugging.md).\n'
@printf -- '\n'
@printf -- ' ${FMT_PURPLE}WITH_TRACING=1${FMT_END} make build-local-infrastructure \n'
@printf -- ' to send docker build traces to Jaeger (see docs/development/debugging.md).\n'
@printf -- '\n'
@printf -- ' ${FMT_BOLD}FUN FACT${FMT_END}: You can also specify these as postfix, like:\n'
@printf -- ' make test-integration-rust KEEP_TEST_ENV=1\n'
@printf '\n'
@awk 'BEGIN {FS = ":.*##"; printf "Usage: make ${FMT_BLUE}<target>${FMT_END}\n"} \
/^[a-zA-Z0-9_-]+:.*?##/ { printf " ${FMT_BLUE}%-46s${FMT_END} %s\n", $$1, $$2 } \
/^##@/ { printf "\n${FMT_BOLD}%s${FMT_END}\n", substr($$0, 5) } ' \
$(MAKEFILE_LIST)
@printf '\n'
##@ Build 🔨
# Build Service Images and their Prerequisites
########################################################################
#
# Building of the various images we use for core Grapl SaaS services,
# our local-only images (e.g., pulumi, postgres), and any
# prerequisites they need (e.g., due to COPY directives in
# Dockerfiles) are defined here. The image builds are defined in
# docker-bake.hcl using groups. Similarly, the prerequisites that
# Pants knows how to build are defined using tags. The grapl-web-ui
# needs the compiled frontend assets in order for it to build.
.PHONY: build-service-pex-files
build-service-pex-files: ## Build all PEX files needed by Grapl SaaS services
@echo "--- Building Grapl service PEX files"
./pants --tag="service-pex" package ::
# We copy built Analyzers from dist/ into our Rust integration tests so we can deploy them.
.PHONY: build-test-fixture-pex-files
build-test-fixture-pex-files: ## Build all PEX files needed by integration tests, e.g. analyzers
@echo "--- Building Python test fixture PEX files"
./pants --tag="test-fixture-pex" package ::
.PHONY: build-frontend
build-frontend: ## Build website assets to include in grapl-web-ui
@echo "--- Building the frontend"
$(FRONTEND_MAKE) build-code
TARGET_FRONTEND_DIR="dist/frontend"
rm -rf "$${TARGET_FRONTEND_DIR}/*" # Clear out old artifacts
cp -r \
"src/js/frontend/build/." \
"$${TARGET_FRONTEND_DIR}"
.PHONY: build-grapl-service-prerequisites
build-grapl-service-prerequisites: ## Build all assets needed for the creation of Grapl SaaS service container images
# The Python services need the PEX files
build-grapl-service-prerequisites: build-service-pex-files
# The grapl-web-ui service needs website assets from frontend
build-grapl-service-prerequisites: build-frontend
# This is used in our CI pipeline; see build_and_upload_images.sh
#
# Also see the `push-to-cloudsmith` group in docker-bake.hcl; any
# prerequisites of images in that group should be built by this
# target!
.PHONY: build-image-prerequisites
build-image-prerequisites: ## Build all dependencies that must be copied into our images that we push to our registry
build-image-prerequisites: build-grapl-service-prerequisites
build-image-prerequisites: build-test-fixture-pex-files
.PHONY: build-local-infrastructure
build-local-infrastructure: build-grapl-service-prerequisites
@echo "--- Building the Grapl SaaS service images and local-only images"
$(DOCKER_BUILDX_BAKE) local-infrastructure
.PHONY: build-test-integration-rust
build-test-integration-rust: build-test-fixture-pex-files
@echo "--- Building rust integration test images"
$(DOCKER_BUILDX_BAKE) rust-integration-tests
.PHONY: build-test-integration-python
build-test-integration-python:
@echo "--- Building python integration test images"
$(DOCKER_BUILDX_BAKE) python-integration-tests
########################################################################
.PHONY: build-prettier-image
build-prettier-image:
$(DOCKER_BUILDX_BAKE) --file ./docker-compose.check.yml prettier
.PHONY: graplctl
graplctl: ## Build graplctl and install it to ./bin
./pants package ./src/python/graplctl/graplctl
cp ./dist/src.python.graplctl.graplctl/graplctl.pex ./bin/graplctl
printf -- '\n${FMT_BOLD}graplctl${FMT_END} written to ${FMT_BLUE}./bin/graplctl${FMT_END}\n'
.PHONY: dump-artifacts-local
dump-artifacts-local: ## Run the script that dumps Nomad/Docker logs after test runs
# Rarely needed, but you can temporarily append
# `--dump-connect-proxy-logs` to debug Consul Connect.
./pants dump-artifacts \
--compose-project="${COMPOSE_PROJECT_NAME}" \
--dump-agent-logs
##@ Test 🧪
# Unit Tests
########################################################################
.PHONY: test-unit
test-unit: test-unit-js
test-unit: test-unit-python
test-unit: test-unit-rust
# NOTE: Intentionally *NOT* adding `test-unit-rust-coverage`; see below
test-unit: test-unit-shell
test-unit: ## Build and run all unit tests
.PHONY: test-unit-js
test-unit-js: test-unit-frontend
test-unit-js: ## Build and run unit tests - JavaScript only
.PHONY: test-unit-frontend
test-unit-frontend: ## Test Frontend
$(FRONTEND_MAKE) run-tests
.PHONY: test-unit-python
# Long term, it would be nice to organize the tests with Pants
# tags, rather than pytest tags
# If you need to `pdb` these tests, add a `--debug` after `./pants test`
test-unit-python: ## Run Python unit tests under Pants
./pants --filter-target-type="python_test" \
--tag="-needs_work" \
test :: \
--pytest-args="-m \"not integration_test\""
.PHONY: test-unit-rust
test-unit-rust: ## Build and run unit tests - Rust only (not for CI)
# This does *NOT* gather coverage statistics; see
# test-unit-rust-coverage for that
$(RUST_MAKE) test
.PHONY: test-unit-shell
test-unit-shell: ## Run shunit2 tests under Pants
./pants filter --filter-target-type="shunit2_tests" :: \
| xargs ./pants test
########################################################################
# NOTE: This is a separate target intended for use in CI only because
# gathering coverage statistics with Tarpaulin takes a long time
# (*everything* must be recompiled, even if nothing changed) making it
# less-than-ideal for day-to-day developer usage.
#
# As such, it is intentionally *NOT* specified as a prerequisite for
# the `test-unit` target.
# Unfortunately, we must ensure that the `dist` directory is present
# for this to work.
test-unit-rust-coverage: | dist
test-unit-rust-coverage: ## Run Rust unit tests and gather coverage statistics (CI only)
$(RUST_MAKE) coverage
########################################################################
.PHONY: typecheck
typecheck: ## Typecheck Python Code
./pants check ::
.PHONY: test-integration-python
test-integration-python: build-local-infrastructure
test-integration-python: build-test-integration-python
test-integration-python: export COMPOSE_PROJECT_NAME := $(COMPOSE_PROJECT_PYTHON_INTEGRATION_TESTS)
test-integration-python: ## Build and run python integration tests
$(MAKE) test-with-env EXEC_TEST_COMMAND="nomad/bin/run_parameterized_job.sh python-integration-tests 9"
.PHONY: test-integration-rust
test-integration-rust: build-local-infrastructure
test-integration-rust: build-test-integration-rust
test-integration-rust: export COMPOSE_PROJECT_NAME := $(COMPOSE_PROJECT_RUST_INTEGRATION_TESTS)
test-integration-rust: ## Build and run rust integration tests
$(MAKE) test-with-env EXEC_TEST_COMMAND="nomad/bin/run_parameterized_job.sh rust-integration-tests 9"
# This target is not intended to be used directly from the command line.
# Think of it as a Context Manager that:
# - Before test-time, brings up a `make up`
# - After test-time, tears it all down and dumps artifacts.
.SILENT: test-with-env
.PHONY: test-with-env
test-with-env: # (Do not include help text - not to be used directly)
stopGrapl() {
$(MAKE) dump-artifacts-local
# skip if KEEP_TEST_ENV is set
if [[ -z "${KEEP_TEST_ENV}" ]]; then
@echo "Tearing down test environment"
else
@echo "Keeping test environment" && return 0
fi
# Unset COMPOSE_FILE to help ensure it will be ignored with use of --file
unset COMPOSE_FILE
$(MAKE) down
}
# Ensure we call stop even after test failure, and return exit code from
# the test, not the stop command.
trap stopGrapl EXIT
# Bring up the Grapl environment and detach
$(MAKE) _up
# Run tests and check exit codes from each test container
@echo "--- Executing test with environment"
$${EXEC_TEST_COMMAND}
##@ Lint 🧹
.PHONY: lint
lint: lint-build
lint: lint-docker
lint: lint-hcl
lint: lint-prettier
lint: lint-proto
lint: lint-proto-breaking
lint: lint-python
lint: lint-rust
lint: lint-shell
lint: ## Run all lint checks
.PHONY: lint-build
lint-build: ## Lint Pants BUILD files
./pants update-build-files --check ::
.PHONY: lint-docker
lint-docker: ## Lint Dockerfiles with Hadolint
./pants filter --target-type=docker_image :: \
| xargs ./pants lint
.PHONY: lint-hcl
lint-hcl: ## Check to see if HCL files are formatted properly
${NONROOT_DOCKER_COMPOSE_CHECK} hcl-lint
.PHONY: lint-prettier
lint-prettier: build-prettier-image
lint-prettier: ## Run ts/js/yaml lint checks
${NONROOT_DOCKER_COMPOSE_CHECK} prettier-lint
.PHONY: lint-proto
lint-proto: ## Lint all protobuf definitions
$(PANTS_PROTO_FILTER) lint ::
.PHONY: lint-proto-breaking
lint-proto-breaking: ## Check protobuf definitions for breaking changes
${DOCKER_COMPOSE_CHECK} buf-breaking-change
.PHONY: lint-python
lint-python: ## Run Python lint checks
$(PANTS_PYTHON_FILTER) lint ::
.PHONY: lint-rust
lint-rust: lint-rust-clippy
lint-rust: lint-rust-rustfmt
lint-rust: ## Run Rust lint checks
.PHONY: lint-rust-clippy
lint-rust-clippy: ## Run Clippy on Rust code
$(RUST_MAKE) lint-clippy
.PHONY: lint-rust-rustfmt
lint-rust-rustfmt: ## Check to see if Rust code is properly formatted
$(RUST_MAKE) lint-rustfmt
.PHONY: lint-shell
lint-shell: ## Run Shell lint checks
$(PANTS_SHELL_FILTER) lint ::
##@ Formatting 💅
.PHONY: format
format: format-build
format: format-hcl
format: format-prettier
format: format-proto
format: format-python
format: format-rust
format: format-shell
format: ## Reformat all code
.PHONY: format-build
format-build: ## Reformat all Pants BUILD files
./pants update-build-files --no-update-build-files-fix-safe-deprecations ::
.PHONY: format-hcl
format-hcl: ## Reformat all HCL files
${NONROOT_DOCKER_COMPOSE_CHECK} hcl-format
.PHONY: format-prettier
format-prettier: build-prettier-image
format-prettier: ## Reformat js/ts/yaml
${NONROOT_DOCKER_COMPOSE_CHECK} prettier-format
.PHONY: format-proto
format-proto: ## Reformat all Protobuf definitions
$(PANTS_PROTO_FILTER) fmt ::
.PHONY: format-python
format-python: ## Reformat all Python code
$(PANTS_PYTHON_FILTER) fmt ::
.PHONY: format-rust
format-rust: ## Reformat all Rust code
$(RUST_MAKE) format
.PHONY: format-shell
format-shell: ## Reformat all shell code
$(PANTS_SHELL_FILTER) fmt ::
##@ Local Grapl 💻
.PHONY: up
up: ## Bring up local Grapl and detach to return control to tty
up: build-local-infrastructure _up
# NOTE: Internal target to decouple the building of images from the
# running of them. Do not invoke this directly.
.SILENT: _up
.PHONY: _up
_up:
# Primarily used for bringing up an environment for integration testing.
# For use with a project name consider setting COMPOSE_PROJECT_NAME env var
@echo "--- Deploying Nomad Infrastructure"
# Start the Nomad agent
$(MAKE) stop-nomad-detach; $(MAKE) start-nomad-detach
# We use this target with COMPOSE_FILE being set pointing to other files.
# Although it seems specifying the `--file` option overrides that, we'll
# explicitly unset that here to avoid potential surprises.
unset COMPOSE_FILE
# TODO: This could potentially be replaced with a docker compose run, but
# it doesn't have all these useful flags
@echo "--- Running Pulumi"
docker compose \
--file docker-compose.yml \
up --force-recreate --always-recreate-deps --renew-anon-volumes \
--exit-code-from pulumi \
pulumi && echo "✅ Pulumi deployed successfully ✅"
.SILENT: down
.PHONY: down
down: ## docker compose down - both stops and removes the containers
# This is only for killing the lambda containers that Localstack
# spins up in our network, but that docker compose doesn't know
# about. This must be the network that is used in Localstack's
# LAMBDA_DOCKER_NETWORK environment variable.
$(MAKE) stop-nomad-detach
docker compose $(EVERY_COMPOSE_FILE) down --timeout=0
@docker compose $(EVERY_COMPOSE_FILE) --project-name $(COMPOSE_PROJECT_RUST_INTEGRATION_TESTS) down --timeout=0
@docker compose $(EVERY_COMPOSE_FILE) --project-name $(COMPOSE_PROJECT_PYTHON_INTEGRATION_TESTS) down --timeout=0
.PHONY: stop
stop: ## docker compose stop - stops (but preserves) the containers
docker compose $(EVERY_COMPOSE_FILE) stop
# This is a convenience target for our frontend engineers, to make the dev loop
# slightly less arduous for grapl-web-ui/frontend development.
# It will *rebuild* the JS/Rust grapl-web-ui dependences, and then
# restart a currently-running `make up` web ui allocation, which will then
# retrieve the latest, newly-rebuilt Docker container.
#
# Will only work as expected as long as tag is "dev".
.PHONY: restart-web-ui
restart-web-ui-frontend: build-frontend ## Rebuild web-ui image, and restart web-ui task in Nomad
$(DOCKER_BUILDX_BAKE) grapl-web-ui
source ./nomad/lib/nomad_cli_tools.sh
nomad alloc restart "$$(nomad_get_alloc_id_for_task grapl-core web-ui)"
##@ Venv Management
########################################################################
.PHONY: generate-constraints
generate-constraints: ## Generates a constraints file from the requirements.txt file
build-support/manage_virtualenv.sh regenerate-constraints
.PHONY: populate-venv
populate-venv: ## Set up a Python virtualenv from constraints file (you'll have to activate manually!)
build-support/manage_virtualenv.sh populate
##@ Utility ⚙
# Preliminaries
dist:
mkdir dist
.PHONY: clean
clean: clean-dist
clean: clean-artifacts
clean: clean-frontend
clean: ## Clean all generated artifacts
.PHONY: clean-all
clean-all: clean
clean-all: clean-docker
clean-all: clean-all-rust
clean-all: ## Clean all generated artifacts AND Docker-related resources
.PHONY: clean-dist
clean-dist: ## Clean out the `dist` directory
rm -Rf dist
.PHONY: clean-docker
clean-docker: clean-docker-cache
clean-docker: clean-docker-containers
clean-docker: clean-docker-images
clean-docker: clean-docker-data-volumes
clean-docker: ## Clean all Docker-related resources
.PHONY: clean-artifacts
clean-artifacts: ## Remove all dumped artifacts from test runs
# See dump_artifacts.py
rm -Rf test_artifacts
.PHONY: clean-docker-cache
clean-docker-cache:
docker builder prune --all --force
.PHONY: clean-docker-cache-mount
clean-docker-cache-mount: ## Prune only the Buildkit cache mounts
# The best documentation I can find for this is right now is
# https://github.com/docker/cli/issues/2325#issuecomment-733975408
docker builder prune --filter type=exec.cachemount
# TODO: worth adding any additional types for pruning?
clean-docker-containers: ## Remove all running Grapl containers
docker ps \
--filter=label=$(DOCKER_FILTER_LABEL) \
| xargs --no-run-if-empty docker rm --volumes --force
clean-docker-images: ## Remove all Grapl images
docker images \
--filter=label=$(DOCKER_FILTER_LABEL) \
--quiet \
| xargs --no-run-if-empty docker rmi --force
clean-docker-data-volumes: ## Remove all Grapl labeled volumes
# We explicitly don't want to prune the build cache volumes
docker volume ls ${DOCKER_DATA_VOLUME_FILTERS} --quiet |
xargs --no-run-if-empty docker volume rm --force
.PHONY: clean-frontend
clean-frontend:
$(FRONTEND_MAKE) clean
clean-all-rust:
$(RUST_MAKE) clean-all
########################################################################
.PHONY: local-pulumi
local-pulumi: export COMPOSE_PROJECT_NAME="grapl"
local-pulumi: ## launch pulumi via docker compose up
docker compose -f docker-compose.yml run pulumi
.PHONY: start-nomad-detach
start-nomad-detach: ## Start the Nomad environment, detached
nomad/local/start_detach.sh
.PHONY: stop-nomad-detach
stop-nomad-detach: ## Stop Nomad CI environment
nomad/local/stop_detach.sh
.PHONY: docker-kill-all
docker-kill-all: # Kill all currently running Docker containers except registry
# https://stackoverflow.com/a/46208493
TO_KILL=$$(docker ps --all --quiet | grep -v -E $$(docker ps -aq --filter='name=grapl_local_registry' | paste -sd "|" -))
docker kill $${TO_KILL}
.PHONY: build-docs
build-docs: ## Build the Sphinx docs
./docs/build_docs.sh
.PHONY: generate-nomad-rust-client
generate-nomad-rust-client: ## Generate the Nomad rust client from OpenAPI
./src/rust/bin/generate_nomad_rust_client.sh
$(MAKE) format-rust
# TODO: If we ever break out a targeted `format-markdown` target, we
# should use that here.
$(MAKE) format-prettier
.PHONY: setup-docker-tracing
buildx-tracing: ## This is a one-time setup for enabling docker buildx traces
docker buildx create \
--name grapl-tracing-builder \
--driver docker-container \
--driver-opt network=host \
--driver-opt env.JAEGER_TRACE=localhost:6831 \
--use
.PHONY: generate-sqlx-data
generate-sqlx-data: ## Regenerate sqlx-data.json based on queries made in Rust code
./src/rust/bin/generate_sqlx_data.sh
dist/firecracker_kernel.tar.gz: firecracker/kernel/build.sh | dist
./firecracker/kernel/build.sh
# TODO: Would be nice to be able to specify the input file prerequisites of
# this target and make non-PHONY. It's currently PHONY because otherwise,
# rebuilds would only occur if the dist/plugin-bootstrap-init dir were deleted.
# NOTE: While this target is PHONY, it *does* represent a real directory in
# dist/
.PHONY: dist/plugin-bootstrap-init
dist/plugin-bootstrap-init: _export-rust-build-artifacts-to-dist ## Build the Plugin Bootstrap Init (+ associated files) and copy it to dist/
.PHONY: _export-rust-build-artifacts-to-dist
_export-rust-build-artifacts-to-dist: | dist ## Copy all specified Rust binary artifacts to dist/
$(DOCKER_BUILDX_BAKE) export-rust-build-artifacts-to-dist
# TODO: Would be nice to be able to specify the input file prerequisites of
# this target, once `dist/plugin-bootstrap-init` is non-PHONY
dist/firecracker_rootfs.tar.gz: dist/plugin-bootstrap-init | dist
./firecracker/rootfs/build.sh