github.com/rawahars/moby@v24.0.4+incompatible/Makefile (about) 1 .PHONY: all binary dynbinary build cross help install manpages run shell test test-docker-py test-integration test-unit validate validate-% win 2 3 DOCKER ?= docker 4 BUILDX ?= $(DOCKER) buildx 5 6 # set the graph driver as the current graphdriver if not set 7 DOCKER_GRAPHDRIVER := $(if $(DOCKER_GRAPHDRIVER),$(DOCKER_GRAPHDRIVER),$(shell docker info 2>&1 | grep "Storage Driver" | sed 's/.*: //')) 8 export DOCKER_GRAPHDRIVER 9 10 # get OS/Arch of docker engine 11 DOCKER_OSARCH := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKER_ENGINE_OSARCH}') 12 DOCKERFILE := $(shell bash -c 'source hack/make/.detect-daemon-osarch && echo $${DOCKERFILE}') 13 14 DOCKER_GITCOMMIT := $(shell git rev-parse --short HEAD || echo unsupported) 15 export DOCKER_GITCOMMIT 16 17 # allow overriding the repository and branch that validation scripts are running 18 # against these are used in hack/validate/.validate to check what changed in the PR. 19 export VALIDATE_REPO 20 export VALIDATE_BRANCH 21 export VALIDATE_ORIGIN_BRANCH 22 23 # env vars passed through directly to Docker's build scripts 24 # to allow things like `make KEEPBUNDLE=1 binary` easily 25 # `project/PACKAGERS.md` have some limited documentation of some of these 26 # 27 # DOCKER_LDFLAGS can be used to pass additional parameters to -ldflags 28 # option of "go build". For example, a built-in graphdriver priority list 29 # can be changed during build time like this: 30 # 31 # make DOCKER_LDFLAGS="-X github.com/docker/docker/daemon/graphdriver.priority=overlay2,devicemapper" dynbinary 32 # 33 DOCKER_ENVS := \ 34 -e BUILD_APT_MIRROR \ 35 -e BUILDFLAGS \ 36 -e KEEPBUNDLE \ 37 -e DOCKER_BUILD_ARGS \ 38 -e DOCKER_BUILD_GOGC \ 39 -e DOCKER_BUILD_OPTS \ 40 -e DOCKER_BUILD_PKGS \ 41 -e DOCKER_BUILDKIT \ 42 -e DOCKER_BASH_COMPLETION_PATH \ 43 -e DOCKER_CLI_PATH \ 44 -e DOCKERCLI_VERSION \ 45 -e DOCKERCLI_REPOSITORY \ 46 -e DOCKERCLI_INTEGRATION_VERSION \ 47 -e DOCKERCLI_INTEGRATION_REPOSITORY \ 48 -e DOCKER_DEBUG \ 49 -e DOCKER_EXPERIMENTAL \ 50 -e DOCKER_GITCOMMIT \ 51 -e DOCKER_GRAPHDRIVER \ 52 -e DOCKER_LDFLAGS \ 53 -e DOCKER_PORT \ 54 -e DOCKER_REMAP_ROOT \ 55 -e DOCKER_ROOTLESS \ 56 -e DOCKER_STORAGE_OPTS \ 57 -e DOCKER_TEST_HOST \ 58 -e DOCKER_USERLANDPROXY \ 59 -e DOCKERD_ARGS \ 60 -e DELVE_PORT \ 61 -e GITHUB_ACTIONS \ 62 -e TEST_FORCE_VALIDATE \ 63 -e TEST_INTEGRATION_DIR \ 64 -e TEST_INTEGRATION_USE_SNAPSHOTTER \ 65 -e TEST_SKIP_INTEGRATION \ 66 -e TEST_SKIP_INTEGRATION_CLI \ 67 -e TESTCOVERAGE \ 68 -e TESTDEBUG \ 69 -e TESTDIRS \ 70 -e TESTFLAGS \ 71 -e TESTFLAGS_INTEGRATION \ 72 -e TESTFLAGS_INTEGRATION_CLI \ 73 -e TEST_FILTER \ 74 -e TIMEOUT \ 75 -e VALIDATE_REPO \ 76 -e VALIDATE_BRANCH \ 77 -e VALIDATE_ORIGIN_BRANCH \ 78 -e VERSION \ 79 -e PLATFORM \ 80 -e DEFAULT_PRODUCT_LICENSE \ 81 -e PRODUCT \ 82 -e PACKAGER_NAME 83 # 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 84 85 # to allow `make BIND_DIR=. shell` or `make BIND_DIR= test` 86 # (default to no bind mount if DOCKER_HOST is set) 87 # note: BINDDIR is supported for backwards-compatibility here 88 BIND_DIR := $(if $(BINDDIR),$(BINDDIR),$(if $(DOCKER_HOST),,bundles)) 89 90 # DOCKER_MOUNT can be overriden, but use at your own risk! 91 ifndef DOCKER_MOUNT 92 DOCKER_MOUNT := $(if $(BIND_DIR),-v "$(CURDIR)/$(BIND_DIR):/go/src/github.com/docker/docker/$(BIND_DIR)") 93 DOCKER_MOUNT := $(if $(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT):$(DOCKER_BINDDIR_MOUNT_OPTS),$(DOCKER_MOUNT)) 94 95 # 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. 96 # The volume will be cleaned up when the container is removed due to `--rm`. 97 # 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. 98 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" 99 100 DOCKER_MOUNT_CACHE := -v docker-dev-cache:/root/.cache -v docker-mod-cache:/go/pkg/mod/ 101 DOCKER_MOUNT_CLI := $(if $(DOCKER_CLI_PATH),-v $(shell dirname $(DOCKER_CLI_PATH)):/usr/local/cli,) 102 DOCKER_MOUNT_BASH_COMPLETION := $(if $(DOCKER_BASH_COMPLETION_PATH),-v $(shell dirname $(DOCKER_BASH_COMPLETION_PATH)):/usr/local/completion/bash,) 103 DOCKER_MOUNT := $(DOCKER_MOUNT) $(DOCKER_MOUNT_CACHE) $(DOCKER_MOUNT_CLI) $(DOCKER_MOUNT_BASH_COMPLETION) 104 endif # ifndef DOCKER_MOUNT 105 106 # This allows to set the docker-dev container name 107 DOCKER_CONTAINER_NAME := $(if $(CONTAINER_NAME),--name $(CONTAINER_NAME),) 108 109 DOCKER_IMAGE := docker-dev 110 DOCKER_PORT_FORWARD := $(if $(DOCKER_PORT),-p "$(DOCKER_PORT)",) 111 DELVE_PORT_FORWARD := $(if $(DELVE_PORT),-p "$(DELVE_PORT)",) 112 113 DOCKER_FLAGS := $(DOCKER) run --rm --privileged $(DOCKER_CONTAINER_NAME) $(DOCKER_ENVS) $(DOCKER_MOUNT) $(DOCKER_PORT_FORWARD) $(DELVE_PORT_FORWARD) 114 BUILD_APT_MIRROR := $(if $(DOCKER_BUILD_APT_MIRROR),--build-arg APT_MIRROR=$(DOCKER_BUILD_APT_MIRROR)) 115 export BUILD_APT_MIRROR 116 117 SWAGGER_DOCS_PORT ?= 9000 118 119 define \n 120 121 122 endef 123 124 # if this session isn't interactive, then we don't want to allocate a 125 # TTY, which would fail, but if it is interactive, we do want to attach 126 # so that the user can send e.g. ^C through. 127 INTERACTIVE := $(shell [ -t 0 ] && echo 1 || echo 0) 128 ifeq ($(INTERACTIVE), 1) 129 DOCKER_FLAGS += -t 130 endif 131 132 # on GitHub Runners input device is not a TTY but we allocate a pseudo-one, 133 # otherwise keep STDIN open even if not attached if not a GitHub Runner. 134 ifeq ($(GITHUB_ACTIONS),true) 135 DOCKER_FLAGS += -t 136 else 137 DOCKER_FLAGS += -i 138 endif 139 140 DOCKER_RUN_DOCKER := $(DOCKER_FLAGS) "$(DOCKER_IMAGE)" 141 142 DOCKER_BUILD_ARGS += --build-arg=GO_VERSION 143 DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_VERSION 144 DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_REPOSITORY 145 DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_INTEGRATION_VERSION 146 DOCKER_BUILD_ARGS += --build-arg=DOCKERCLI_INTEGRATION_REPOSITORY 147 ifdef DOCKER_SYSTEMD 148 DOCKER_BUILD_ARGS += --build-arg=SYSTEMD=true 149 endif 150 151 BUILD_OPTS := ${BUILD_APT_MIRROR} ${DOCKER_BUILD_ARGS} ${DOCKER_BUILD_OPTS} -f "$(DOCKERFILE)" 152 BUILD_CMD := $(BUILDX) build 153 BAKE_CMD := $(BUILDX) bake 154 155 default: binary 156 157 all: build ## validate all checks, build linux binaries, run all tests,\ncross build non-linux binaries, and generate archives 158 $(DOCKER_RUN_DOCKER) bash -c 'hack/validate/default && hack/make.sh' 159 160 binary: bundles ## build statically linked linux binaries 161 $(BAKE_CMD) binary 162 163 dynbinary: bundles ## build dynamically linked linux binaries 164 $(BAKE_CMD) dynbinary 165 166 cross: bundles ## cross build the binaries 167 $(BAKE_CMD) binary-cross 168 169 bundles: 170 mkdir bundles 171 172 .PHONY: clean 173 clean: clean-cache 174 175 .PHONY: clean-cache 176 clean-cache: ## remove the docker volumes that are used for caching in the dev-container 177 docker volume rm -f docker-dev-cache docker-mod-cache 178 179 help: ## this help 180 @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) 181 182 install: ## install the linux binaries 183 KEEPBUNDLE=1 hack/make.sh install-binary 184 185 run: build ## run the docker daemon in a container 186 $(DOCKER_RUN_DOCKER) sh -c "KEEPBUNDLE=1 hack/make.sh install-binary run" 187 188 .PHONY: build 189 ifeq ($(BIND_DIR), .) 190 build: shell_target := --target=dev-base 191 else 192 build: shell_target := --target=dev 193 endif 194 build: bundles 195 $(BUILD_CMD) $(BUILD_OPTS) $(shell_target) --load -t "$(DOCKER_IMAGE)" . 196 197 shell: build ## start a shell inside the build env 198 $(DOCKER_RUN_DOCKER) bash 199 200 test: build test-unit ## run the unit, integration and docker-py tests 201 $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration test-docker-py 202 203 test-docker-py: build ## run the docker-py tests 204 $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-docker-py 205 206 test-integration-cli: test-integration ## (DEPRECATED) use test-integration 207 208 ifneq ($(and $(TEST_SKIP_INTEGRATION),$(TEST_SKIP_INTEGRATION_CLI)),) 209 test-integration: 210 @echo Both integrations suites skipped per environment variables 211 else 212 test-integration: build ## run the integration tests 213 $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration 214 endif 215 216 test-integration-flaky: build ## run the stress test for all new integration tests 217 $(DOCKER_RUN_DOCKER) hack/make.sh dynbinary test-integration-flaky 218 219 test-unit: build ## run the unit tests 220 $(DOCKER_RUN_DOCKER) hack/test/unit 221 222 validate: build ## validate DCO, Seccomp profile generation, gofmt,\n./pkg/ isolation, golint, tests, tomls, go vet and vendor 223 $(DOCKER_RUN_DOCKER) hack/validate/all 224 225 validate-%: build ## validate specific check 226 $(DOCKER_RUN_DOCKER) hack/validate/$* 227 228 win: bundles ## cross build the binary for windows 229 $(BAKE_CMD) --set *.platform=windows/amd64 binary 230 231 .PHONY: swagger-gen 232 swagger-gen: 233 docker run --rm -v $(PWD):/go/src/github.com/docker/docker \ 234 -w /go/src/github.com/docker/docker \ 235 --entrypoint hack/generate-swagger-api.sh \ 236 -e GOPATH=/go \ 237 quay.io/goswagger/swagger:0.7.4 238 239 .PHONY: swagger-docs 240 swagger-docs: ## preview the API documentation 241 @echo "API docs preview will be running at http://localhost:$(SWAGGER_DOCS_PORT)" 242 @docker run --rm -v $(PWD)/api/swagger.yaml:/usr/share/nginx/html/swagger.yaml \ 243 -e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \ 244 -p $(SWAGGER_DOCS_PORT):80 \ 245 bfirsh/redoc:1.14.0