adding unless-stopped to the restart_policy option documentation #2312
+4
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
According to https://docs.docker.com/config/containers/start-containers-automatically/ there is also an option of using
unless-stopped
as one of Docker restart policies, this seems to be not an option with docker-py as it's missing from the documentation where in fact it does work (yay) but simply is not mentioned in docker-py documentation.This pull request adds the missing
unless-stopped
as a viable option in the documentation ofrestart_policy
, I confirmed it to be a missing documentation only issue by using the low level API to create a container with arestart_policy
with a value of{'Name': 'unless-stopped'}
then usingdocker inspect
to verify it indeed started the container with the configuration ofWhich matches the expected configuration of such a restart policy & that of a another container which was started using the following Docker CLI command
docker run --name test --restart unless-stopped nginx