| DOCKER ?= docker | |
| BUILDX ?= $(DOCKER) buildx | |
| DOCKER_GITCOMMIT := $(shell git rev-parse HEAD) | |
| export DOCKER_GITCOMMIT | |
| # allow overriding the repository and branch that validation scripts are running | |
| # against these are used in hack/validate/.validate to check what changed in the PR. | |
| export VALIDATE_REPO | |
| export VALIDATE_BRANCH | |
| export VALIDATE_ORIGIN_BRANCH | |
| export PAGER | |
| export GIT_PAGER | |
| # env vars passed through directly to Docker's build scripts | |
| # to allow things like `make KEEPBUNDLE=1 binary` easily | |
| # `project/PACKAGERS.md` have some limited documentation of some of these | |
| # | |
| # DOCKER_LDFLAGS can be used to pass additional parameters to -ldflags | |
| # option of "go build". For example, a built-in graphdriver priority list | |
| # can be changed during build time like this: | |
| # | |
| # make DOCKER_LDFLAGS="-X github.com/moby/moby/v2/daemon/graphdriver.priority=overlay2,zfs" dynbinary | |
| # | |
| DOCKER_ENVS := \ | |
| -e BUILDFLAGS \ | |
| -e KEEPBUNDLE \ | |
| -e DOCKER_BUILD_ARGS \ | |
| -e DOCKER_BUILDKIT \ | |
| -e DOCKER_CLI_PATH \ | |
| -e DOCKERCLI_VERSION \ | |
| -e DOCKERCLI_REPOSITORY \ | |
| -e DOCKERCLI_INTEGRATION_VERSION \ | |
| -e DOCKERCLI_INTEGRATION_REPOSITORY \ | |
| -e DOCKER_DEBUG \ | |
| -e DOCKER_EXPERIMENTAL \ | |
| -e DOCKER_FIREWALL_BACKEND \ | |
| -e DOCKER_GITCOMMIT \ | |
| -e DOCKER_GRAPHDRIVER \ | |
| -e DOCKER_IGNORE_BR_NETFILTER_ERROR \ | |
| -e DOCKER_LDFLAGS \ | |
| -e DOCKER_PORT \ | |
| -e DOCKER_REMAP_ROOT \ | |
| -e DOCKER_ROOTLESS \ | |
| -e DOCKER_STORAGE_OPTS \ | |
| -e DOCKER_TEST_HOST \ | |
| -e DOCKER_USERLANDPROXY \ | |
| -e DOCKERD_ARGS \ | |
| -e DELVE_PORT \ | |
| -e FIREWALLD \ | |
| -e GITHUB_ACTIONS \ | |
| -e TEST_FORCE_VALIDATE \ | |
| -e TEST_INTEGRATION_DIR \ | |
| -e TEST_INTEGRATION_USE_GRAPHDRIVER \ | |
| -e TEST_INTEGRATION_FAIL_FAST \ | |
| -e TEST_SKIP_INTEGRATION \ | |
| -e TEST_SKIP_INTEGRATION_CLI \ | |
| -e TESTCOVERAGE \ | |
| -e TESTDEBUG \ | |
| -e TESTDIRS \ | |
| -e TESTFLAGS \ | |
| -e TESTFLAGS_INTEGRATION \ | |
| -e TESTFLAGS_INTEGRATION_CLI \ | |
| -e TEST_FILTER \ | |
| -e TIMEOUT \ | |
| -e VALIDATE_REPO \ | |
| -e VALIDATE_BRANCH \ | |
| -e VALIDATE_ORIGIN_BRANCH \ | |
| -e VERSION \ | |
| -e PLATFORM \ | |
| -e DEFAULT_PRODUCT_LICENSE \ | |
| -e PRODUCT \ | |
| -e PACKAGER_NAME \ | |
| -e PAGER \ | |
| -e GIT_PAGER \ | |
| -e OTEL_EXPORTER_OTLP_ENDPOINT \ | |
| -e OTEL_EXPORTER_OTLP_PROTOCOL \ | |
| -e OTEL_SERVICE_NAME | |
| # note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds | |
| # to allow `make BIND_DIR=. shell` or `make BIND_DIR= test` | |
| # (default to no bind mount if DOCKER_HOST is set) | |
| # note: BINDDIR is supported for backwards-compatibility here | |
| BIND_DIR := $(if $(BINDDIR),$(BINDDIR),$(if $(DOCKER_HOST),,.)) | |
| # DOCKER_MOUNT can be overridden, but use at your own risk! | |
| ifndef DOCKER_MOUNT | |
| DOCKER_MOUNT := $(if $(BIND_DIR),-v "$(BIND_DIR):/go/src/github.com/docker/docker/$(BIND_DIR)") | |
| DOCKER_MOUNT := $(if $(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT):$(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT)) | |
| # This allows the test suite to be able to run without worrying about the underlying fs used by the container running the daemon (e.g. aufs-on-aufs), so long as the host running the container is running a supported fs. | |
| # The volume will be cleaned up when the container is removed due to `--rm`. | |
| # Note that `BIND_DIR` will already be set to `bundles` if `DOCKER_HOST` is not set (see above BIND_DIR line), in such case this will do nothing since `DOCKER_MOUNT` will already be set. | |
| DOCKER_MOUNT := $(if $(DOCKER_MOUNT),$(DOCKER_MOUNT),-v /go/src/github.com/docker/docker/bundles) -v "$(CURDIR)/.git:/go/src/github.com/docker/docker/.git" | |
| DOCKER_MOUNT_CACHE := -v docker-dev-cache:/root/.cache -v docker-mod-cache:/go/pkg/mod/ | |
| DOCKER_MOUNT_CLI := $(if $(DOCKER_CLI_PATH),-v $(shell dirname $(DOCKER_CLI_PATH)):/usr/local/cli,) | |
| ifdef BIND_GIT | |
| # Gets the common .git directory (even from inside a git worktree) | |
| GITDIR := $(shell realpath $(shell git rev-parse --git-common-dir)) | |
| MOUNT_GITDIR := $(if $(GITDIR),-v "$(GITDIR):$(GITDIR)") | |
| endif | |
| DOCKER_MOUNT := $(DOCKER_MOUNT) $(DOCKER_MOUNT_CACHE) $(DOCKER_MOUNT_CLI) $(DOCKER_MOUNT_BASH_COMPLETION) $(MOUNT_GITDIR) | |
| endif # ifndef DOCKER_MOUNT | |
| # This allows to set the docker-dev container name | |
| DOCKER_CONTAINER_NAME := $(if $(CONTAINER_NAME),--name $(CONTAINER_NAME),) | |
| DOCKER_IMAGE := docker-dev | |
| DOCKER_PORT_FORWARD := $(if $(DOCKER_PORT),-p "$(DOCKER_PORT)",) | |
| DELVE_PORT_FORWARD := $(if $(DELVE_PORT),-p "$(DELVE_PORT)",) | |
| DOCKER_FLAGS := $(DOCKER) run --rm --privileged $(DOCKER_CONTAINER_NAME) $(DOCKER_ENVS) $(DOCKER_MOUNT) $(DOCKER_PORT_FORWARD) $(DELVE_PORT_FORWARD) | |
| define \n | |
| endef | |
| # if this session isn't interactive, then we don't want to allocate a | |
| # TTY, which would fail, but if it is interactive, we do want to attach | |
| # so that the user can send e.g. ^C through. | |
| INTERACTIVE := $(shell [ -t 0 ] && echo 1 || echo 0) | |
| ifeq ($(INTERACTIVE), 1) | |
| DOCKER_FLAGS += -t | |
| endif | |
| # on GitHub Runners input device is not a TTY but we allocate a pseudo-one, | |
| # otherwise keep STDIN open even if not attached if not a GitHub Runner. | |
| ifeq ($(GITHUB_ACTIONS),true) | |
| DOCKER_FLAGS += -t | |
| else | |
| DOCKER_FLAGS += -i | |
| endif | |
| DOCKER_RUN_DOCKER := $(DOCKER_FLAGS) "$(DOCKER_IMAGE)" | |
| DOCKER_BUILD_ARGS += --build-arg=GO_VERSION | |
| DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_VERSION | |
| DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_REPOSITORY | |
| DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_INTEGRATION_VERSION | |
| DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_INTEGRATION_REPOSITORY | |
| ifdef DOCKER_SYSTEMD | |
| DOCKER_BUILD_ARGS += --build-arg=SYSTEMD=true | |
| endif | |
| ifdef FIREWALLD | |
| DOCKER_BUILD_ARGS += --build-arg=FIREWALLD=true | |
| endif | |
| BUILD_OPTS := ${DOCKER_BUILD_ARGS} | |
| BUILD_CMD := $(BUILDX) build | |
| BAKE_CMD := $(BUILDX) bake | |
| default: binary | |
| .PHONY: all | |
| all: build ## validate all checks, build linux binaries, run all tests,\ncross build non-linux binaries, and generate archives | |
| $(DOCKER_RUN_DOCKER) bash -c 'hack/validate/default && hack/make.sh' | |
| .PHONY: binary | |
| binary: bundles ## build statically linked linux binaries | |
| $(BAKE_CMD) binary | |
| .PHONY: dynbinary | |
| dynbinary: bundles ## build dynamically linked linux binaries | |
| $(BAKE_CMD) dynbinary | |
| .PHONY: cross | |
| cross: bundles ## cross build the binaries | |
| $(BAKE_CMD) binary-cross | |
| bundles: | |
| mkdir bundles | |
| .PHONY: clean | |
| clean: clean-cache | |
| .PHONY: clean-cache | |
| clean-cache: ## remove the docker volumes that are used for caching in the dev-container | |
| docker volume rm -f docker-dev-cache docker-mod-cache | |
| .PHONY: help | |
| help: ## this help | |
| @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {gsub("\\\\n",sprintf("\n%22c",""), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | |
| .PHONY: install | |
| install: ## install the linux binaries | |
| KEEPBUNDLE=1 hack/make.sh install-binary | |
| .PHONY: run | |
| run: build ## run the docker daemon in a container | |
| $(DOCKER_RUN_DOCKER) sh -c "KEEPBUNDLE=1 hack/make.sh install-binary run" | |
| .PHONY: build | |
| ifeq ($(BIND_DIR), .) | |
| build: shell_target := --target=dev-base | |
| else | |
| build: shell_target := --target=dev | |
| endif | |
| build: validate-bind-dir bundles | |
| $(BUILD_CMD) $(BUILD_OPTS) $(shell_target) --load -t "$(DOCKER_IMAGE)" . | |
| .PHONY: shell | |
| shell: build ## start a shell inside the build env | |
| $(DOCKER_RUN_DOCKER) bash | |
| .PHONY: dev | |
| dev: build ## start a dev mode inside the build env | |
| $(DOCKER_RUN_DOCKER) hack/dev.sh | |
| .PHONY: test | |
| test: build test-unit ## run the unit, integration and docker-py tests | |
| $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration test-docker-py | |
| .PHONY: test-docker-py | |
| test-docker-py: build ## run the docker-py tests | |
| $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-docker-py | |
| .PHONY: test-integration-cli | |
| test-integration-cli: test-integration ## (DEPRECATED) use test-integration | |
| .PHONY: test-integration | |
| ifneq ($(and $(TEST_SKIP_INTEGRATION),$(TEST_SKIP_INTEGRATION_CLI)),) | |
| test-integration: | |
| @echo Both integrations suites skipped per environment variables | |
| else | |
| test-integration: build ## run the integration tests | |
| $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration | |
| endif | |
| .PHONY: test-integration-flaky | |
| test-integration-flaky: build ## run the stress test for all new integration tests | |
| $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration-flaky | |
| .PHONY: test-unit | |
| test-unit: build ## run the unit tests | |
| $(DOCKER_RUN_DOCKER) hack/test/unit | |
| .PHONY: validate | |
| validate: build ## validate DCO, Seccomp profile generation, gofmt,\n./pkg/ isolation, golint, tests, tomls, go vet and vendor | |
| $(DOCKER_RUN_DOCKER) hack/validate/all | |
| .PHONY: validate-generate-files | |
| validate-generate-files: | |
| $(BUILD_CMD) --target "validate" \ | |
| --output "type=cacheonly" \ | |
| --file "./hack/dockerfiles/generate-files.Dockerfile" . | |
| .PHONY: validate-% | |
| validate-%: build ## validate specific check | |
| $(DOCKER_RUN_DOCKER) hack/validate/$* | |
| .PHONY: win | |
| win: bundles ## cross build the binary for windows | |
| $(BAKE_CMD) --set *.platform=windows/amd64 binary | |
| .PHONY: swagger-gen | |
| swagger-gen: ## generate swagger API types | |
| $(MAKE) -C api swagger-gen | |
| .PHONY: swagger-docs | |
| swagger-docs: ## preview the API documentation | |
| $(MAKE) -C api swagger-docs | |
| .PHONY: generate-files | |
| generate-files: | |
| $(eval $@_TMP_OUT := $(shell mktemp -d -t moby-output.XXXXXXXXXX)) | |
| @if [ -z "$($@_TMP_OUT)" ]; then \ | |
| echo "Temp dir is not set"; \ | |
| exit 1; \ | |
| fi | |
| $(BUILD_CMD) --target "update" \ | |
| --output "type=local,dest=$($@_TMP_OUT)" \ | |
| --file "./hack/dockerfiles/generate-files.Dockerfile" . | |
| cp -R "$($@_TMP_OUT)"/. . | |
| rm -rf "$($@_TMP_OUT)"/* | |
| .PHONY: validate-bind-dir | |
| validate-bind-dir: | |
| @case "$(BIND_DIR)" in \ | |
| ".."*|"/"*) echo "Make needs to be run from the project-root directory, with BIND_DIR set to \".\" or a subdir"; \ | |
| exit 1 ;; \ | |
| esac |