kubernetes / kubernetes.core / 3.0.1 / module / k8s_cp Copy files and directories to and from pod. | "added in version" 2.2.0 of kubernetes.core" Authors: Aubin Bikouo (@abikouo) This plugin has a corresponding action plugin.kubernetes.core.k8s_cp (3.0.1) — module
Install with ansible-galaxy collection install kubernetes.core:==3.0.1
collections: - name: kubernetes.core version: 3.0.1
Use the Kubernetes Python client to copy files and directories to and from containers inside a pod.
# kubectl cp /tmp/foo some-namespace/some-pod:/tmp/bar - name: Copy /tmp/foo local file to /tmp/bar in a remote pod kubernetes.core.k8s_cp: namespace: some-namespace pod: some-pod remote_path: /tmp/bar local_path: /tmp/foo
# kubectl cp /tmp/foo_dir some-namespace/some-pod:/tmp/bar_dir - name: Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod kubernetes.core.k8s_cp: namespace: some-namespace pod: some-pod remote_path: /tmp/bar_dir local_path: /tmp/foo_dir
# kubectl cp /tmp/foo some-namespace/some-pod:/tmp/bar -c some-container - name: Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container kubernetes.core.k8s_cp: namespace: some-namespace pod: some-pod container: some-container remote_path: /tmp/bar local_path: /tmp/foo no_preserve: True state: to_pod
# kubectl cp some-namespace/some-pod:/tmp/foo /tmp/bar - name: Copy /tmp/foo from a remote pod to /tmp/bar locally kubernetes.core.k8s_cp: namespace: some-namespace pod: some-pod remote_path: /tmp/foo local_path: /tmp/bar state: from_pod
# copy content into a file in the remote pod - name: Copy content into a file in the remote pod kubernetes.core.k8s_cp: state: to_pod namespace: some-namespace pod: some-pod remote_path: /tmp/foo.txt content: "This content will be copied into remote file"
pod: description: - The pod name. required: true type: str host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str proxy: description: - The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY). type: str state: choices: - to_pod - from_pod default: to_pod description: - When set to C(to_pod), the local I(local_path) file or directory will be copied to I(remote_path) into the pod. - When set to C(from_pod), the remote file or directory I(remote_path) from pod will be copied locally to I(local_path). type: str api_key: description: - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. type: str ca_cert: aliases: - ssl_ca_cert description: - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. type: path content: description: - When used instead of I(local_path), sets the contents of a local file directly to the specified value. - Works only when I(remote_path) is a file. Creates the file if it does not exist. - For advanced formatting or if the content contains a variable, use the M(ansible.builtin.template) module. - Mutually exclusive with I(local_path). type: str context: description: - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. type: str no_proxy: description: - The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY). - This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct. - example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" type: str version_added: 2.3.0 version_added_collection: kubernetes.core password: description: - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. - Please read the description of the C(username) option for a discussion of when this option is applicable. type: str username: description: - Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. - Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the M(community.okd.k8s_auth) module, as that might do what you need. type: str container: description: - The name of the container in the pod to copy files/directories from/to. - Defaults to the only container if there is only one container in the pod. type: str namespace: description: - The pod namespace name. required: true type: str client_key: aliases: - key_file description: - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. type: path kubeconfig: description: - Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. - Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms. - The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0. type: raw local_path: description: - Path of the local file or directory. - Required when I(state) is set to C(from_pod). - Mutually exclusive with I(content). type: path client_cert: aliases: - cert_file description: - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. type: path no_preserve: default: false description: - The copied file/directory's ownership and permissions will not be preserved in the container. - This option is ignored when I(content) is set or when I(state) is set to C(from_pod). type: bool remote_path: description: - Path of the file or directory to copy. required: true type: path proxy_headers: description: - The Header used for the HTTP proxy. - Documentation can be found here U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers). suboptions: basic_auth: description: - Colon-separated username:password for basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment. type: str proxy_basic_auth: description: - Colon-separated username:password for proxy basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment. type: str user_agent: description: - String representing the user-agent you want, such as foo/1.0. - Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment. type: str type: dict version_added: 2.0.0 version_added_collection: kubernetes.core persist_config: description: - Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable. - When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file. - Default to false. - Please note that the current version of the k8s python client library does not support setting this flag to True yet. - 'The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169' type: bool validate_certs: aliases: - verify_ssl description: - Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. type: bool impersonate_user: description: - Username to impersonate for the operation. - Can also be specified via K8S_AUTH_IMPERSONATE_USER environment. type: str version_added: 2.3.0 version_added_collection: kubernetes.core impersonate_groups: description: - Group(s) to impersonate for the operation. - 'Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2' elements: str type: list version_added: 2.3.0 version_added_collection: kubernetes.core
result: description: - message describing the copy operation successfully done. returned: success type: str