2.0.0 release by shin- · Pull Request #1343 · docker/docker-py

shin- · 2016-12-07T02:57:31Z

2.0.0

List of PRs / issues for this release

Breaking changes

Dropped support for Python 2.6
docker.Client has been renamed to docker.APIClient
docker.from_env now creates a DockerClient instance instead of an
APIClient instance.
Removed HostConfig parameters from APIClient.start
The minimum supported API version is now 1.21 (Engine version 1.9.0+)
The name of the pip package is now docker (was: docker-py). New
versions of this library will only be published as docker from now on.
docker.ssladapter is now docker.transport.ssladapter
The package structure has been flattened in certain cases, which may affect
import for docker.auth and docker.utils.ports
docker.utils.types has been moved to docker.types
create_host_config, create_ipam_pool and create_ipam_config have been
removed from docker.utils. They have been replaced by the following classes
in docker.types: HostConfig, IPAMPool and IPAMCOnfig.

Features

Added a high-level, user-focused API as docker.DockerClient. See the
README and documentation for more information.
Implemented update_node method in APIClient.
Implemented remove_node method in APIClient.
Added support for restart_policy in update_container.
Added support for labels and shmsize in build.
Added support for attachable in create_network
Added support for healthcheck in create_container.
Added support for isolation in HostConfig.
Expanded support for pid_mode in HostConfig (now supports arbitrary
values for API version >= 1.24).
Added support for options in IPAMConfig
Added a HealthCheck class to docker.types to be used in
create_container.
Added an EndpointSpec class to docker.types to be used in
create_service and update_service.

Bugfixes

Fixed a bug where auth information would not be properly passed to the engine
during a build if the client used a credentials store.
Fixed an issue with some exclusion patterns in build.
Fixed an issue where context files were bundled with the wrong permissions
when calling build on Windows.
Fixed an issue where auth info would not be retrieved from its default location
on Windows.
Fixed an issue where lists of networks in create_service and
update_service wouldn't be properly converted for the engine.
Fixed an issue where endpoint_config in create_service and
update_service would be ignored.
endpoint_config in create_service and update_service has been
deprecated in favor of endpoint_spec
Fixed a bug where constraints in a TaskTemplate object wouldn't be
properly converted for the engine.
Fixed an issue where providing a dictionary for env in ContainerSpec
would provoke an APIError when sent to the engine.
Fixed a bug where providing an env_file containing empty lines in
create_containerwould raise an exception.
Fixed a bug where detach was being ignored by exec_start.

Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Real errors were getting swallowed in these tests, producing other confusing cascading errors. This makes it much easier to make sure a node is not in a Swarm, while also handling other errors correctly. Signed-off-by: Ben Firshman <ben@firshman.co.uk>

autopep8 --in-place --recursive --experimental -aaa --ignore E309 . Signed-off-by: Ben Firshman <ben@firshman.co.uk>

make integration-test file=models_services_test.py Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

The build context is tarred up on the client and then sent to the Docker daemon. However Windows permissions don't match the Unix ones. Therefore we have to mark all files as executable when creating a build context on Windows, like `docker build` already does: moby/moby#11047. Signed-off-by: Sebastian Schwarz <seschwar@gmail.com>

Added update_node function to enable setting labels on nodes. This exposes the Update a Node function from the Docker API and should enable promoting/demoting manager nodes inside a swarm. Signed-off-by: Nathan Shirlberg <nshirlberg@labattfood.com>

This resolves an issue where TarFile.gettarinfo() doesn't include the file object, meaning that TarFile.addfile(TarFile.gettarinfo()) doesn't pass the test suite. Instead, this uses an open() within a try...except block to include a file object for each file without passing a file object when the path is a directory. Signed-off-by: Christian Bundy <christianbundy@fraction.io>

Signed-off-by: Maxime Feron <maxime.feron@corp.ovh.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Because two things called `BaseTestCase` is quite confusing. I haven't bothered refactoring the other `BaseTestCase` because that disappears anyway when we drop Python 2.6 support. Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Because it's a helper, not a base thing. In preparation for moving/deleting the unit test base classes. Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Signed-off-by: Walker Lee <walkerlee.tw@gmail.com>

- update config structure has new members - service name update is no longer supported Signed-off-by: Alessandro Boch <aboch@docker.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Introduced by #1230 Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Signed-off-by: Ryan Belgrave <Ryan.Belgrave@target.com>

