Makefile

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