From fd627e3b7876b43f2999cb90349c398f26b92fa3 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 29 Sep 2019 14:52:47 +0200 Subject: [PATCH] docker_container: document some of the unexpected behaviors. (#62325) --- .../modules/cloud/docker/docker_container.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/lib/ansible/modules/cloud/docker/docker_container.py b/lib/ansible/modules/cloud/docker/docker_container.py index 6574b9f09d1..9f2ac3879cd 100644 --- a/lib/ansible/modules/cloud/docker/docker_container.py +++ b/lib/ansible/modules/cloud/docker/docker_container.py @@ -20,10 +20,21 @@ short_description: manage docker containers description: - Manage the life cycle of docker containers. - - Supports check mode. Run with --check and --diff to view config difference and list of actions to be taken. + - Supports check mode. Run with C(--check) and C(--diff) to view config difference and list of actions to be taken. version_added: "2.1" +notes: + - For most config changes, the container needs to be recreated, i.e. the existing container has to be destroyed and + a new one created. This can cause unexpected data loss and downtime. You can use the I(comparisons) option to + prevent this. + - If the module needs to recreate the container, it will only use the options provided to the module to create the + new container (except I(image)). Therefore, always specify *all* options relevant to the container. + - When I(restart) is set to C(true), the module will only restart the container if no config changes are detected. + Please note that several options have default values; if the container to be restarted uses different values for + these options, it will be recreated instead. The options with default values which can cause this are I(auto_remove), + I(detach), I(init), I(interactive), I(memory), I(paused), I(privileged), I(read_only) and I(tty). + options: auto_remove: description: