2017-04-25 12:57:06 -04:00
|
|
|
#
|
|
|
|
|
# github.com/docker/cli
|
|
|
|
|
#
|
|
|
|
|
# Makefile for developing using Docker
|
|
|
|
|
#
|
|
|
|
|
|
2017-08-15 16:59:43 -04:00
|
|
|
DEV_DOCKER_IMAGE_NAME = docker-cli-dev$(IMAGE_TAG)
|
2018-01-18 12:53:22 -05:00
|
|
|
BINARY_NATIVE_IMAGE_NAME = docker-cli-native$(IMAGE_TAG)
|
2017-08-15 16:59:43 -04:00
|
|
|
LINTER_IMAGE_NAME = docker-cli-lint$(IMAGE_TAG)
|
|
|
|
|
CROSS_IMAGE_NAME = docker-cli-cross$(IMAGE_TAG)
|
|
|
|
|
VALIDATE_IMAGE_NAME = docker-cli-shell-validate$(IMAGE_TAG)
|
2018-05-17 07:11:59 -04:00
|
|
|
E2E_IMAGE_NAME = docker-cli-e2e$(IMAGE_TAG)
|
2018-12-10 06:30:52 -05:00
|
|
|
GO_BUILD_CACHE ?= y
|
2017-06-21 20:47:40 -04:00
|
|
|
MOUNTS = -v "$(CURDIR)":/go/src/github.com/docker/cli
|
2018-12-10 06:30:52 -05:00
|
|
|
CACHE_VOLUME_NAME := docker-cli-dev-cache
|
|
|
|
|
ifeq ($(GO_BUILD_CACHE),y)
|
|
|
|
|
MOUNTS += -v "$(CACHE_VOLUME_NAME):/root/.cache/go-build"
|
|
|
|
|
endif
|
2017-05-22 16:22:42 -04:00
|
|
|
VERSION = $(shell cat VERSION)
|
2017-12-01 08:47:20 -05:00
|
|
|
ENVVARS = -e VERSION=$(VERSION) -e GITCOMMIT -e PLATFORM
|
2017-04-25 12:57:06 -04:00
|
|
|
|
|
|
|
|
# build docker image (dockerfiles/Dockerfile.build)
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: build_docker_image
|
2017-04-25 12:57:06 -04:00
|
|
|
build_docker_image:
|
Do not patch Dockerfiles in CI
When building the Dockerfiles for development, those images are mainly used to
create a reproducible build-environment. The source code is bind-mounted into
the image at runtime; there is no need to create an image with the actual
source code, and copying the source code into the image would lead to a new
image being created for each code-change (possibly leading up to many "dangling"
images for previous code-changes).
However, when building (and using) the development images in CI, bind-mounting
is not an option, because the daemon is running remotely.
To make this work, the circle-ci script patched the Dockerfiles when CI is run;
adding a `COPY` to the respective Dockerfiles.
Patching Dockerfiles is not really a "best practice" and, even though the source
code does not and up in the image, the source would still be _sent_ to the daemon
for each build (unless BuildKit is used).
This patch updates the makefiles, circle-ci script, and Dockerfiles;
- When building the Dockerfiles locally, pipe the Dockerfile through stdin.
Doing so, prevents the build-context from being sent to the daemon. This speeds
up the build, and doesn't fill up the Docker "temp" directory with content that's
not used
- Now that no content is sent, add the COPY instructions to the Dockerfiles, and
remove the code in the circle-ci script to "live patch" the Dockerfiles.
Before this patch is applied (with cache):
```
$ time make -f docker.Makefile build_shell_validate_image
docker build -t docker-cli-shell-validate -f ./dockerfiles/Dockerfile.shellcheck .
Sending build context to Docker daemon 41MB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
2.75 real 0.45 user 0.56 sys
```
After this patch is applied (with cache)::
```
$ time make -f docker.Makefile build_shell_validate_image
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t docker-cli-shell-validate -
Sending build context to Docker daemon 2.048kB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
0.33 real 0.07 user 0.08 sys
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-28 19:06:10 -05:00
|
|
|
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
|
|
|
|
|
cat ./dockerfiles/Dockerfile.dev | docker build ${DOCKER_BUILD_ARGS} -t $(DEV_DOCKER_IMAGE_NAME) -
|
2017-04-25 12:57:06 -04:00
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
# build docker image having the linting tools (dockerfiles/Dockerfile.lint)
|
|
|
|
|
.PHONY: build_linter_image
|
2017-05-02 15:10:03 -04:00
|
|
|
build_linter_image:
|
Do not patch Dockerfiles in CI
When building the Dockerfiles for development, those images are mainly used to
create a reproducible build-environment. The source code is bind-mounted into
the image at runtime; there is no need to create an image with the actual
source code, and copying the source code into the image would lead to a new
image being created for each code-change (possibly leading up to many "dangling"
images for previous code-changes).
However, when building (and using) the development images in CI, bind-mounting
is not an option, because the daemon is running remotely.
To make this work, the circle-ci script patched the Dockerfiles when CI is run;
adding a `COPY` to the respective Dockerfiles.
Patching Dockerfiles is not really a "best practice" and, even though the source
code does not and up in the image, the source would still be _sent_ to the daemon
for each build (unless BuildKit is used).
This patch updates the makefiles, circle-ci script, and Dockerfiles;
- When building the Dockerfiles locally, pipe the Dockerfile through stdin.
Doing so, prevents the build-context from being sent to the daemon. This speeds
up the build, and doesn't fill up the Docker "temp" directory with content that's
not used
- Now that no content is sent, add the COPY instructions to the Dockerfiles, and
remove the code in the circle-ci script to "live patch" the Dockerfiles.
Before this patch is applied (with cache):
```
$ time make -f docker.Makefile build_shell_validate_image
docker build -t docker-cli-shell-validate -f ./dockerfiles/Dockerfile.shellcheck .
Sending build context to Docker daemon 41MB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
2.75 real 0.45 user 0.56 sys
```
After this patch is applied (with cache)::
```
$ time make -f docker.Makefile build_shell_validate_image
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t docker-cli-shell-validate -
Sending build context to Docker daemon 2.048kB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
0.33 real 0.07 user 0.08 sys
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-28 19:06:10 -05:00
|
|
|
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
|
|
|
|
|
cat ./dockerfiles/Dockerfile.lint | docker build ${DOCKER_BUILD_ARGS} -t $(LINTER_IMAGE_NAME) -
|
2017-05-02 15:10:03 -04:00
|
|
|
|
2017-05-11 18:52:17 -04:00
|
|
|
.PHONY: build_cross_image
|
|
|
|
|
build_cross_image:
|
Do not patch Dockerfiles in CI
When building the Dockerfiles for development, those images are mainly used to
create a reproducible build-environment. The source code is bind-mounted into
the image at runtime; there is no need to create an image with the actual
source code, and copying the source code into the image would lead to a new
image being created for each code-change (possibly leading up to many "dangling"
images for previous code-changes).
However, when building (and using) the development images in CI, bind-mounting
is not an option, because the daemon is running remotely.
To make this work, the circle-ci script patched the Dockerfiles when CI is run;
adding a `COPY` to the respective Dockerfiles.
Patching Dockerfiles is not really a "best practice" and, even though the source
code does not and up in the image, the source would still be _sent_ to the daemon
for each build (unless BuildKit is used).
This patch updates the makefiles, circle-ci script, and Dockerfiles;
- When building the Dockerfiles locally, pipe the Dockerfile through stdin.
Doing so, prevents the build-context from being sent to the daemon. This speeds
up the build, and doesn't fill up the Docker "temp" directory with content that's
not used
- Now that no content is sent, add the COPY instructions to the Dockerfiles, and
remove the code in the circle-ci script to "live patch" the Dockerfiles.
Before this patch is applied (with cache):
```
$ time make -f docker.Makefile build_shell_validate_image
docker build -t docker-cli-shell-validate -f ./dockerfiles/Dockerfile.shellcheck .
Sending build context to Docker daemon 41MB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
2.75 real 0.45 user 0.56 sys
```
After this patch is applied (with cache)::
```
$ time make -f docker.Makefile build_shell_validate_image
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t docker-cli-shell-validate -
Sending build context to Docker daemon 2.048kB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
0.33 real 0.07 user 0.08 sys
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-28 19:06:10 -05:00
|
|
|
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
|
|
|
|
|
cat ./dockerfiles/Dockerfile.cross | docker build ${DOCKER_BUILD_ARGS} -t $(CROSS_IMAGE_NAME) -
|
2017-05-11 18:52:17 -04:00
|
|
|
|
2017-06-29 17:32:01 -04:00
|
|
|
.PHONY: build_shell_validate_image
|
|
|
|
|
build_shell_validate_image:
|
Do not patch Dockerfiles in CI
When building the Dockerfiles for development, those images are mainly used to
create a reproducible build-environment. The source code is bind-mounted into
the image at runtime; there is no need to create an image with the actual
source code, and copying the source code into the image would lead to a new
image being created for each code-change (possibly leading up to many "dangling"
images for previous code-changes).
However, when building (and using) the development images in CI, bind-mounting
is not an option, because the daemon is running remotely.
To make this work, the circle-ci script patched the Dockerfiles when CI is run;
adding a `COPY` to the respective Dockerfiles.
Patching Dockerfiles is not really a "best practice" and, even though the source
code does not and up in the image, the source would still be _sent_ to the daemon
for each build (unless BuildKit is used).
This patch updates the makefiles, circle-ci script, and Dockerfiles;
- When building the Dockerfiles locally, pipe the Dockerfile through stdin.
Doing so, prevents the build-context from being sent to the daemon. This speeds
up the build, and doesn't fill up the Docker "temp" directory with content that's
not used
- Now that no content is sent, add the COPY instructions to the Dockerfiles, and
remove the code in the circle-ci script to "live patch" the Dockerfiles.
Before this patch is applied (with cache):
```
$ time make -f docker.Makefile build_shell_validate_image
docker build -t docker-cli-shell-validate -f ./dockerfiles/Dockerfile.shellcheck .
Sending build context to Docker daemon 41MB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
2.75 real 0.45 user 0.56 sys
```
After this patch is applied (with cache)::
```
$ time make -f docker.Makefile build_shell_validate_image
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t docker-cli-shell-validate -
Sending build context to Docker daemon 2.048kB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
0.33 real 0.07 user 0.08 sys
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-28 19:06:10 -05:00
|
|
|
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
|
|
|
|
|
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t $(VALIDATE_IMAGE_NAME) -
|
2017-05-11 18:52:17 -04:00
|
|
|
|
2018-01-18 12:53:22 -05:00
|
|
|
.PHONY: build_binary_native_image
|
|
|
|
|
build_binary_native_image:
|
Do not patch Dockerfiles in CI
When building the Dockerfiles for development, those images are mainly used to
create a reproducible build-environment. The source code is bind-mounted into
the image at runtime; there is no need to create an image with the actual
source code, and copying the source code into the image would lead to a new
image being created for each code-change (possibly leading up to many "dangling"
images for previous code-changes).
However, when building (and using) the development images in CI, bind-mounting
is not an option, because the daemon is running remotely.
To make this work, the circle-ci script patched the Dockerfiles when CI is run;
adding a `COPY` to the respective Dockerfiles.
Patching Dockerfiles is not really a "best practice" and, even though the source
code does not and up in the image, the source would still be _sent_ to the daemon
for each build (unless BuildKit is used).
This patch updates the makefiles, circle-ci script, and Dockerfiles;
- When building the Dockerfiles locally, pipe the Dockerfile through stdin.
Doing so, prevents the build-context from being sent to the daemon. This speeds
up the build, and doesn't fill up the Docker "temp" directory with content that's
not used
- Now that no content is sent, add the COPY instructions to the Dockerfiles, and
remove the code in the circle-ci script to "live patch" the Dockerfiles.
Before this patch is applied (with cache):
```
$ time make -f docker.Makefile build_shell_validate_image
docker build -t docker-cli-shell-validate -f ./dockerfiles/Dockerfile.shellcheck .
Sending build context to Docker daemon 41MB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
2.75 real 0.45 user 0.56 sys
```
After this patch is applied (with cache)::
```
$ time make -f docker.Makefile build_shell_validate_image
cat ./dockerfiles/Dockerfile.shellcheck | docker build -t docker-cli-shell-validate -
Sending build context to Docker daemon 2.048kB
Step 1/2 : FROM debian:stretch-slim
...
Successfully built 81e14e8ad856
Successfully tagged docker-cli-shell-validate:latest
0.33 real 0.07 user 0.08 sys
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-28 19:06:10 -05:00
|
|
|
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
|
|
|
|
|
cat ./dockerfiles/Dockerfile.binary-native | docker build -t $(BINARY_NATIVE_IMAGE_NAME) -
|
2018-01-18 12:53:22 -05:00
|
|
|
|
2018-05-17 07:11:59 -04:00
|
|
|
.PHONY: build_e2e_image
|
|
|
|
|
build_e2e_image:
|
|
|
|
|
docker build -t $(E2E_IMAGE_NAME) --build-arg VERSION=$(VERSION) --build-arg GITCOMMIT=$(GITCOMMIT) -f ./dockerfiles/Dockerfile.e2e .
|
|
|
|
|
|
2018-01-18 12:53:22 -05:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
binary: build_binary_native_image ## build the CLI
|
2018-01-18 12:53:22 -05:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(BINARY_NATIVE_IMAGE_NAME)
|
2017-05-12 12:07:57 -04:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
build: binary ## alias for binary
|
2017-04-25 12:57:06 -04:00
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: clean
|
2018-07-31 07:15:41 -04:00
|
|
|
clean: build_docker_image ## clean build artifacts
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make clean
|
2018-12-10 06:30:52 -05:00
|
|
|
docker volume rm -f $(CACHE_VOLUME_NAME)
|
2017-04-25 12:57:06 -04:00
|
|
|
|
2017-08-14 15:47:06 -04:00
|
|
|
.PHONY: test-unit
|
2018-07-31 07:15:41 -04:00
|
|
|
test-unit: build_docker_image # run unit tests (using go test)
|
2017-08-14 15:47:06 -04:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make test-unit
|
2017-04-27 18:57:35 -04:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
.PHONY: test ## run unit and e2e tests
|
2017-08-30 18:06:22 -04:00
|
|
|
test: test-unit test-e2e
|
|
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: cross
|
2018-07-31 07:15:41 -04:00
|
|
|
cross: build_cross_image ## build the CLI for macOS and Windows
|
2017-05-24 13:26:53 -04:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(CROSS_IMAGE_NAME) make cross
|
2017-04-25 12:57:06 -04:00
|
|
|
|
2017-09-13 18:51:30 -04:00
|
|
|
.PHONY: binary-windows
|
2018-07-31 07:15:41 -04:00
|
|
|
binary-windows: build_cross_image ## build the CLI for Windows
|
2017-09-13 18:51:30 -04:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(CROSS_IMAGE_NAME) make $@
|
|
|
|
|
|
|
|
|
|
.PHONY: binary-osx
|
2018-07-31 07:15:41 -04:00
|
|
|
binary-osx: build_cross_image ## build the CLI for macOS
|
2017-09-13 18:51:30 -04:00
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(CROSS_IMAGE_NAME) make $@
|
|
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: dev
|
2018-07-31 07:15:41 -04:00
|
|
|
dev: build_docker_image ## start a build container in interactive mode for in-container development
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti $(ENVVARS) $(MOUNTS) \
|
|
|
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
|
|
|
$(DEV_DOCKER_IMAGE_NAME) ash
|
2017-05-02 15:10:03 -04:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
shell: dev ## alias for dev
|
2017-05-11 18:52:17 -04:00
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: lint
|
2018-07-31 07:15:41 -04:00
|
|
|
lint: build_linter_image ## run linters
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti $(ENVVARS) $(MOUNTS) $(LINTER_IMAGE_NAME)
|
2017-05-09 17:29:14 -04:00
|
|
|
|
2018-12-10 08:17:14 -05:00
|
|
|
.PHONY: fmt
|
|
|
|
|
fmt:
|
|
|
|
|
docker run --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make fmt
|
|
|
|
|
|
2017-05-09 17:29:14 -04:00
|
|
|
.PHONY: vendor
|
2018-07-31 07:15:41 -04:00
|
|
|
vendor: build_docker_image vendor.conf ## download dependencies (vendor/) listed in vendor.conf
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make vendor
|
2017-05-11 18:52:17 -04:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
dynbinary: build_cross_image ## build the CLI dynamically linked
|
2017-05-10 21:24:32 -04:00
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(CROSS_IMAGE_NAME) make dynbinary
|
|
|
|
|
|
2018-01-02 09:47:31 -05:00
|
|
|
.PHONY: authors
|
|
|
|
|
authors: ## generate AUTHORS file from git history
|
|
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make authors
|
|
|
|
|
|
2017-05-10 21:24:32 -04:00
|
|
|
.PHONY: manpages
|
2018-07-31 07:15:41 -04:00
|
|
|
manpages: build_docker_image ## generate man pages from go source and markdown
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make manpages
|
2017-05-10 21:24:32 -04:00
|
|
|
|
|
|
|
|
.PHONY: yamldocs
|
2018-07-31 07:15:41 -04:00
|
|
|
yamldocs: build_docker_image ## generate documentation YAML files consumed by docs repo
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(DEV_DOCKER_IMAGE_NAME) make yamldocs
|
2017-06-29 09:10:04 -04:00
|
|
|
|
|
|
|
|
.PHONY: shellcheck
|
2018-07-31 07:15:41 -04:00
|
|
|
shellcheck: build_shell_validate_image ## run shellcheck validation
|
2017-06-23 00:52:34 -04:00
|
|
|
docker run -ti --rm $(ENVVARS) $(MOUNTS) $(VALIDATE_IMAGE_NAME) make shellcheck
|
2017-08-14 15:47:06 -04:00
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
.PHONY: test-e2e ## run e2e tests
|
2018-09-06 01:38:01 -04:00
|
|
|
test-e2e: test-e2e-non-experimental test-e2e-experimental test-e2e-connhelper-ssh
|
2018-06-25 05:46:35 -04:00
|
|
|
|
|
|
|
|
.PHONY: test-e2e-experimental
|
|
|
|
|
test-e2e-experimental: build_e2e_image
|
|
|
|
|
docker run -e DOCKERD_EXPERIMENTAL=1 --rm -v /var/run/docker.sock:/var/run/docker.sock $(E2E_IMAGE_NAME)
|
|
|
|
|
|
|
|
|
|
.PHONY: test-e2e-non-experimental
|
|
|
|
|
test-e2e-non-experimental: build_e2e_image
|
2018-05-17 07:11:59 -04:00
|
|
|
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock $(E2E_IMAGE_NAME)
|
2018-07-31 07:15:41 -04:00
|
|
|
|
2018-09-06 01:38:01 -04:00
|
|
|
.PHONY: test-e2e-connhelper-ssh
|
|
|
|
|
test-e2e-connhelper-ssh: build_e2e_image
|
|
|
|
|
docker run -e TEST_CONNHELPER=ssh -e DOCKERD_EXPERIMENTAL=1 --rm -v /var/run/docker.sock:/var/run/docker.sock $(E2E_IMAGE_NAME)
|
|
|
|
|
|
2018-07-31 07:15:41 -04:00
|
|
|
.PHONY: help
|
|
|
|
|
help: ## print this help
|
|
|
|
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
|
