Skip to content

Updated developer doc to explain external CLI #35681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 13, 2017
Merged

Updated developer doc to explain external CLI #35681

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 55 additions & 3 deletions docs/contributing/set-up-dev-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,65 @@ can take over 15 minutes to complete.
hack/make.sh binary install-binary run
```

9. Inside your container, check your Docker version.
9. Inside your container, check your Docker versions:

```none
root@5f8630b873fe:/go/src/github.com/docker/docker# docker --version
Docker version 1.12.0-dev, build 6e728fb
# docker version
Client:
Version: 17.06.0-ce
API version: 1.30
Go version: go1.8.3
Git commit: 02c1d87
Built: Fri Jun 23 21:15:15 2017
OS/Arch: linux/amd64

Server:
Version: dev
API version: 1.35 (minimum version 1.12)
Go version: go1.9.2
Git commit: 4aa6362da
Built: Sat Dec 2 05:22:42 2017
OS/Arch: linux/amd64
Experimental: false
```

Notice the split versions between client and server, which might be
unexpected. In more recent times the Docker CLI component (which provides the
`docker` command) has split out from the Moby project and is now maintained in:

* [docker/cli](https://github.com/docker/cli) - The Docker CLI source-code;
* [docker/docker-ce](https://github.com/docker/docker-ce) - The Docker CE
edition project, which assembles engine, CLI and other components.

The Moby project now defaults to a [fixed
version](https://github.com/docker/docker-ce/commits/v17.06.0-ce) of the
`docker` CLI for integration tests.

You may have noticed the following message when starting the container with the `shell` command:

```none
Makefile:123: The docker client CLI has moved to github.com/docker/cli. For a dev-test cycle involving the CLI, run:
DOCKER_CLI_PATH=/host/path/to/cli/binary make shell
then change the cli and compile into a binary at the same location.
```

By setting `DOCKER_CLI_PATH` you can supply a newer `docker` CLI to the
server development container for testing and for `integration-cli`
test-execution:

```none
make DOCKER_CLI_PATH=/home/ubuntu/git/docker-ce/components/packaging/static/build/linux/docker/docker BIND_DIR=. shell
...
# which docker
/usr/local/cli/docker
# docker --version
Docker version 17.09.0-dev, build
```

This Docker CLI should be built from the [docker-ce
project](https://github.com/docker/docker-ce) and needs to be a Linux
binary.

Inside the container you are running a development version. This is the version
on the current branch. It reflects the value of the `VERSION` file at the
root of your `docker-fork` repository.
Expand Down