mirror of
https://github.com/moby/moby.git
synced 2026-01-11 18:51:37 +00:00
The daemon currently provides support for API versions all the way back
to v1.12, which is the version of the API that shipped with docker 1.0. On
Windows, the minimum supported version is v1.24.
Such old versions of the client are rare, and supporting older API versions
has accumulated significant amounts of code to remain backward-compatible
(which is largely untested, and a "best-effort" at most).
This patch updates the minimum API version to v1.24, which is the fallback
API version used when API-version negotiation fails. The intent is to start
deprecating older API versions, but no code is removed yet as part of this
patch, and a DOCKER_MIN_API_VERSION environment variable is added, which
allows overriding the minimum version (to allow restoring the behavior from
before this patch).
With this patch the daemon defaults to API v1.24 as minimum:
docker version
Client:
Version: 24.0.2
API version: 1.43
Go version: go1.20.4
Git commit: cb74dfc
Built: Thu May 25 21:50:49 2023
OS/Arch: linux/arm64
Context: default
Server:
Engine:
Version: dev
API version: 1.44 (minimum version 1.24)
Go version: go1.21.3
Git commit: 0322a29b9ef8806aaa4b45dc9d9a2ebcf0244bf4
Built: Mon Dec 4 15:22:17 2023
OS/Arch: linux/arm64
Experimental: false
containerd:
Version: v1.7.9
GitCommit: 4f03e100cb967922bec7459a78d16ccbac9bb81d
runc:
Version: 1.1.10
GitCommit: v1.1.10-0-g18a0cb0
docker-init:
Version: 0.19.0
GitCommit: de40ad0
Trying to use an older version of the API produces an error:
DOCKER_API_VERSION=1.23 docker version
Client:
Version: 24.0.2
API version: 1.23 (downgraded from 1.43)
Go version: go1.20.4
Git commit: cb74dfc
Built: Thu May 25 21:50:49 2023
OS/Arch: linux/arm64
Context: default
Error response from daemon: client version 1.23 is too old. Minimum supported API version is 1.24, please upgrade your client to a newer version
To restore the previous minimum, users can start the daemon with the
DOCKER_MIN_API_VERSION environment variable set:
DOCKER_MIN_API_VERSION=1.12 dockerd
API 1.12 is the oldest supported API version on Linux;
docker version
Client:
Version: 24.0.2
API version: 1.43
Go version: go1.20.4
Git commit: cb74dfc
Built: Thu May 25 21:50:49 2023
OS/Arch: linux/arm64
Context: default
Server:
Engine:
Version: dev
API version: 1.44 (minimum version 1.12)
Go version: go1.21.3
Git commit: 0322a29b9ef8806aaa4b45dc9d9a2ebcf0244bf4
Built: Mon Dec 4 15:22:17 2023
OS/Arch: linux/arm64
Experimental: false
containerd:
Version: v1.7.9
GitCommit: 4f03e100cb967922bec7459a78d16ccbac9bb81d
runc:
Version: 1.1.10
GitCommit: v1.1.10-0-g18a0cb0
docker-init:
Version: 0.19.0
GitCommit: de40ad0
When using the `DOCKER_MIN_API_VERSION` with a version of the API that
is not supported, an error is produced when starting the daemon;
DOCKER_MIN_API_VERSION=1.11 dockerd --validate
invalid DOCKER_MIN_API_VERSION: minimum supported API version is 1.12: 1.11
DOCKER_MIN_API_VERSION=1.45 dockerd --validate
invalid DOCKER_MIN_API_VERSION: maximum supported API version is 1.44: 1.45
Specifying a malformed API version also produces the same error;
DOCKER_MIN_API_VERSION=hello dockerd --validate
invalid DOCKER_MIN_API_VERSION: minimum supported API version is 1.12: hello
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
172 lines
5.3 KiB
Bash
172 lines
5.3 KiB
Bash
#!/usr/bin/env bash
|
|
|
|
# see test-integration for example usage of this script
|
|
|
|
base="$ABS_DEST/.."
|
|
export PATH="$base/dynbinary-daemon:$base/binary-daemon:$PATH"
|
|
|
|
if [ -z "$TEST_CLIENT_BINARY" ]; then
|
|
export TEST_CLIENT_BINARY=docker
|
|
fi
|
|
if [ -n "$DOCKER_CLI_PATH" ]; then
|
|
# /usr/local/cli is a bind mount to the base dir of DOCKER_CLI_PATH (if used)
|
|
export TEST_CLIENT_BINARY=/usr/local/cli/$(basename "$DOCKER_CLI_PATH")
|
|
fi
|
|
|
|
echo "Using test binary $TEST_CLIENT_BINARY"
|
|
if ! command -v "$TEST_CLIENT_BINARY" &> /dev/null; then
|
|
echo >&2 'error: missing test client $TEST_CLIENT_BINARY'
|
|
false
|
|
fi
|
|
|
|
# This is a temporary hack for split-binary mode. It can be removed once
|
|
# https://github.com/docker/docker/pull/22134 is merged into docker master
|
|
if [ "$(go env GOOS)" = 'windows' ]; then
|
|
return
|
|
fi
|
|
|
|
if [ -z "$DOCKER_TEST_HOST" ]; then
|
|
if docker version &> /dev/null; then
|
|
echo >&2 'skipping daemon start, since daemon appears to be already started'
|
|
return
|
|
fi
|
|
fi
|
|
|
|
if ! command -v dockerd &> /dev/null; then
|
|
echo >&2 'error: binary-daemon or dynbinary-daemon must be run before .integration-daemon-start'
|
|
false
|
|
fi
|
|
|
|
# intentionally open a couple bogus file descriptors to help test that they get scrubbed in containers
|
|
exec 41>&1 42>&2
|
|
|
|
# Allow pushing manifest v2 schema 1 images, as they're used to push
|
|
# images to our test-registries for testing _pulling_ schema 2v1 images.
|
|
export DOCKER_ALLOW_SCHEMA1_PUSH_DONOTUSE=1
|
|
export DOCKER_GRAPHDRIVER=${DOCKER_GRAPHDRIVER:-vfs}
|
|
export DOCKER_USERLANDPROXY=${DOCKER_USERLANDPROXY:-true}
|
|
|
|
# Allow testing old API versions
|
|
export DOCKER_MIN_API_VERSION=1.12
|
|
|
|
# example usage: DOCKER_STORAGE_OPTS="dm.basesize=20G,dm.loopdatasize=200G"
|
|
storage_params=""
|
|
if [ -n "$DOCKER_STORAGE_OPTS" ]; then
|
|
IFS=','
|
|
for i in ${DOCKER_STORAGE_OPTS}; do
|
|
storage_params="--storage-opt $i $storage_params"
|
|
done
|
|
unset IFS
|
|
fi
|
|
|
|
# example usage: DOCKER_REMAP_ROOT=default
|
|
extra_params=""
|
|
if [ "$DOCKER_REMAP_ROOT" ]; then
|
|
extra_params="--userns-remap $DOCKER_REMAP_ROOT"
|
|
fi
|
|
|
|
# example usage: DOCKER_EXPERIMENTAL=1
|
|
if [ "$DOCKER_EXPERIMENTAL" ]; then
|
|
echo >&2 '# DOCKER_EXPERIMENTAL is set: starting daemon with experimental features enabled! '
|
|
extra_params="$extra_params --experimental"
|
|
fi
|
|
|
|
dockerd="dockerd"
|
|
if [ -f "/sys/fs/cgroup/cgroup.controllers" ]; then
|
|
if [ -z "$TEST_IGNORE_CGROUP_CHECK" ] && [ -z "$TEST_SKIP_INTEGRATION_CLI" ]; then
|
|
echo >&2 '# cgroup v2 requires TEST_SKIP_INTEGRATION_CLI to be set'
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
if [ -n "$DOCKER_ROOTLESS" ]; then
|
|
if [ -z "$TEST_SKIP_INTEGRATION_CLI" ]; then
|
|
echo >&2 '# DOCKER_ROOTLESS requires TEST_SKIP_INTEGRATION_CLI to be set'
|
|
exit 1
|
|
fi
|
|
user="unprivilegeduser"
|
|
uid=$(id -u $user)
|
|
# shellcheck disable=SC2174
|
|
mkdir -p -m 700 "/tmp/docker-${uid}"
|
|
chown "$user" "/tmp/docker-${uid}"
|
|
chmod -R o+w "$DEST"
|
|
dockerd="sudo -u $user -E -E XDG_RUNTIME_DIR=/tmp/docker-${uid} -E HOME=/home/${user} -E PATH=$PATH -- dockerd-rootless.sh"
|
|
fi
|
|
|
|
if [ -z "$DOCKER_TEST_HOST" ]; then
|
|
# Start apparmor if it is enabled
|
|
if [ -e "/sys/module/apparmor/parameters/enabled" ] && [ "$(cat /sys/module/apparmor/parameters/enabled)" == "Y" ]; then
|
|
# reset container variable so apparmor profile is applied to process
|
|
# see https://github.com/docker/libcontainer/blob/master/apparmor/apparmor.go#L16
|
|
export container=""
|
|
(
|
|
[ -n "$TESTDEBUG" ] && set -x
|
|
/etc/init.d/apparmor start
|
|
)
|
|
fi
|
|
|
|
if [ -n "${DOCKER_ROOTLESS}" ]; then
|
|
# "pwd" tricks to make sure $DEST is an absolute path, not a relative one
|
|
export DOCKER_HOST="unix://$(cd "$DEST" && pwd)/docker.sock"
|
|
else
|
|
# Put socket in /run because:
|
|
# 1. That's the normal place for such things
|
|
# 2. When running on Docker For Mac, if you need to run tests with the bundles dir mounted (e.g. to poke through test artifacts).
|
|
# the socket will not work because it will be over osxfs.
|
|
mkdir -p /run/docker
|
|
sock_dir=$(mktemp -d -p /run/docker)
|
|
chmod 0755 "$sock_dir"
|
|
export DOCKER_HOST="unix://${sock_dir}/docker.sock"
|
|
fi
|
|
(
|
|
echo "Starting dockerd"
|
|
[ -n "$TESTDEBUG" ] && set -x
|
|
exec \
|
|
${dockerd} --debug \
|
|
--host "$DOCKER_HOST" \
|
|
--storage-driver "$DOCKER_GRAPHDRIVER" \
|
|
--pidfile "$DEST/docker.pid" \
|
|
--userland-proxy="$DOCKER_USERLANDPROXY" \
|
|
${storage_params} \
|
|
${extra_params} \
|
|
&> "$DEST/docker.log"
|
|
) &
|
|
else
|
|
export DOCKER_HOST="$DOCKER_TEST_HOST"
|
|
fi
|
|
|
|
# give it a little time to come up so it's "ready"
|
|
tries=60
|
|
echo "INFO: Waiting for daemon to start..."
|
|
while ! ${TEST_CLIENT_BINARY} version &> /dev/null; do
|
|
((tries--))
|
|
if [ $tries -le 0 ]; then
|
|
printf "\n"
|
|
if [ -z "$DOCKER_HOST" ]; then
|
|
echo >&2 "error: daemon failed to start"
|
|
echo >&2 " check $DEST/docker.log for details"
|
|
else
|
|
echo >&2 "error: daemon at $DOCKER_HOST fails to '$TEST_CLIENT_BINARY version':"
|
|
${TEST_CLIENT_BINARY} version >&2 || true
|
|
# Additional Windows CI debugging as this is a common error as of
|
|
# January 2016
|
|
if [ "$(go env GOOS)" = 'windows' ]; then
|
|
echo >&2 "Container log below:"
|
|
echo >&2 "---"
|
|
# Important - use the docker on the CI host, not the one built locally
|
|
# which is currently in our path.
|
|
! /c/bin/docker -H=$MAIN_DOCKER_HOST logs docker-$COMMITHASH
|
|
echo >&2 "---"
|
|
fi
|
|
fi
|
|
false
|
|
fi
|
|
printf "."
|
|
sleep 2
|
|
done
|
|
printf "\n"
|
|
|
|
if [ "$(docker version --format '{{ .Server.Os }}')" != 'windows' ]; then
|
|
bundle .build-empty-images
|
|
fi
|