docker
/
cli
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
cli/docker.Makefile

127 строки
4.6 KiB
Plaintext
Исходник Обычный вид История

add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
#
# github.com/docker/cli
#
# Makefile for developing using Docker
#
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
# Overridable env vars
DOCKER_CLI_MOUNTS ?= -v "$(CURDIR)":/go/src/github.com/docker/cli
DOCKER_CLI_CONTAINER_NAME ?=
DOCKER_CLI_GO_BUILD_CACHE ?= y
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 17:54:09 +03:00
# Sets the name of the company that produced the windows binary.
COMPANY_NAME ?=
Add a Jenkinsfile Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-08-15 23:59:43 +03:00
DEV_DOCKER_IMAGE_NAME = docker-cli-dev$(IMAGE_TAG)
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
E2E_IMAGE_NAME = docker-cli-e2e
Add a new Makefile variable to override DockerInDocker engine version we use to run e2e tests Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
2020-05-19 19:38:19 +03:00
E2E_ENGINE_VERSION ?=
Use a go build cache to speed up builds. With a docker build cache already primed with the build image I am seeing `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=n` takes more than 1 minute. By contrast `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=y` takes less than 10s with a hot cache irrespective of whether the source tree has changed Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 14:30:52 +03:00
CACHE_VOLUME_NAME := docker-cli-dev-cache
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
ifeq ($(DOCKER_CLI_GO_BUILD_CACHE),y)
DOCKER_CLI_MOUNTS += -v "$(CACHE_VOLUME_NAME):/root/.cache/go-build"
Use a go build cache to speed up builds. With a docker build cache already primed with the build image I am seeing `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=n` takes more than 1 minute. By contrast `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=y` takes less than 10s with a hot cache irrespective of whether the source tree has changed Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 14:30:52 +03:00
endif
allow version number to be set in builds Signed-off-by: Andrew Hsu <andrewhsu@docker.com>
2017-05-22 23:22:42 +03:00
VERSION = $(shell cat VERSION)
Add a new Makefile variable to override DockerInDocker engine version we use to run e2e tests Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
2020-05-19 19:38:19 +03:00
ENVVARS = -e VERSION=$(VERSION) -e GITCOMMIT -e PLATFORM -e TESTFLAGS -e TESTDIRS -e GOOS -e GOARCH -e GOARM -e TEST_ENGINE_VERSION=$(E2E_ENGINE_VERSION)
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
Fix make -f docker.Makefile without buildkit enabled Commit 01cd748eb6eec123d50637b7b1c835755392717e started using Dockerfile features that are currently only supported with buildkit enabled. While we enabled buildkit in our Jenkinsfile, the makefile did not do the same, causing some targets to fail if buildkit was not enabled. This patch updates the makefile to enable buildkit. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-24 14:01:42 +03:00
# Some Dockerfiles use features that are only supported with BuildKit enabled
export DOCKER_BUILDKIT=1
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
# build docker image (dockerfiles/Dockerfile.build)
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
.PHONY: build_docker_image
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03: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-29 03:06:10 +03:00
# build dockerfile from stdin so that we don't send the build-context; source is bind-mounted in the development environment
Dockerfile: use GO_VERSION build-arg for overriding Go version This allows overriding the version of Go without making modifications in the source code, which can be useful to test against multiple versions. For example: make GO_VERSION=1.13beta1 -f docker.Makefile binary Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-07-18 12:13:45 +03:00
cat ./dockerfiles/Dockerfile.dev | docker build ${DOCKER_BUILD_ARGS} --build-arg=GO_VERSION -t $(DEV_DOCKER_IMAGE_NAME) -
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
DOCKER_RUN_NAME_OPTION := $(if $(DOCKER_CLI_CONTAINER_NAME),--name $(DOCKER_CLI_CONTAINER_NAME),)
DOCKER_RUN := docker run --rm $(ENVVARS) $(DOCKER_CLI_MOUNTS) $(DOCKER_RUN_NAME_OPTION)
Add dockerfile for building on non-amd64 platforms Signed-off-by: Daniel Nephin <dnephin@docker.com>
2018-01-18 20:53:22 +03:00
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 19:01:38 +03:00
.PHONY: binary
binary:
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 17:54:09 +03:00
COMPANY_NAME=$(COMPANY_NAME) docker buildx bake binary
osx cross Fix CI build Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-12 19:07:57 +03:00
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
build: binary ## alias for binary
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
plugins: ## build the CLI plugin examples
docker buildx bake plugins
plugins-cross: ## build the CLI plugin examples for all platforms
docker buildx bake plugins-cross
Add basic framework for writing a CLI plugin That is, the helper to be used from the plugin's `main`. Also add a `helloworld` plugin example and build integration. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 18:30:19 +03:00
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
.PHONY: clean
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
clean: build_docker_image ## clean build artifacts
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) $(DEV_DOCKER_IMAGE_NAME) make clean
Use a go build cache to speed up builds. With a docker build cache already primed with the build image I am seeing `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=n` takes more than 1 minute. By contrast `time make build -f docker.Makefile DOCKER_BUILDKIT=1 GO_BUILD_CACHE=y` takes less than 10s with a hot cache irrespective of whether the source tree has changed Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 14:30:52 +03:00
docker volume rm -f $(CACHE_VOLUME_NAME)
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 19:57:06 +03:00
Add scripts for setting up e2e test environment. Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-08-14 22:47:06 +03:00
.PHONY: test-unit
Fix some missing targets in "make help" The `make help` output was missing some targets (`fmt`, `test-unit`, `test-e2e`). Note that some targets are still hidden (`test-e2e-experimental`, `test-e2e-non-experimental`, `test-e2e-connhelper-ssh`) as they're likely not usually run separate from `test-e2e`. Before this patch: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation help print this help With this patch applied: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts test-unit run unit tests (using go test) cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters fmt run gofmt vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation test-e2e run all e2e tests help print this help Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-07 19:32:56 +03:00
test-unit: build_docker_image ## run unit tests (using go test)
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) $(DEV_DOCKER_IMAGE_NAME) make test-unit
add “test” target and make CI use it Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-28 01:57:35 +03:00
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
.PHONY: test ## run unit and e2e tests
Re-adds test target to the Makefile The test target existed before, this is to provide a legacy interface to allow easy testing for downstream Docker CE. Without this we would need separate Makefiles/Jenkinsfiles for releases past 17.07. Later on this target could also be used to test both unit tests and integration tests at the same time. Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>
2017-08-31 01:06:22 +03:00
test: test-unit test-e2e
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 19:01:38 +03:00
.PHONY: cross
cross:
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 17:54:09 +03:00
COMPANY_NAME=$(COMPANY_NAME) docker buildx bake cross
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 19:01:38 +03:00
.PHONY: dynbinary
dynbinary: ## build dynamically linked binary
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 17:54:09 +03:00
USE_GLIBC=1 COMPANY_NAME=$(COMPANY_NAME) docker buildx bake dynbinary
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 19:01:38 +03:00
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
.PHONY: dev
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
dev: build_docker_image ## start a build container in interactive mode for in-container development
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) -it \
Makefile: use --mount instead of -v for docker socket The shorthand `-v` will auto-create the host-path as a directory if the socket is not yet up, instead of failing the container. To prevent accidental creation of `/var/run/docker.sock` as a directory, use the `--mount` flag instead, which does not auto-create host-paths. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-28 14:34:20 +03:00
--mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock \
Dockerfile: use bash as default command, remove DOCKER_CLI_SHELL Bash is installed already, so we might as well use it as a default. This also removes the DOCKER_CLI_SHELL variable, which was added in b039db985a4b834f97679a8975f09ba265e9fd99 to allow using bash instead of (a)sh. Now that Bash is the default, there should be no need to override, and we can keep things simple. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-28 14:19:09 +03:00
$(DEV_DOCKER_IMAGE_NAME)
Add gometalinter to CI Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-02 22:10:03 +03:00
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
shell: dev ## alias for dev
Support building a dynbinary Cleanup dynbinary and binary builds Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-12 01:52:17 +03:00
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
.PHONY: lint
GitHub Actions for lint Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-08-05 09:44:16 +03:00
lint: ## run linters
docker buildx bake lint
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 19:01:38 +03:00
.PHONY: shellcheck
shellcheck: ## run shellcheck validation
docker buildx bake shellcheck
build: Add a `fmt` target which runs `gofmt` on all files. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 16:17:14 +03:00
.PHONY: fmt
Fix some missing targets in "make help" The `make help` output was missing some targets (`fmt`, `test-unit`, `test-e2e`). Note that some targets are still hidden (`test-e2e-experimental`, `test-e2e-non-experimental`, `test-e2e-connhelper-ssh`) as they're likely not usually run separate from `test-e2e`. Before this patch: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation help print this help With this patch applied: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts test-unit run unit tests (using go test) cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters fmt run gofmt vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation test-e2e run all e2e tests help print this help Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-07 19:32:56 +03:00
fmt: ## run gofmt
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) $(DEV_DOCKER_IMAGE_NAME) make fmt
build: Add a `fmt` target which runs `gofmt` on all files. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 16:17:14 +03:00
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-10 00:29:14 +03:00
.PHONY: vendor
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
vendor: build_docker_image vendor.conf ## download dependencies (vendor/) listed in vendor.conf
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make vendor
Support building a dynbinary Cleanup dynbinary and binary builds Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-12 01:52:17 +03:00
Add AUTHORS file and script Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-01-02 17:47:31 +03:00
.PHONY: authors
authors: ## generate AUTHORS file from git history
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make authors
Add AUTHORS file and script Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-01-02 17:47:31 +03:00
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-11 04:24:32 +03:00
.PHONY: manpages
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
manpages: build_docker_image ## generate man pages from go source and markdown
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make manpages
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-11 04:24:32 +03:00
.PHONY: yamldocs
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
yamldocs: build_docker_image ## generate documentation YAML files consumed by docs repo
Make it possible to override the volume mounts and shell for the dev container Through the `DOCKER_CLI_MOUNTS` and `DOCKER_CLI_SHELL` env variables. Also allows setting the dev container name through the `DOCKER_CLI_CONTAINER_NAME` env var. The motivation for allowing overriding the volume mounts is the same as for moby/moby#37845, namely that I/O perf on native mounted disks on non-Linux (notably Mac OS) is just terrible, thus making it a real pain to develop: one has to choose between re-building the image after every single change (eg to run a test) or just work directly inside the same container (eg with vim, but even then one would have to re-configure their dev container every time it gets destroyed - containers, after all, are not supposed to be long-lived). Allowing to override DOCKER_CLI_MOUNTS makes it easy for everyone to decide what their volume/syncing strategy is; for example one can choose to use [docker-sync](https://github.com/EugenMayer/docker-sync). As for the shell, it's nice to be able to use bash instead of the more bare-bones `ash` if preferred. Finally, being able to name the container can come in handy for easier scripting on the host. This patch won't change anything for anyone who doesn't set these env variables in their environment. Signed-off-by: Jean Rouge <rougej+github@gmail.com>
2019-01-14 21:40:30 +03:00
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make yamldocs
Add shellcheck for bash completion Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-06-29 16:10:04 +03:00
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
.PHONY: build-e2e-image
build-e2e-image:
IMAGE_NAME=$(E2E_IMAGE_NAME) VERSION=$(VERSION) docker buildx bake e2e-image
Fix some missing targets in "make help" The `make help` output was missing some targets (`fmt`, `test-unit`, `test-e2e`). Note that some targets are still hidden (`test-e2e-experimental`, `test-e2e-non-experimental`, `test-e2e-connhelper-ssh`) as they're likely not usually run separate from `test-e2e`. Before this patch: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation help print this help With this patch applied: make -f docker.Makefile help binary build the CLI build alias for binary clean clean build artifacts test-unit run unit tests (using go test) cross build the CLI for macOS and Windows binary-windows build the CLI for Windows binary-osx build the CLI for macOS dev start a build container in interactive mode for in-container development shell alias for dev lint run linters fmt run gofmt vendor download dependencies (vendor/) listed in vendor.conf dynbinary build the CLI dynamically linked authors generate AUTHORS file from git history manpages generate man pages from go source and markdown yamldocs generate documentation YAML files consumed by docs repo shellcheck run shellcheck validation test-e2e run all e2e tests help print this help Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-07 19:32:56 +03:00
.PHONY: test-e2e
test-e2e: test-e2e-non-experimental test-e2e-experimental test-e2e-connhelper-ssh ## run all e2e tests
Make test-e2e run against experimental and non-experimental daemon - `make test-e2e` runs the e2e tests twice : once against on non-experimental daemon (as before), once against an experimental daemon. - adds `test-e2e-experimental` and `test-e2e-non-experimental` target to run tests for the specified cases Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2018-06-25 12:46:35 +03:00
.PHONY: test-e2e-experimental
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
test-e2e-experimental: build-e2e-image # run experimental e2e tests
docker run --rm --mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock $(ENVVARS) -e DOCKERD_EXPERIMENTAL=1 -e TEST_ENGINE_VERSION=$(E2E_ENGINE_VERSION) $(E2E_IMAGE_NAME)
Make test-e2e run against experimental and non-experimental daemon - `make test-e2e` runs the e2e tests twice : once against on non-experimental daemon (as before), once against an experimental daemon. - adds `test-e2e-experimental` and `test-e2e-non-experimental` target to run tests for the specified cases Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2018-06-25 12:46:35 +03:00
.PHONY: test-e2e-non-experimental
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
test-e2e-non-experimental: build-e2e-image # run non-experimental e2e tests
Makefile: use --mount instead of -v for docker socket The shorthand `-v` will auto-create the host-path as a directory if the socket is not yet up, instead of failing the container. To prevent accidental creation of `/var/run/docker.sock` as a directory, use the `--mount` flag instead, which does not auto-create host-paths. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-28 14:34:20 +03:00
docker run --rm --mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock $(ENVVARS) -e TEST_ENGINE_VERSION=$(E2E_ENGINE_VERSION) $(E2E_IMAGE_NAME)
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
connhelper: add e2e Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-09-06 08:38:01 +03:00
.PHONY: test-e2e-connhelper-ssh
GitHub Actions e2e tests Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-11-17 19:18:15 +03:00
test-e2e-connhelper-ssh: build-e2e-image # run experimental SSH-connection helper e2e tests
docker run --rm --mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock $(ENVVARS) -e DOCKERD_EXPERIMENTAL=1 -e TEST_ENGINE_VERSION=$(E2E_ENGINE_VERSION) -e TEST_CONNHELPER=ssh $(E2E_IMAGE_NAME)
connhelper: add e2e Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-09-06 08:38:01 +03:00
Add `help` and remove `watch` targets in docker.Makefile * Add the `help` target to document make targets when building using a container * Remove the `watch` target (filewatcher was removed with c0588a9c) from docker.Makefile and Makefile Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-07-31 14:15:41 +03:00
.PHONY: help
help: ## print this help
Makefile: make help: fix newline wrapping, and missing targets This patch adds support for multiple newlines and removes the 1-space indentation of wrapped lines. Given these targets: ```Makefile .PHONY: foobar foobar: ## runs the foobar lorum ipsum.\nand so pn\nand so on echo foobar ``` Before this change, the output of `make help` was ``` foobar runs the foobar lorum ipsum. and so pn\nand so on ``` After this change, the output is: ``` foobar runs the foobar lorum ipsum. and so pn and so on ``` Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-10 15:30:03 +03:00
@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)