Модуль kubernetes.core.k8s_cp — копирование файлов и каталогов в под и из него.

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install kubernetes.core. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: kubernetes.core.k8s_cp.

Добавлено в kubernetes.core 2.2.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Использует клиент Kubernetes для Python, чтобы копировать файлы и каталоги в контейнеры внутри пода и из них.

Примечание

Для этого модуля имеется соответствующий плагин действия.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.9
kubernetes >= 24.2.0

Параметры

Параметр	Комментарии
api_key string	Токен для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.
ca_cert псевдонимы: ssl_ca_cert path	Путь к сертификату CA для аутентификации в API. Во избежание ошибок проверки сертификата необходимо указать полную цепочку сертификатов. Также можно задать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file path	Путь к сертификату для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file path	Путь к файлу ключа для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_KEY_FILE.
container string	Имя контейнера в поде, в который или из которого нужно копировать файлы/каталоги. Если в поде только один контейнер, используется он.
content string	Если указан вместо local_path, задаёт содержимое локального файла непосредственно указанным значением. Работает только в том случае, если remote_path указывает на файл. Создаёт файл, если он не существует. Для сложного форматирования или если содержимое включает переменную используйте модуль ansible.builtin.template. Несовместим с параметром local_path.
context string	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
host string	URL для доступа к API. Также можно задать с помощью переменной окружения K8S_AUTH_HOST.
impersonate_groups list / элементы типа string добавлено в kubernetes.core 2.3.0	Группа или группы, от имени которых выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user string добавлено в kubernetes.core 2.3.0	Имя пользователя, от имени которого выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER.
kubeconfig any	Путь к существующему файлу конфигурации Kubernetes. Если он не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, разделив их символом «;» в Windows или «:» на других платформах. Конфигурацию Kubernetes можно передать в виде словаря. Для этой функции требуется версия клиента Kubernetes для Python >= 17.17.0. Добавлено в версии 2.2.0.
local_path path	Путь к локальному файлу или каталогу. Обязателен, если параметр state имеет значение `from_pod`. Несовместим с параметром content.
namespace string / обязательный	Имя пространства имён пода.
no_preserve boolean	Владение и права доступа скопированного файла/каталога не будут сохранены в контейнере. Этот параметр игнорируется, если задан content или если параметр state имеет значение `from_pod`. Варианты: `false` ← (по умолчанию) `true`
no_proxy string добавлено в kubernetes.core 2.3.0	Список хостов/доменов/IP-адресов/CIDR через запятую, для которых не следует использовать прокси. Также можно задать с помощью переменной окружения K8S_AUTH_NO_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, NO_PROXY). Для этой функции требуется kubernetes>=19.15.0. Если версия библиотеки kubernetes ниже 19.15.0, модуль завершится с ошибкой, даже если no_proxy задан корректно. Пример значения: “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”
password string	Пароль для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_PASSWORD. Описание параметра `username` содержит пояснение о том, в каких случаях применим этот параметр.
persist_config boolean	Сохранять ли токены обновления конфигурации kube. Также можно задать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG. Если контекст k8s использует учётные данные пользователя с токенами обновления (например, oidc или аутентификацию gke/gcloud), токен обновляется клиентской библиотекой k8s для Python, но по умолчанию не сохраняется. Поэтому срок действия старого токена обновления может истечь, и при следующей аутентификации может произойти сбой. Если установить этот флаг в true, клиентская библиотека k8s для Python сохранит новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки k8s для Python пока не поддерживает установку этого флага в True. Исправление для этой библиотеки k8s находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
pod string / обязательный	Имя пода.
proxy string	URL HTTP-прокси, используемого для подключения. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, HTTP_PROXY).
proxy_headers dictionary добавлено в kubernetes.core 2.0.0	Заголовок, используемый для HTTP-прокси. Документация доступна здесь: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
basic_auth string	Имя пользователя и пароль через двоеточие для заголовка базовой аутентификации. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth string	Имя пользователя и пароль через двоеточие для заголовка базовой аутентификации прокси. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent string	Строка с желаемым значением user-agent, например foo/1.0. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
remote_path path / обязательный	Путь к копируемому файлу или каталогу.
state string	Если задано значение `to_pod`, локальный файл или каталог local_path будет скопирован в под по пути remote_path. Если задано значение `from_pod`, удалённый файл или каталог remote_path будет скопирован из пода в локальное расположение local_path. Варианты: `"to_pod"` ← (по умолчанию) `"from_pod"`
username string	Имя пользователя для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_USERNAME. Обратите внимание: этот параметр работает только с кластерами, настроенными на использование HTTP Basic Auth. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), параметр не будет работать ожидаемым образом. В таком случае рассмотрите модуль community.okd.k8s_auth — возможно, он подойдёт для вашей задачи.
validate_certs псевдонимы: verify_ssl boolean	Проверять ли SSL-сертификаты сервера API. Также можно задать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`

Примечания

Примечание

При копировании из локальной файловой системы в под в контейнере требуется двоичный файл tar.
Перед копированием файлов или каталогов в контейнер он должен быть запущен (в том числе init-контейнер).
Во избежание ошибок проверки SSL-сертификата, если validate_certs имеет значение True, необходимо передать полную цепочку сертификатов сервера API через ca_cert или в файле kubeconfig.

Примеры

# 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"

Возвращаемые значения

Описание часто встречающихся возвращаемых значений приведено здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
result string	Сообщение с описанием успешно выполненной операции копирования. Возвращается: success

Авторы

Aubin Bikouo (@abikouo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubernetes/core/k8s_cp_module.html