+ community.docker.docker_container_copy_into module – Copy a file into a Docker container
+Note
+This module is part of the community.docker collection (version 3.4.0).
+To install it, use: ansible-galaxy collection install community.docker.
+You need further requirements to be able to use this module,
+see Requirements for details.
To use it in a playbook, specify: community.docker.docker_container_copy_into.
Synopsis
+-
+
Copy a file into a Docker container.
+Similar to
docker cp.
+To copy files in a non-running container, you must provide the owner_id and group_id options. This is also necessary if the container does not contain a
/bin/shshell with anidtool.
+
Note
+This module has a corresponding action plugin.
+Requirements
+The below requirements are needed on the host that executes this module.
+-
+
Docker API >= 1.25
+backports.ssl_match_hostname (when using TLS on Python 2)
+paramiko (when using SSH with use_ssh_client=false)
+pyOpenSSL (when using TLS)
+pywin32 (when using named pipes on Windows 32)
+requests
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The version of the Docker API running on the Docker Host. +Defaults to the latest version of the API supported by this collection and the docker daemon. +If the value is not specified in the task, the value of environment variable Default: |
+
| + | Use a CA certificate when performing server verification by providing the path to a CA certificate file. +If the value is not specified in the task and the environment variable |
+
| + | Path to the client’s TLS certificate file. +If the value is not specified in the task and the environment variable |
+
| + | Path to the client’s TLS key file. +If the value is not specified in the task and the environment variable |
+
| + | The name of the container to copy files to. + |
+
| + | Path to a file inside the Docker container. +Must be an absolute path. + |
+
| + | The file’s content. +If you plan to provide binary data, provide it pre-encoded to base64, and set content_is_b64=true. +Mutually exclusive with path. One of content and path is required. + |
+
| + | If set to To use binary content, it is better to keep it Base64 encoded and let it be decoded by this option. Otherwise you risk the data to be interpreted as UTF-8 and corrupted. +Choices: +
|
+
| + | Debug mode +Choices: +
|
+
| + | The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, If the value is not specified in the task, the value of environment variable Default: |
+
| + | This flag indicates that filesystem links in the Docker container, if they exist, should be followed. +Choices: +
|
+
| + | If set to If set to If this option is not specified, the module will be idempotent. To verify idempotency, it will try to get information on the filesystem object in the container, and if everything seems to match will download the file from the container to compare it to the file to upload. +Choices: +
|
+
| + | The group ID to use when writing the file to disk. +If provided, owner_id must also be provided. +If not provided, the module will try to determine the user and group ID for the current user in the container. This will only work if |
+
| + | This flag indicates that filesystem links in the source tree (where the module is executed), if they exist, should be followed. +Choices: +
|
+
| + | The file mode to use when writing the file to disk. +Will use the file’s mode from the source system if this option is not provided. + |
+
| + | The owner ID to use when writing the file to disk. +If provided, group_id must also be provided. +If not provided, the module will try to determine the user and group ID for the current user in the container. This will only work if |
+
| + | Path to a file on the managed node. +Mutually exclusive with content. One of content and path is required. + |
+
| + | Provide a valid SSL version number. Default value determined by ssl.py module. +If the value is not specified in the task, the value of environment variable |
+
| + | The maximum amount of time in seconds to wait on a response from the API. +If the value is not specified in the task, the value of environment variable Default: |
+
| + | Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to If the value is not specified in the task, the value of environment variable Choices: +
|
+
| + | When verifying the authenticity of the Docker Host server, provide the expected name of the server. +If the value is not specified in the task, the value of environment variable Note that this option had a default value |
+
| + | For SSH transports, use the Choices: +
|
+
| + | Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. +If the value is not specified in the task, the value of environment variable Choices: +
|
+
Attributes
+Attribute |
+Support |
+Description |
+
|---|---|---|
| + | Action groups: community.docker.docker, docker + |
+Use |
+
| + | Support: full + |
+Can run in |
+
| + | Support: full +Additional data will need to be transferred to compute diffs. +The module uses the MAX_FILE_SIZE_FOR_DIFF ansible-core configuration to determine for how large files diffs should be computed. + |
+Will return details on what has changed (or possibly needs changing in |
+
Notes
+Note
+-
+
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_SSL_VERSION,DOCKER_TLS,DOCKER_TLS_VERIFYandDOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
+This module does not use the Docker SDK for Python to communicate with the Docker daemon. It uses code derived from the Docker SDK or Python that is included in this collection.
+
Examples
+- name: Copy a file into the container
+ community.docker.docker_container_copy_into:
+ container: mydata
+ path: /home/user/data.txt
+ container_path: /data/input.txt
+
+- name: Copy a file into the container with owner, group, and mode set
+ community.docker.docker_container_copy_into:
+ container: mydata
+ path: /home/user/bin/runme.o
+ container_path: /bin/runme
+ owner: 0 # root
+ group: 0 # root
+ mode: 0o755 # readable and executable by all users, writable by root
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The actual path in the container. +Can only be different from container_path when follow=true. +Returned: success + |
+
Collection links
++ Issue Tracker + Repository (Sources) + Submit a bug report + Request a feature + Communication +