Makefile
bdcd81d3
 .PHONY: all binary dynbinary build cross help install manpages run shell test test-docker-py test-integration test-unit validate win
26533eb2
 
833444c0
 ifdef USE_BUILDX
 BUILDX ?= $(shell command -v buildx)
 BUILDX ?= $(shell command -v docker-buildx)
 DOCKER_BUILDX_CLI_PLUGIN_PATH ?= ~/.docker/cli-plugins/docker-buildx
 BUILDX ?= $(shell if [ -x "$(DOCKER_BUILDX_CLI_PLUGIN_PATH)" ]; then echo $(DOCKER_BUILDX_CLI_PLUGIN_PATH); fi)
 endif
 
1be2cc25
 ifndef USE_BUILDX
 DOCKER_BUILDKIT := 1
 export DOCKER_BUILDKIT
 endif
 
833444c0
 BUILDX ?= bundles/buildx
 DOCKER ?= docker
 
54aa3a3c
 # set the graph driver as the current graphdriver if not set
b967e381
 DOCKER_GRAPHDRIVER := $(if $(DOCKER_GRAPHDRIVER),$(DOCKER_GRAPHDRIVER),$(shell docker info 2>&1 | grep "Storage Driver" | sed 's/.*: //'))
2c342cff
 export DOCKER_GRAPHDRIVER
54aa3a3c
 
b74fd062
 # get OS/Arch of docker engine
32915b1d
 DOCKER_OSARCH := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKER_ENGINE_OSARCH}')
a667cd88
 DOCKERFILE := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKERFILE}')
b74fd062
 
fae6ca2b
 DOCKER_GITCOMMIT := $(shell git rev-parse --short HEAD || echo unsupported)
 export DOCKER_GITCOMMIT
 
2a08f331
 # 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
feb70fd5
 export VALIDATE_ORIGIN_BRANCH
2a08f331
 
82f33d86
 # env vars passed through directly to Docker's build scripts
9e7651db
 # to allow things like `make KEEPBUNDLE=1 binary` easily
38550d27
 # `project/PACKAGERS.md` have some limited documentation of some of these
17708e72
 #
 # 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/docker/docker/daemon/graphdriver.priority=overlay2,devicemapper" dynbinary
 #
82f33d86
 DOCKER_ENVS := \
b877fc31
 	-e DOCKER_CROSSPLATFORMS \
f672a963
 	-e BUILD_APT_MIRROR \
82f33d86
 	-e BUILDFLAGS \
d2377816
 	-e KEEPBUNDLE \
4aa9b9c5
 	-e DOCKER_BUILD_ARGS \
9672afa3
 	-e DOCKER_BUILD_GOGC \
e6d7df2e
 	-e DOCKER_BUILD_OPTS \
0bff2515
 	-e DOCKER_BUILD_PKGS \
f6e58ca3
 	-e DOCKER_BUILDKIT \
0e2c424a
 	-e DOCKER_BASH_COMPLETION_PATH \
32915b1d
 	-e DOCKER_CLI_PATH \
a121ac85
 	-e DOCKER_DEBUG \
ca6722f1
 	-e DOCKER_EXPERIMENTAL \
1aa93694
 	-e DOCKER_GITCOMMIT \
2c342cff
 	-e DOCKER_GRAPHDRIVER \
17708e72
 	-e DOCKER_LDFLAGS \
cae890bc
 	-e DOCKER_PORT \
2bc57578
 	-e DOCKER_REMAP_ROOT \
5bf33adb
 	-e DOCKER_ROOTLESS \
30f3bd64
 	-e DOCKER_STORAGE_OPTS \
968345bc
 	-e DOCKER_TEST_HOST \
d18919e3
 	-e DOCKER_USERLANDPROXY \
d2af0d96
 	-e DOCKERD_ARGS \
545e8171
 	-e TEST_FORCE_VALIDATE \
96707bc6
 	-e TEST_INTEGRATION_DIR \
abece9b5
 	-e TEST_SKIP_INTEGRATION \
 	-e TEST_SKIP_INTEGRATION_CLI \
968345bc
 	-e TESTDEBUG \