…ase with first letter capital Signed-off-by: bin liu <liubin0329@gmail.com>

Signed-off-by: Simon Li <orpheus+devel@gmail.com>

Fixes #1265 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Fixes the new, purposely broken test added in the previous commit. Signed-off-by: Jon Cotton <jc@finaltransfer.net>

Docker added support for sharing PID namespaces with other containers since version 1.12 (see moby/moby#22481). Signed-off-by: Stepan Stipl <stepan@stipl.net>

People upgrading to docker-py 2.0 without being aware of the new client API will likely try to call the old `containers()` method. This adds a helpful warning telling them to use APIClient to get the old API. Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Replace references to old Client with APIClient Moved contents of services.md to appropriate locations Signed-off-by: Joffrey F <joffrey@docker.com>

Fixes #1271 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

docker.types Signed-off-by: Joffrey F <joffrey@docker.com>

a credentials store Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

The Engine client looks *only* at the USERPROFILE environment variable on Windows, so we should do that too. Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

Makefile now runs tests against Docker 1.13 RC Signed-off-by: Joffrey F <joffrey@docker.com>

Signed-off-by: Joffrey F <joffrey@docker.com>

shin- · 2016-12-09T01:57:27Z

cc @dnephin @aanand @bfirsh

Hoping to release on Monday!

aanand · 2016-12-09T17:08:37Z

bfirsh · 2016-12-10T15:13:55Z

Nice! I am travelling without a computer until next week, but I trust that this is all good. ;)

Signed-off-by: Joffrey F <joffrey@docker.com>

bfirsh · 2016-12-14T11:55:20Z

yay ✨

GordonTheTurtle added the dco/no label Dec 7, 2016

shin- and others added 29 commits December 7, 2016 16:31

dev version

3cad1e1

Signed-off-by: Joffrey F <joffrey@docker.com>

Parse JSON API errors

6f53901

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Fix a few pep8 issues

5ae701a

autopep8 --in-place --recursive --experimental -aaa --ignore E309 . Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Add file arg to integration tests

f1d9ce1

make integration-test file=models_services_test.py Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Add make shell to open a Python shell

7dd6489

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

enable setting of node labels #1225

35f73e2

Added update_node function to enable setting labels on nodes. This exposes the Update a Node function from the Docker API and should enable promoting/demoting manager nodes inside a swarm. Signed-off-by: Nathan Shirlberg <nshirlberg@labattfood.com>

Add support for restart policy update

9413523

Signed-off-by: Maxime Feron <maxime.feron@corp.ovh.com>

Add support for isolation param in host config

abeee73

Signed-off-by: Joffrey F <joffrey@docker.com>

Add timeout to from_env

6665f2b

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Move BaseTestCase to BaseIntegrationTest

61b679d

Because two things called `BaseTestCase` is quite confusing. I haven't bothered refactoring the other `BaseTestCase` because that disappears anyway when we drop Python 2.6 support. Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Move requires_api_version to helpers

dd0e04b

Because it's a helper, not a base thing. In preparation for moving/deleting the unit test base classes. Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Update adapters to use pool_connections instead of num_pools

6905b3c

Signed-off-by: Joffrey F <joffrey@docker.com>

document requirement for ipaddress module

d8e7433

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

document how to recover from api version mismatch

afb097f

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Removed non-existent FAQ page from mkdocs.yml

acf9172

Signed-off-by: Joffrey F <joffrey@docker.com>

Remove dead code in import_image_from_data

9e06bdd

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Add docker network IPAM options parameter

4661b83

Signed-off-by: Walker Lee <walkerlee.tw@gmail.com>

Changes for service tests to pass in docker master

bef6e5c

- update config structure has new members - service name update is no longer supported Signed-off-by: Alessandro Boch <aboch@docker.com>

WIP

191ab49

Signed-off-by: Joffrey F <joffrey@docker.com>

Fix endpoint spec and networks params in update_service

f062026

Signed-off-by: Joffrey F <joffrey@docker.com>

Fix broken unit test

995c5fa

Introduced by #1230 Signed-off-by: Ben Firshman <ben@firshman.co.uk>

Add labels and shmsize arguments to the image build

f48a317

Signed-off-by: Ryan Belgrave <Ryan.Belgrave@target.com>

fix JSON key typo, it should not be underscores, but should be camelC…

