A Python library for the Docker Engine API
APACHE-2.0 License
Bot releases are visible (Hide)
Published by shin- over 6 years ago
List of PRs / issues for this release
ValueError
when attempting toPublished by shin- over 6 years ago
List of PRs / issues for this release
attach()
, logs()
and events()
now have acancel()
method to let consumers stop the iteration client-side.build()
methods can now handle Dockerfiles supplied outside of thesparse
argument to DockerClient.containers.list()
isolation
parameter to build()
methods.close()
method to DockerClient
APIClient.inspect_distribution()
method andDockerClient.images.get_registry_data()
RegistryData
classPublished by shin- over 6 years ago
List of PRs / issues for this release
Published by shin- over 6 years ago
List of PRs / issues for this release
./
Published by shin- over 6 years ago
List of PRs / issues for this release
.dockerignore
comments to be read as exclusionPublished by shin- over 6 years ago
List of PRs / issues for this release
device_cgroup_rules
in host configgeneric_resources
when creating a Resources
chunk_size
parameter in export
,get_archive
and get_image
(Image.save
)force_update
method to the Service
class.Service.update
, when the force_update
parameter is set to True
,force_update
counter is incremented by one in the updatelogin()
was being ignored if theDockerClient.images.pull
to pull an image by digest.dockerignore
rules should now be respected as defined by the spec,pass
credential store is now properly supported.Published by shin- over 6 years ago
List of PRs / issues for this release
APIClient.login
didn't populate the _auth_configs
pull
and push
operations to failPublished by shin- over 6 years ago
List of PRs / issues for this release
APIClient.copy
has been removed. Users should use APIClient.get_archive
APIClient.insert
has been removed. Users may use APIClient.put_archive
APIClient.commit
to replicate the method's behavior.utils.ping_registry
and utils.ping
have been removed.stream
in APIClient.build
cpu_shares
, cpuset
, dns
, mem_limit
, memswap_limit
,volume_driver
, volumes_from
in APIClient.create_container
. These arecreate_host_config
insecure_registry
in APIClient.login
, APIClient.pull
,APIClient.push
, DockerClient.images.push
and DockerClient.images.pull
viz
in APIClient.images
endpoint_config
in APIClient.create_service
andAPIClient.update_service
is now endpoint_spec
name
in DockerClient.images.pull
is now repository
APIClient.wait
and Container.wait
now return a dict
representingDockerClient.images.load
now returns a list of Image
objects that haveContainer.exec_run
now returns a tuple of (exit_code, output) instead ofDockerClient.images.build
now returns a tuple of (image, build_logs)APIClient.export
, APIClient.get_archive
and APIClient.get_image
nowDockerClient.images.pull
now returns a list ofImage
s associated to the pulled repository instead of just the latest
scale
method to the Service
model ; this method is a shorthandupdate_service
with the required number of replicasplatform
parameter in APIClient.build
,DockerClient.images.build
, APIClient.pull
and DockerClient.images.pull
until
parameter in APIClient.logs
andContainer.logs
workdir
argument in APIClient.exec_create
andContainer.exec_run
condition
argument in APIClient.wait
andContainer.wait
EndpointSpec
using{published_port: (target_port, protocol, publish_mode)}
syntax.isolation
parameter in ContainerSpec
,DockerClient.services.create
and Service.update
APIClient.attach_socket
, APIClient.exec_create
now allow specifying adetach_keys
combination. If unspecified, the value from the config.json
.dockerignore
would break buildsDockerClient.containers.run
networks
data provided to create_service
andupdate_service
would be sent incorrectly to the Engine with API < 1.25latest
tag using theDockerClient
will no longer raise a NotFound
exceptionPublished by shin- almost 7 years ago
List of PRs / issues for this release
unlock_swarm
and get_unlock_key
methods to the APIClient
.
unlock
and get_unlock_key
to DockerClient.swarm
.greedy
parameter to DockerClient.networks.list
, yieldingcpu_rt_runtime
and cpu_rt_period
as parameters toAPIClient.create_host_config
and DockerClient.containers.run
.order
argument to UpdateConfig
.fetch_current_spec
to APIClient.update_service
and Service.update
build
method tried to include inaccessible filesIOError
instead).build
method would try to read from FIFOs presentAPIClient.stop
will no longer override the stop_timeout
value presentDockerClient.containers.run
would crash if theauto_remove
parameter was set to True
.listen_addr
in join_swarm
to match theinit_swarm
.APIError
object.Published by shin- almost 7 years ago
List of PRs / issues for this release
attach
andexec_run
methods.Published by shin- almost 7 years ago
List of PRs / issues for this release
mounts
in APIClient.create_host_config
andDockerClient.containers.run
consistency
, tmpfs_size
and tmpfs_mode
whenMount
objects now support the tmpfs
and npipe
types.extra_hosts
in the build
methods.APIClient
: create_config
, inspect_config
, remove_config
,configs
DockerClient
: configs.create
, configs.get
, configs.list
andConfig
model.configs
parameter to ContainerSpec
. Each item in the configs
docker.types.ConfigReference
instance.ContainerSpec
groups
, open_stdin
, read_only
, stop_signal
, helathcheck
,hosts
, ns_config
, configs
, privileges
.docker.types
:ConfigReference
, DNSConfig
, Privileges
, SwarmExternalCA
.driver
in APIClient.create_secret
andDockerClient.secrets.create
.scope
in APIClient.inspect_network
andAPIClient.create_network
, and their DockerClient
equivalent.create_swarm_spec
:external_cas
, labels
, signing_ca_cert
, signing_ca_key
,ca_force_rotate
, autolock_managers
, log_driver
. These additionsDockerClient.swarm.init
.insert_defaults
in APIClient.inspect_service
andDockerClient.services.get
.id
member on Swarm
objects wasn't being populated.attach
, exec_run
) to disappear.Published by shin- about 7 years ago
List of PRs / issues for this release
**
in .dockerignore
wouldattach
with the stream
argument set to False
Published by shin- about 7 years ago
List of PRs / issues for this release
squash
parameter in APIClient.build
andDockerClient.images.build
.load_image
will now return adict
s.remove_image
now returns the content of the API's response.auto_remove
parameter inDockerClient.containers.run
was not taken into account..dockerignore
patterns starting with a slash**
patterns in .dockerignore
FROM
a private Docker Hub image when notcreate_service
or update_service
withtask_template
as a dict
would raise an exception.attach
and exec_run
.DockerClient.containers.run
will no longer attempt to stream logs if thedocker[tls]
notation.Published by shin- about 7 years ago
List of issues / PRs for this release
split_port
utility would raise an exception whenPublished by shin- over 7 years ago
List of PRs / issues for this release
target
and network_mode
parameters inAPIClient.build
and DockerClient.images.build
.runtime
parameter in APIClient.create_container
DockerClient.containers.run
.ingress
parameter in APIClient.create_network
andDockerClient.networks.create
.placement
configuration in docker.types.TaskTemplate
.tty
configuration in docker.types.ContainerSpec
.start_period
configuration in docker.types.Healthcheck
.credHelpers
section in Docker's configuration file is now recognized.DockerClient
using docker.from_env
DockerClient.secrets
was not accessible as a property.DockerClient.build
would sometimes return the wrongHostConfig.nano_cpus
exceeding 2^32 wouldImage.tag
now properly returns True
when the operation is successful.APIClient.logs
and Container.logs
now raise an exception if the since
NullResource
exception whenAPIClient
instances can now be pickled.Published by shin- over 7 years ago
List of PRs / issues for this release
HostConfig
parameters: volume_driver
,cpu_count
, cpu_percent
, nano_cpus
, cpuset_mems
.verbose
parameter in APIClient.inspect_network
andDockerClient.networks.get
.environment
parameter in APIClient.exec_create
Container.exec_run
reload_config
method to APIClient
, that lets the user reloadconfig.json
data from disk.labels
property to the Image
and Container
classes.image
property to the Container
class.replicas
to zero in ServiceMode
would notDockerClient.images.build
would report a failure aftertag
was set.DockerClient.images.pull
would fail to return thetag
was set.mounts
provided to APIClient.create_service
Network.containers
would crash when no containersNetwork.connect
and Network.disconnect
would notcpuset_cpus
parameter would not be properly set inAPIClient.create_host_config
.networks
argument in DockerClient.containers.run
has beennetwork
argument.Published by shin- over 7 years ago
List of PRs / issues for this release
status_code
attribute of APIError
exceptions wouldevents
method would time out unexpectedly if noPublished by shin- over 7 years ago
List of PRs / issues for this release
1.26
(Engine 1.13.1+)upgrade_plugin
method to the APIClient
classupgrade
method to the Plugin
classservice_logs
method to the APIClient
classlogs
method to the Service
classdf
method to APIClient
and DockerClient
init
and init_path
parameters in HostConfig
DockerClient.containers.run
hostname
parameter in ContainerSpec
andDockerClient.service.create
8000-8010:80
)TypeError
events
method in APIClient
and DockerClient
config.json
Published by shin- over 7 years ago
List of PRs / issues for this release
APIClient
: prune_containers
, prune_images
, prune_networks
,prune_volumes
DockerClient
: containers.prune
, images.prune
, networks.prune
,volumes.prune
APIClient
: configure_plugin
, create_plugin
, disable_plugin
,enable_plugin
, inspect_plugin
, pull_plugin
, plugins
,plugin_privileges
, push_plugin
, remove_plugin
DockerClient
: plugins.create
, plugins.get
, plugins.install
,plugins.list
, and the Plugin
model.APIClient
: create_secret
, inspect_secret
, remove_secret
,secrets
DockerClient
: secret.create
, secret.get
, secret.list
andSecret
model.secrets
parameter to ContainerSpec
. Each item in the secrets
docker.types.SecretReference
instance.cache_from
in APIClient.build
andDockerClient.images.build
.auto_remove
and storage_opt
inAPIClient.create_host_config
and DockerClient.containers.run
stop_timeout
in APIClient.create_container
andDockerClient.containers.run
force
parameter in APIClient.remove_volume
andVolume.remove
max_failure_ratio
and monitor
in UpdateConfig
force_update
in TaskTemplate
name
parameter optional in APIClient.create_volume
andDockerClient.volumes.create
AttributeError
.DockerClient.swarm.init
method toImage.tag
now correctly returns a boolean value upon completion.volumes
inDockerClient.containers.run
DockerClient.image.build
wouldn't return an Image
Published by shin- over 7 years ago
List of PRs / issues for this release
docker-py
package isfilters
parameter to APIClient.networks
.DockerClient
are now hashable.DockerClient
TypeError
exception.mode
parameter in create_service
is now properly converted toServiceMode
for advancedAPIClient.events
stream would sometimes raise