82f33d86
 	-e TESTDIRS \
 	-e TESTFLAGS \
abece9b5
 	-e TESTFLAGS_INTEGRATION \
 	-e TESTFLAGS_INTEGRATION_CLI \
13064b15
 	-e TEST_FILTER \
c125bbd5
 	-e TIMEOUT \
2a08f331
 	-e VALIDATE_REPO \
 	-e VALIDATE_BRANCH \
feb70fd5
 	-e VALIDATE_ORIGIN_BRANCH \
c125bbd5
 	-e HTTP_PROXY \
 	-e HTTPS_PROXY \
 	-e NO_PROXY \
 	-e http_proxy \
 	-e https_proxy \
76643025
 	-e no_proxy \
9152e632
 	-e VERSION \
195919d9
 	-e PLATFORM \
896d1b1c
 	-e DEFAULT_PRODUCT_LICENSE \
195919d9
 	-e PRODUCT
82f33d86
 # 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
 
987050a5
 # to allow `make BIND_DIR=. shell` or `make BIND_DIR= test`
c2653b0a
 # (default to no bind mount if DOCKER_HOST is set)
987050a5
 # note: BINDDIR is supported for backwards-compatibility here
 BIND_DIR := $(if $(BINDDIR),$(BINDDIR),$(if $(DOCKER_HOST),,bundles))
aea6fdf3
 
 # DOCKER_MOUNT can be overriden, but use at your own risk!
 ifndef DOCKER_MOUNT
987050a5
 DOCKER_MOUNT := $(if $(BIND_DIR),-v "$(CURDIR)/$(BIND_DIR):/go/src/github.com/docker/docker/$(BIND_DIR)")
b1e6536c
 DOCKER_MOUNT := $(if $(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT):$(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT))
82f33d86
 
a95ad53c
 # 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.
83062593
 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"
a95ad53c
 
bdcd81d3
 DOCKER_MOUNT_CACHE := -v docker-dev-cache:/root/.cache
32915b1d
 DOCKER_MOUNT_CLI := $(if $(DOCKER_CLI_PATH),-v $(shell dirname $(DOCKER_CLI_PATH)):/usr/local/cli,)
0e2c424a
 DOCKER_MOUNT_BASH_COMPLETION := $(if $(DOCKER_BASH_COMPLETION_PATH),-v $(shell dirname $(DOCKER_BASH_COMPLETION_PATH)):/usr/local/completion/bash,)
bdcd81d3
 DOCKER_MOUNT := $(DOCKER_MOUNT) $(DOCKER_MOUNT_CACHE) $(DOCKER_MOUNT_CLI) $(DOCKER_MOUNT_BASH_COMPLETION)
aea6fdf3
 endif # ifndef DOCKER_MOUNT
 
 # This allows to set the docker-dev container name
 DOCKER_CONTAINER_NAME := $(if $(CONTAINER_NAME),--name $(CONTAINER_NAME),)
389d5cde
 
b51fe178
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
a4192471
 GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
 DOCKER_IMAGE := docker-dev$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))
cae890bc
 DOCKER_PORT_FORWARD := $(if $(DOCKER_PORT),-p "$(DOCKER_PORT)",)
bd24eb07
 
833444c0
 DOCKER_FLAGS := $(DOCKER) run --rm -i --privileged $(DOCKER_CONTAINER_NAME) $(DOCKER_ENVS) $(DOCKER_MOUNT) $(DOCKER_PORT_FORWARD)
39c87c79
 BUILD_APT_MIRROR := $(if $(DOCKER_BUILD_APT_MIRROR),--build-arg APT_MIRROR=$(DOCKER_BUILD_APT_MIRROR))
f672a963
 export BUILD_APT_MIRROR
82f33d86
 
27ca33e9
 SWAGGER_DOCS_PORT ?= 9000
 
32915b1d
 define \n
 
 
 endef
 
4d41fe0b
 # 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
82f33d86
 
4d41fe0b
 DOCKER_RUN_DOCKER := $(DOCKER_FLAGS) "$(DOCKER_IMAGE)"
8d4459ff
 
e7d2d853
 DOCKER_BUILD_ARGS += --build-arg=GO_VERSION
a3292263
 ifdef DOCKER_SYSTEMD
 DOCKER_BUILD_ARGS += --build-arg=SYSTEMD=true
 endif
 
e7d2d853
 BUILD_OPTS := ${BUILD_APT_MIRROR} ${DOCKER_BUILD_ARGS} ${DOCKER_BUILD_OPTS} -f "$(DOCKERFILE)"
 ifdef USE_BUILDX
 BUILD_OPTS += $(BUILDX_BUILD_EXTRA_OPTS)
 BUILD_CMD := $(BUILDX) build
 else
 BUILD_CMD := $(DOCKER) build
 endif
 
 # This is used for the legacy "build" target and anything still depending on it
 BUILD_CROSS =
 ifdef DOCKER_CROSS
 BUILD_CROSS = --build-arg CROSS=$(DOCKER_CROSS)
 endif
 ifdef DOCKER_CROSSPLATFORMS
 BUILD_CROSS = --build-arg CROSS=true
 endif
 
c057825c
 VERSION_AUTOGEN_ARGS = --build-arg VERSION --build-arg DOCKER_GITCOMMIT --build-arg PRODUCT --build-arg PLATFORM --build-arg DEFAULT_PRODUCT_LICENSE
 
00030ced
 default: binary
 
a4400d32
 all: build ## validate all checks, build linux binaries, run all tests,\ncross build non-linux binaries, and generate archives
22033e10
 	$(DOCKER_RUN_DOCKER) bash -c 'hack/validate/default && hack/make.sh'
00030ced
 
5dffe74d
 # This is only used to work around read-only bind mounts of the source code into
 # binary build targets. We end up mounting a tmpfs over autogen which allows us
 # to write build-time generated assets even though the source is mounted read-only
 # ...But in order to do so, this dir needs to already exist.
 autogen:
 	mkdir -p autogen
 
a4400d32
 binary: buildx autogen ## build statically linked linux binaries
 	$(BUILD_CMD) $(BUILD_OPTS) --output=bundles/ --target=$@ $(VERSION_AUTOGEN_ARGS) .
 
 dynbinary: buildx autogen ## build dynamically linked linux binaries
 	$(BUILD_CMD) $(BUILD_OPTS) --output=bundles/ --target=$@ $(VERSION_AUTOGEN_ARGS) .
 
 cross: BUILD_OPTS += --build-arg CROSS=true --build-arg DOCKER_CROSSPLATFORMS
 cross: buildx autogen ## cross build the binaries for darwin, freebsd and\nwindows
c057825c
 	$(BUILD_CMD) $(BUILD_OPTS) --output=bundles/ --target=$@ $(VERSION_AUTOGEN_ARGS) .
61a32858
 
2bc57578
 bundles:
 	mkdir bundles
 
bdcd81d3
 .PHONY: clean
 clean: clean-cache
c9623d1b
 
bdcd81d3
 .PHONY: clean-cache
 clean-cache:
 	docker volume rm -f docker-dev-cache
c9623d1b
 
c2775c0b
 help: ## this help
202c9d8c
 	@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)
c2775c0b
 
9bb54f89
 install: ## install the linux binaries
 	KEEPBUNDLE=1 hack/make.sh install-binary
 
cae890bc
 run: build ## run the docker daemon in a container
 	$(DOCKER_RUN_DOCKER) sh -c "KEEPBUNDLE=1 hack/make.sh install-binary run"
e7d2d853
  
9688ca59
 .PHONY: build
1c82d119
 ifeq ($(BIND_DIR), .)
9688ca59
 build: shell_target := --target=dev
1c82d119
 else
9688ca59
 build: shell_target := --target=final
1c82d119
 endif
e7d2d853
 ifdef USE_BUILDX
9688ca59
 build: buildx_load := --load
e7d2d853
 endif
9688ca59
 build: buildx
e7d2d853
 	$(BUILD_CMD) $(BUILD_OPTS) $(shell_target) $(buildx_load) $(BUILD_CROSS) -t "$(DOCKER_IMAGE)" .
 