ece2a36

…ase with first letter capital Signed-off-by: bin liu <liubin0329@gmail.com>

Use format_environment to convert env in ContainerSpec

d7caf71

Signed-off-by: Simon Li <orpheus+devel@gmail.com>

Add test for creating service with env

0518290

Signed-off-by: Simon Li <orpheus+devel@gmail.com>

ssl,test: OpenSSL may not support ssl2

e6f6ab1

Fixes #1265 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

joncotton and others added 17 commits December 7, 2016 16:34

Fix parsing for an environment file with newlines

bc27829

Fixes the new, purposely broken test added in the previous commit. Signed-off-by: Jon Cotton <jc@finaltransfer.net>

Allow custom PID mode for the container

d19e8e6

Docker added support for sharing PID namespaces with other containers since version 1.12 (see moby/moby#22481). Signed-off-by: Stepan Stipl <stepan@stipl.net>

Re-enable pid_mode checks for API < 1.24

e098dbf

Signed-off-by: Joffrey F <joffrey@docker.com>

Rename Client -> DockerClient

27ec5f3

Replace references to old Client with APIClient Moved contents of services.md to appropriate locations Signed-off-by: Joffrey F <joffrey@docker.com>

exec: fix running with detach=True

045913b

Fixes #1271 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Exclude requests==2.12.2 from dependencies

937a5f3

Signed-off-by: Joffrey F <joffrey@docker.com>

Move config type creation from docker.utils functions to classes in

0cdc855

docker.types Signed-off-by: Joffrey F <joffrey@docker.com>

Properly fill out auth headers in APIClient.build when using

96022e8

a credentials store Signed-off-by: Joffrey F <joffrey@docker.com>

Move ssladapter to transport module

8c4fd81

Signed-off-by: Joffrey F <joffrey@docker.com>

Fix auth config path on Windows

de89ee6

The Engine client looks *only* at the USERPROFILE environment variable on Windows, so we should do that too. Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>

Add options to IPAMConfig

4669b24

Signed-off-by: Joffrey F <joffrey@docker.com>

Add attachable.

5dc7425

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

Minimum version 1.24 -> 1.21

82634fe

Signed-off-by: Joffrey F <joffrey@docker.com>

Fix typo in create_network

5344e11

Signed-off-by: Joffrey F <joffrey@docker.com>

Implement swarm node removal

41e1164

Signed-off-by: Joffrey F <joffrey@docker.com>

Update code and tests for Engine 1.13 compatibility

245e0e5

Makefile now runs tests against Docker 1.13 RC Signed-off-by: Joffrey F <joffrey@docker.com>

shin- force-pushed the 2.0.0-release branch from 2bc7641 to 9cd7b72 Compare December 8, 2016 00:58

GordonTheTurtle removed the dco/no label Dec 8, 2016

Bump version and update Changelog

514291c

Signed-off-by: Joffrey F <joffrey@docker.com>

shin- force-pushed the 2.0.0-release branch from 9cd7b72 to 514291c Compare December 8, 2016 01:04

shin- added this to the 2.0.0 milestone Dec 8, 2016

Rename non-URL occurrences of docker-py to "Docker SDK for Python"

b45f265

Signed-off-by: Joffrey F <joffrey@docker.com>

shin- merged commit 3bc06bb into release Dec 12, 2016

shin- deleted the 2.0.0-release branch January 26, 2017 22:25

tottoto mentioned this pull request Jan 6, 2019

Update docker sdk tottoto/ansible-role-kubectl#11

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

2.0.0 release#1343

2.0.0 release#1343
shin- merged 88 commits into
releasefrom
2.0.0-release

shin- commented Dec 7, 2016 •

edited

Loading

Uh oh!

shin- commented Dec 9, 2016

Uh oh!

aanand commented Dec 9, 2016

Uh oh!

bfirsh commented Dec 10, 2016

Uh oh!

bfirsh commented Dec 14, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

Uh oh!

Conversation

shin- commented Dec 7, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

2.0.0

Breaking changes

Features

Bugfixes

Uh oh!

shin- commented Dec 9, 2016

Uh oh!

aanand commented Dec 9, 2016

Uh oh!

bfirsh commented Dec 10, 2016

Uh oh!

bfirsh commented Dec 14, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

shin- commented Dec 7, 2016 •

edited

Loading