1.PHONY: all binary dynbinary build cross deb help init-go-pkg-cache install manpages rpm run shell test test-docker-py test-integration test-unit validate win
2
3# set the graph driver as the current graphdriver if not set
4DOCKER_GRAPHDRIVER := $(if $(DOCKER_GRAPHDRIVER),$(DOCKER_GRAPHDRIVER),$(shell docker info 2>&1 | grep "Storage Driver" | sed 's/.*: //'))
5export DOCKER_GRAPHDRIVER
6DOCKER_INCREMENTAL_BINARY := $(if $(DOCKER_INCREMENTAL_BINARY),$(DOCKER_INCREMENTAL_BINARY),1)
7export DOCKER_INCREMENTAL_BINARY
8
9# get OS/Arch of docker engine
10DOCKER_OSARCH := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKER_ENGINE_OSARCH}')
11DOCKERFILE := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKERFILE}')
12
13DOCKER_GITCOMMIT := $(shell git rev-parse --short HEAD || echo unsupported)
14export DOCKER_GITCOMMIT
15
16# env vars passed through directly to Docker's build scripts
17# to allow things like `make KEEPBUNDLE=1 binary` easily
18# `project/PACKAGERS.md` have some limited documentation of some of these
19#
20# DOCKER_LDFLAGS can be used to pass additional parameters to -ldflags
21# option of "go build". For example, a built-in graphdriver priority list
22# can be changed during build time like this:
23#
24# make DOCKER_LDFLAGS="-X github.com/docker/docker/daemon/graphdriver.priority=overlay2,devicemapper" dynbinary
25#
26DOCKER_ENVS := \
27	-e DOCKER_CROSSPLATFORMS \
28	-e BUILD_APT_MIRROR \
29	-e BUILDFLAGS \
30	-e KEEPBUNDLE \
31	-e DOCKER_BUILD_ARGS \
32	-e DOCKER_BUILD_GOGC \
33	-e DOCKER_BUILD_PKGS \
34	-e DOCKER_BASH_COMPLETION_PATH \
35	-e DOCKER_CLI_PATH \
36	-e DOCKER_DEBUG \
37	-e DOCKER_EXPERIMENTAL \
38	-e DOCKER_GITCOMMIT \
39	-e DOCKER_GRAPHDRIVER \
40	-e DOCKER_INCREMENTAL_BINARY \
41	-e DOCKER_LDFLAGS \
42	-e DOCKER_PORT \
43	-e DOCKER_REMAP_ROOT \
44	-e DOCKER_STORAGE_OPTS \
45	-e DOCKER_USERLANDPROXY \
46	-e TEST_INTEGRATION_DIR \
47	-e TESTDIRS \
48	-e TESTFLAGS \
49	-e TIMEOUT \
50	-e HTTP_PROXY \
51	-e HTTPS_PROXY \
52	-e NO_PROXY \
53	-e http_proxy \
54	-e https_proxy \
55	-e no_proxy \
56	-e VERSION \
57	-e PLATFORM
58# 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
59
60# to allow `make BIND_DIR=. shell` or `make BIND_DIR= test`
61# (default to no bind mount if DOCKER_HOST is set)
62# note: BINDDIR is supported for backwards-compatibility here
63BIND_DIR := $(if $(BINDDIR),$(BINDDIR),$(if $(DOCKER_HOST),,bundles))
64DOCKER_MOUNT := $(if $(BIND_DIR),-v "$(CURDIR)/$(BIND_DIR):/go/src/github.com/docker/docker/$(BIND_DIR)")
65
66# 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.
67# The volume will be cleaned up when the container is removed due to `--rm`.
68# 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.
69DOCKER_MOUNT := $(if $(DOCKER_MOUNT),$(DOCKER_MOUNT),-v /go/src/github.com/docker/docker/bundles) -v $(CURDIR)/.git:/go/src/github.com/docker/docker/.git
70
71# This allows to set the docker-dev container name
72DOCKER_CONTAINER_NAME := $(if $(CONTAINER_NAME),--name $(CONTAINER_NAME),)
73
74# enable package cache if DOCKER_INCREMENTAL_BINARY and DOCKER_MOUNT (i.e.DOCKER_HOST) are set
75PKGCACHE_MAP := gopath:/go/pkg goroot-linux_amd64:/usr/local/go/pkg/linux_amd64 goroot-linux_amd64_netgo:/usr/local/go/pkg/linux_amd64_netgo
76PKGCACHE_VOLROOT := dockerdev-go-pkg-cache
77PKGCACHE_VOL := $(if $(PKGCACHE_DIR),$(CURDIR)/$(PKGCACHE_DIR)/,$(PKGCACHE_VOLROOT)-)
78DOCKER_MOUNT_PKGCACHE := $(if $(DOCKER_INCREMENTAL_BINARY),$(shell echo $(PKGCACHE_MAP) | sed -E 's@([^ ]*)@-v "$(PKGCACHE_VOL)\1"@g'),)
79DOCKER_MOUNT_CLI := $(if $(DOCKER_CLI_PATH),-v $(shell dirname $(DOCKER_CLI_PATH)):/usr/local/cli,)
80DOCKER_MOUNT_BASH_COMPLETION := $(if $(DOCKER_BASH_COMPLETION_PATH),-v $(shell dirname $(DOCKER_BASH_COMPLETION_PATH)):/usr/local/completion/bash,)
81DOCKER_MOUNT := $(DOCKER_MOUNT) $(DOCKER_MOUNT_PKGCACHE) $(DOCKER_MOUNT_CLI) $(DOCKER_MOUNT_BASH_COMPLETION)
82
83GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
84GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
85DOCKER_IMAGE := docker-dev$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))
86DOCKER_PORT_FORWARD := $(if $(DOCKER_PORT),-p "$(DOCKER_PORT)",)
87
88DOCKER_FLAGS := docker run --rm -i --privileged $(DOCKER_CONTAINER_NAME) $(DOCKER_ENVS) $(DOCKER_MOUNT) $(DOCKER_PORT_FORWARD)
89BUILD_APT_MIRROR := $(if $(DOCKER_BUILD_APT_MIRROR),--build-arg APT_MIRROR=$(DOCKER_BUILD_APT_MIRROR))
90export BUILD_APT_MIRROR
91
92SWAGGER_DOCS_PORT ?= 9000
93
94INTEGRATION_CLI_MASTER_IMAGE := $(if $(INTEGRATION_CLI_MASTER_IMAGE), $(INTEGRATION_CLI_MASTER_IMAGE), integration-cli-master)
95INTEGRATION_CLI_WORKER_IMAGE := $(if $(INTEGRATION_CLI_WORKER_IMAGE), $(INTEGRATION_CLI_WORKER_IMAGE), integration-cli-worker)
96
97define \n
98
99
100endef
101
102# if this session isn't interactive, then we don't want to allocate a
103# TTY, which would fail, but if it is interactive, we do want to attach
104# so that the user can send e.g. ^C through.
105INTERACTIVE := $(shell [ -t 0 ] && echo 1 || echo 0)
106ifeq ($(INTERACTIVE), 1)
107	DOCKER_FLAGS += -t
108endif
109
110DOCKER_RUN_DOCKER := $(DOCKER_FLAGS) "$(DOCKER_IMAGE)"
111
112default: binary
113
114all: build ## validate all checks, build linux binaries, run all tests\ncross build non-linux binaries and generate archives
115	$(DOCKER_RUN_DOCKER) bash -c 'hack/validate/default && hack/make.sh'
116
117binary: build ## build the linux binaries
118	$(DOCKER_RUN_DOCKER) hack/make.sh binary
119
120dynbinary: build ## build the linux dynbinaries
121	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary
122
123build: bundles init-go-pkg-cache
124	$(warning The docker client CLI has moved to github.com/docker/cli. For a dev-test cycle involving the CLI, run:${\n} DOCKER_CLI_PATH=/host/path/to/cli/binary make shell ${\n} then change the cli and compile into a binary at the same location.${\n})
125	docker build ${BUILD_APT_MIRROR} ${DOCKER_BUILD_ARGS} -t "$(DOCKER_IMAGE)" -f "$(DOCKERFILE)" .
126
127bundles:
128	mkdir bundles
129
130clean: clean-pkg-cache-vol ## clean up cached resources
131
132clean-pkg-cache-vol:
133	@- $(foreach mapping,$(PKGCACHE_MAP), \
134		$(shell docker volume rm $(PKGCACHE_VOLROOT)-$(shell echo $(mapping) | awk -F':/' '{ print $$1 }') > /dev/null 2>&1) \
135	)
136
137cross: build ## cross build the binaries for darwin, freebsd and\nwindows
138	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary binary cross
139
140deb: build  ## build the deb packages
141	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary build-deb
142
143
144help: ## this help
145	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
146
147init-go-pkg-cache:
148	$(if $(PKGCACHE_DIR), mkdir -p $(shell echo $(PKGCACHE_MAP) | sed -E 's@([^: ]*):[^ ]*@$(PKGCACHE_DIR)/\1@g'))
149
150install: ## install the linux binaries
151	KEEPBUNDLE=1 hack/make.sh install-binary
152
153rpm: build ## build the rpm packages
154	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary build-rpm
155
156run: build ## run the docker daemon in a container
157	$(DOCKER_RUN_DOCKER) sh -c "KEEPBUNDLE=1 hack/make.sh install-binary run"
158
159shell: build ## start a shell inside the build env
160	$(DOCKER_RUN_DOCKER) bash
161
162test: build test-unit ## run the unit, integration and docker-py tests
163	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary cross test-integration test-docker-py
164
165test-docker-py: build ## run the docker-py tests
166	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-docker-py
167
168test-integration-cli: test-integration ## (DEPRECATED) use test-integration
169
170test-integration: build ## run the integration tests
171	$(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration
172
173test-unit: build ## run the unit tests
174	$(DOCKER_RUN_DOCKER) hack/test/unit
175
176validate: build ## validate DCO, Seccomp profile generation, gofmt,\n./pkg/ isolation, golint, tests, tomls, go vet and vendor
177	$(DOCKER_RUN_DOCKER) hack/validate/all
178
179win: build ## cross build the binary for windows
180	$(DOCKER_RUN_DOCKER) hack/make.sh win
181
182.PHONY: swagger-gen
183swagger-gen:
184	docker run --rm -v $(PWD):/go/src/github.com/docker/docker \
185		-w /go/src/github.com/docker/docker \
186		--entrypoint hack/generate-swagger-api.sh \
187		-e GOPATH=/go \
188		quay.io/goswagger/swagger:0.7.4
189
190.PHONY: swagger-docs
191swagger-docs: ## preview the API documentation
192	@echo "API docs preview will be running at http://localhost:$(SWAGGER_DOCS_PORT)"
193	@docker run --rm -v $(PWD)/api/swagger.yaml:/usr/share/nginx/html/swagger.yaml \
194		-e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \
195		-p $(SWAGGER_DOCS_PORT):80 \
196		bfirsh/redoc:1.6.2
197
198build-integration-cli-on-swarm: build ## build images and binary for running integration-cli on Swarm in parallel
199	@echo "Building hack/integration-cli-on-swarm (if build fails, please refer to hack/integration-cli-on-swarm/README.md)"
200	go build -o ./hack/integration-cli-on-swarm/integration-cli-on-swarm ./hack/integration-cli-on-swarm/host
201	@echo "Building $(INTEGRATION_CLI_MASTER_IMAGE)"
202	docker build -t $(INTEGRATION_CLI_MASTER_IMAGE) hack/integration-cli-on-swarm/agent
203# For worker, we don't use `docker build` so as to enable DOCKER_INCREMENTAL_BINARY and so on
204	@echo "Building $(INTEGRATION_CLI_WORKER_IMAGE) from $(DOCKER_IMAGE)"
205	$(eval tmp := integration-cli-worker-tmp)
206# We mount pkgcache, but not bundle (bundle needs to be baked into the image)
207# For avoiding bakings DOCKER_GRAPHDRIVER and so on to image, we cannot use $(DOCKER_ENVS) here
208	docker run -t -d --name $(tmp) -e DOCKER_GITCOMMIT -e BUILDFLAGS -e DOCKER_INCREMENTAL_BINARY --privileged $(DOCKER_MOUNT_PKGCACHE) $(DOCKER_IMAGE) top
209	docker exec $(tmp) hack/make.sh build-integration-test-binary dynbinary
210	docker exec $(tmp) go build -o /worker github.com/docker/docker/hack/integration-cli-on-swarm/agent/worker
211	docker commit -c 'ENTRYPOINT ["/worker"]' $(tmp) $(INTEGRATION_CLI_WORKER_IMAGE)
212	docker rm -f $(tmp)
213