beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
moby/hack
History
Sebastiaan van Stijn 08e4e88482
daemon: raise default minimum API version to v1.24 
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>
2023-12-05 23:11:02 +01:00
..
dockerfile update containerd binary to v1.7.9 2023-11-19 13:34:04 +01:00
dockerfiles Dockerfile: update to Debian "bookworm" (current stable) 2023-11-30 11:50:34 +01:00
make daemon: raise default minimum API version to v1.24 2023-12-05 23:11:02 +01:00
test test: remove platform related timeout values 2023-08-31 10:39:28 +02:00
validate Move the golangci-lint configuration file to the root dir 2023-10-30 13:48:58 +01:00
buildkit-ref ci(buildkit): remove early-return from buildkit-ref 2023-07-18 09:30:42 -06:00
dind hack/dind: update comments around AppArmor 2023-11-27 14:48:51 +01:00
dind-systemd hack/dind-systemd: make AppArmor work with systemd enabled 2023-11-27 14:47:59 +01:00
generate-authors.sh hack: use Git-free ROOTDIR convention 2023-07-17 10:38:10 -06:00
generate-swagger-api.sh api/types: move ServiceCreateResponse, and generate from swagger 2023-10-12 11:29:23 +02:00
generate-test-certs.sh hack: add script to regenerate certificates 2021-05-18 09:43:18 +02:00
generate-test-rogue-certs.sh integration-cli: fix test rogue certs 2022-05-19 10:54:31 +02:00
make.ps1 hack: update link to GOPATH documentation 2023-08-25 12:53:19 +02:00
make.sh hack: remove devicemapper leftovers and build-tags 2023-08-25 16:39:33 +02:00
README.md Dockerfile: use TARGETPLATFORM to build Docker 2023-01-01 18:03:01 +01:00
vendor.sh hack: replace go-mod-prepare.sh with wrapper script 2022-12-12 18:39:06 -07:00
with-go-mod.sh vendor.mod: bump go line to 1.20 2023-09-28 10:01:25 -06:00

README.md

About

This directory contains a collection of scripts used to build and manage this repository. If there are any issues regarding the intention of a particular script (or even part of a certain script), please reach out to us. It may help us either refine our current scripts, or add on new ones that are appropriate for a given use case.

DinD (dind.sh)

DinD is a wrapper script which allows Docker to be run inside a Docker container. DinD requires the container to be run with privileged mode enabled.

Generate Authors (generate-authors.sh)

Generates AUTHORS; a file with all the names and corresponding emails of individual contributors. AUTHORS can be found in the home directory of this repository.

Make

There are two make files, each with different extensions. Neither are supposed to be called directly; only invoke make. Both scripts run inside a Docker container.

make.ps1

  • The Windows native build script that uses PowerShell semantics; it is limited unlike hack\make.sh since it does not provide support for the full set of operations provided by the Linux counterpart, make.sh. However, make.ps1 does provide support for local Windows development and Windows to Windows CI. More information is found within make.ps1 by the author, @jhowardmsft

make.sh

  • Referenced via make test when running tests on a local machine, or directly referenced when running tests inside a Docker development container.
  • When running on a local machine, make test to run all tests found in test, test-unit, test-integration, and test-docker-py on your local machine. The default timeout is set in make.sh to 60 minutes (${TIMEOUT:=60m}), since it currently takes up to an hour to run all of the tests.
  • When running inside a Docker development container, hack/make.sh does not have a single target that runs all the tests. You need to provide a single command line with multiple targets that performs the same thing. An example referenced from Run targets inside a development container: root@5f8630b873fe:/go/src/github.com/moby/moby# hack/make.sh dynbinary binary test-unit test-integration test-docker-py
  • For more information related to testing outside the scope of this README, refer to Run tests and test documentation

Vendor (vendor.sh)

A shell script that is a wrapper around go mod vendor.