9688ca59
 shell: build  ## start a shell inside the build env
2bc57578
 	$(DOCKER_RUN_DOCKER) bash
 
a17071e8
 test: build test-unit ## run the unit, integration and docker-py tests
 	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary cross test-integration test-docker-py
a39f3c92
 
c72b51b0
 test-docker-py: build ## run the docker-py tests
2bc57578
 	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-docker-py
26533eb2
 
bc82b139
 test-integration-cli: test-integration ## (DEPRECATED) use test-integration
6b025a8b
 
abece9b5
 ifneq ($(and $(TEST_SKIP_INTEGRATION),$(TEST_SKIP_INTEGRATION_CLI)),)
 test-integration:
 	@echo Both integrations suites skipped per environment variables
 else
6b025a8b
 test-integration: build ## run the integration tests
 	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration
abece9b5
 endif
6db32fde
 
8a8fd37f
 test-integration-flaky: build ## run the stress test for all new integration tests
 	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration-flaky
 
c72b51b0
 test-unit: build ## run the unit tests
c500bb56
 	$(DOCKER_RUN_DOCKER) hack/test/unit
100267de
 
bf3d1d1e
 validate: build ## validate DCO, Seccomp profile generation, gofmt,\n./pkg/ isolation, golint, tests, tomls, go vet and vendor
22033e10
 	$(DOCKER_RUN_DOCKER) hack/validate/all
c72b51b0
 
c2775c0b
 win: build ## cross build the binary for windows
7fdac7eb
 	$(DOCKER_RUN_DOCKER) DOCKER_CROSSPLATFORMS=windows/amd64 hack/make.sh cross
0243936d
 
 .PHONY: swagger-gen
 swagger-gen:
252963bd
 	docker run --rm -v $(PWD):/go/src/github.com/docker/docker \
 		-w /go/src/github.com/docker/docker \
02e1ffd7
 		--entrypoint hack/generate-swagger-api.sh \
252963bd
 		-e GOPATH=/go \
ba20c3e6
 		quay.io/goswagger/swagger:0.7.4
27ca33e9
 
 .PHONY: swagger-docs
 swagger-docs: ## preview the API documentation
 	@echo "API docs preview will be running at http://localhost:$(SWAGGER_DOCS_PORT)"
 	@docker run --rm -v $(PWD)/api/swagger.yaml:/usr/share/nginx/html/swagger.yaml \
 		-e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \
 		-p $(SWAGGER_DOCS_PORT):80 \
 		bfirsh/redoc:1.6.2
833444c0
 
 .PHONY: buildx
e7d2d853
 ifdef USE_BUILDX
833444c0
 ifeq ($(BUILDX), bundles/buildx)
a602ecf8
 buildx: bundles/buildx ## build buildx cli tool
833444c0
 endif
c057825c
 endif
833444c0
 
a602ecf8
 # This intentionally is not using the `--output` flag from the docker CLI, which
 # is a buildkit option. The idea here being that if buildx is being used, it's
 # because buildkit is not supported natively
833444c0
 bundles/buildx: bundles ## build buildx CLI tool
9638d1a4
 	docker build -f $${BUILDX_DOCKERFILE:-Dockerfile.buildx} -t "moby-buildx:$${BUILDX_COMMIT:-latest}" \
833444c0
 		--build-arg BUILDX_COMMIT \
 		--build-arg BUILDX_REPO \
 		--build-arg GOOS=$$(if [ -n "$(GOOS)" ]; then echo $(GOOS); else go env GOHOSTOS || uname | awk '{print tolower($$0)}' || true; fi) \
 		--build-arg GOARCH=$$(if [ -n "$(GOARCH)" ]; then echo $(GOARCH); else go env GOHOSTARCH || true; fi) \
365b3aee
 		.
 
 	id=$$(docker create moby-buildx:$${BUILDX_COMMIT:-latest}); \
 	if [ -n "$${id}" ]; then \
 		docker cp $${id}:/usr/bin/buildx $@ \
 		&& touch $@; \
 		docker rm -f $${id}; \
 	fi
 
 	$@ version