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

Примечание

Этот модуль является частью коллекции kubernetes.core (версия 3.2.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 aliases: ssl_ca_cert path	Путь к сертификату CA, используемому для аутентификации с API. Для избежания ошибок проверки сертификата необходимо предоставить полную цепочку сертификатов. Также может быть указан через переменную среды K8S_AUTH_SSL_CA_CERT.
client_cert aliases: cert_file path	Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_CERT_FILE.
client_key aliases: 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 / elements=string added in kubernetes.core 2.3.0	Группа(ы), от имени которой(ых) выполняется операция. Также может быть указана через переменную среды K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user string added in kubernetes.core 2.3.0	Имя пользователя, от имени которого выполняется операция. Также может быть указано через переменную среды K8S_AUTH_IMPERSONATE_USER.
kubeconfig any	Путь к существующему файлу конфигурации Kubernetes. Если не указан, и другие параметры подключения не предоставлены, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также может быть указан через переменную среды K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, используя разделитель «;» для платформы Windows или «:» для других платформ. Конфигурацию Kubernetes можно предоставить в виде словаря. Эта функция требует версии клиента python kubernetes >= 17.17.0. Добавлено в версии 2.2.0.
local_path path	Путь к локальному файлу или директории. Требуется, когда state установлен в `from_pod`. Взаимоисключающий с content.
namespace string / required	Имя пространства имен под.
no_preserve boolean	Владение и разрешения скопированного файла/директории не будут сохранены в контейнере. Этот параметр игнорируется, когда установлен content или когда state установлен в `from_pod`. Варианты: `false` ← (по умолчанию) `true`
no_proxy string added in 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 auth), токен обновляется библиотекой клиента python k8s, но по умолчанию не сохраняется. Таким образом, старый токен обновления может истечь, и следующая авторизация может завершиться ошибкой. Установка этого флага в true сообщит клиенту python k8s сохранить новый токен обновления в файл конфигурации kube. По умолчанию false. Обратите внимание, что текущая версия библиотеки клиента python k8s еще не поддерживает установку этого флага в True. Исправление для этой библиотеки python k8s находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`

pod строка / обязательно	Имя под.
proxy строка	URL HTTP-прокси, используемого для подключения. Также может быть указан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует стандартные настройки прокси из среды (например, HTTP_PROXY).
proxy_headers словарь добавлен в 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 строка	Разделенные двоеточием имя пользователя:пароль для заголовка базовой аутентификации. Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth строка	Разделенные двоеточием имя пользователя:пароль для заголовка базовой аутентификации прокси. Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent строка	Строка, представляющая пользователя-агента, например, foo/1.0. Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
remote_path путь / обязательно	Путь к файлу или каталогу для копирования.
state строка	При значении `to_pod`, локальный файл или каталог local_path будет скопирован в remote_path в под. При значении `from_pod`, удалённый файл или каталог remote_path из под будет скопирован локально в local_path. Варианты: `"to_pod"` ← (по умолчанию) `"from_pod"`
username строка	Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер использует другой вид аутентификации (например, OAuth2 в OpenShift), этот параметр не сработает должным образом, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может быть более подходящим.
validate_certs псевдонимы: verify_ssl логическое	Нужно ли проверять SSL-сертификаты API-сервера. Также может быть указано через переменную окружения K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`

Примечания

Примечание

бинарный файл tar необходим в контейнере при копировании из локальной файловой системы в под.
Чтобы избежать ошибок проверки 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 строка	сообщение, описывающее успешно выполненную операцию копирования. Возвращается: success

Авторы

Aubin Bikouo (@abikouo)

Ссылки на сборку

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