List of PRs / issues for this release
Breaking changes
- Dropped support for Python 2.6
docker.Client
has been renamed todocker.APIClient
docker.from_env
now creates aDockerClient
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 nowdocker
(was:docker-py
). New
versions of this library will only be published asdocker
from now on. docker.ssladapter
is nowdocker.transport.ssladapter
- The package structure has been flattened in certain cases, which may affect
import fordocker.auth
anddocker.utils.ports
docker.utils.types
has been moved todocker.types
create_host_config
,create_ipam_pool
andcreate_ipam_config
have been
removed fromdocker.utils
. They have been replaced by the following classes
indocker.types
:HostConfig
,IPAMPool
andIPAMCOnfig
.
Features
- Added a high-level, user-focused API as
docker.DockerClient
. See the
README and documentation for more information. - Implemented
update_node
method inAPIClient
. - Implemented
remove_node
method inAPIClient
. - Added support for
restart_policy
inupdate_container
. - Added support for
labels
andshmsize
inbuild
. - Added support for
attachable
increate_network
- Added support for
healthcheck
increate_container
. - Added support for
isolation
inHostConfig
. - Expanded support for
pid_mode
inHostConfig
(now supports arbitrary
values for API version >= 1.24). - Added support for
options
inIPAMConfig
- Added a
HealthCheck
class todocker.types
to be used in
create_container
. - Added an
EndpointSpec
class todocker.types
to be used in
create_service
andupdate_service
.
Bugfixes
- Fixed a bug where auth information would not be properly passed to the engine
during abuild
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 callingbuild
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
increate_service
and
update_service
wouldn't be properly converted for the engine. - Fixed an issue where
endpoint_config
increate_service
and
update_service
would be ignored. endpoint_config
increate_service
andupdate_service
has been
deprecated in favor ofendpoint_spec
- Fixed a bug where
constraints
in aTaskTemplate
object wouldn't be
properly converted for the engine. - Fixed an issue where providing a dictionary for
env
inContainerSpec
would provoke anAPIError
when sent to the engine. - Fixed a bug where providing an
env_file
containing empty lines in
create_container
would raise an exception. - Fixed a bug where
detach
was being ignored byexec_start
.