модуль community.okd.openshift_process — обработка шаблона OpenShift template.openshift.io/v1

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.

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 можно передать в виде словаря. Для этой возможности требуется версия клиента Python kubernetes >= 17.17.0. Добавлено в версии 2.2.0.

name

string

Имя обрабатываемого шаблона Template.

Шаблон Template должен присутствовать в кластере.

Если параметр указан, требуется параметр namespace.

Несовместим с параметрами resource_definition и src.

namespace

string

Пространство имён, в котором находится шаблон.

namespace_target

string

Пространство имён, в котором следует создавать, обновлять или удалять ресурсы.

Используется только при значении state present или absent.

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”

parameter_file

string

Путь к файлу со значениями параметров шаблона, которые следует задать или переопределить в Template.

Соответствует аргументу `--param-file` команды oc process.

parameters

dictionary

Набор пар ключ: значение, используемых для задания или переопределения значений в Template.

Соответствует аргументу `--param` команды oc process.

password

string

Пароль для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_PASSWORD.

Описание параметра username содержит пояснение, в каких случаях применим этот параметр.

persist_config

boolean

Следует ли сохранять токены обновления kube config. Также можно указать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG.

Если контекст k8s использует учётные данные пользователя с токенами обновления (например, oidc или аутентификацию gke/gcloud), библиотека клиента Python k8s обновит токен, но по умолчанию не сохранит его. В результате срок действия старого токена обновления может истечь, и следующая аутентификация завершится ошибкой. Если задать этому параметру значение true, клиенту Python k8s будет указано сохранять новый токен обновления в файле конфигурации kube.

По умолчанию — false.

Обратите внимание: текущая версия библиотеки клиента Python k8s пока не поддерживает установку этого параметра в True.

Исправление для этой библиотеки Python k8s доступно здесь: https://github.com/kubernetes-client/python-base/pull/169

Возможные значения:

• false
• true

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.

resource_definition

псевдонимы: definition, inline

string

Укажите корректное определение YAML (строкой, списком или словарём) объекта при его создании или обновлении.

ПРИМЕЧАНИЕ: значения kind, api_version, name и namespace будут заменены соответствующими значениями из указанного resource_definition.

src

path

Укажите путь к файлу с корректным определением объекта или объектов в формате YAML для создания или обновления. Несовместим с параметром resource_definition. ПРИМЕЧАНИЕ: значения kind, api_version, name и namespace будут заменены соответствующими значениями из конфигурации, прочитанной из файла src.

Чтение выполняется из локальной файловой системы. Для чтения из файловой системы контроллера Ansible, включая файлы с хранилищем, используйте плагин подстановки file или template вместе с фильтром from_yaml и передайте результат параметру resource_definition. См. примеры ниже.

URL файлов манифеста, которые можно использовать для создания ресурса. Добавлено в версии 2.4.0.

Несовместим с параметром template в модуле kubernetes.core.k8s.

state

string

Определяет действие с обработанным шаблоном.

Значение rendered обрабатывает шаблон с учётом заданных параметров и возвращает обработанные объекты в поле resources. На эти объекты можно ссылаться в последующих задачах.

Значение present приводит к созданию ресурсов из обработанного шаблона, если они ещё не существуют, и их обновлению с помощью patch, если они существуют.

Значение absent удаляет ресурсы из обработанного шаблона.

Возможные значения:

• "absent"
• "present"
• "rendered" ← (по умолчанию)

username

string

Имя пользователя для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_USERNAME.

Обратите внимание: это работает только с кластерами, настроенными для использования базовой HTTP-аутентификации. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать как ожидается; возможно, вам подойдёт модуль community.okd.k8s_auth.

validate_certs

псевдонимы: verify_ssl

boolean

Следует ли проверять SSL-сертификаты сервера API. Также можно указать с помощью переменной окружения K8S_AUTH_VERIFY_SSL.

Возможные значения:

• false
• true

wait

boolean

Следует ли ожидать перехода ресурсов определённых типов в требуемое состояние.

По умолчанию модуль завершает работу после получения запроса Kubernetes.

Реализовано для state=present для Deployment, DaemonSet и Pod, а также для state=absent для всех типов ресурсов.

Для типов ресурсов без реализации wait возвращает результат немедленно, если не задан параметр wait_condition.

Возможные значения:

• false ← (по умолчанию)
• true

wait_condition

dictionary

Задаёт пользовательское условие для поля status, которого следует ожидать.

Игнорируется, если wait не задан или имеет значение False.

reason

string

Значение поля reason в требуемом условии.

Например, если Deployment приостановлен, Progressing type будет иметь значение reason DeploymentPaused.

Допустимые значения reason в условии зависят от типа ресурса Kubernetes.

Возможные значения см. в документации API для поля status соответствующего ресурса.

status

string

Значение поля status в требуемом условии.

Например, если Deployment приостановлен, Progressing type будет иметь значение status Unknown.

Возможные значения:

• "True" ← (по умолчанию)
• "False"
• "Unknown"

type

string

Тип ожидаемого условия.

Например, ресурс Pod задаёт условие Ready (среди прочих).

Обязателен, если указан параметр wait_condition.

Если оставить поле пустым, поле wait_condition будет проигнорировано.

Допустимые типы условия зависят от типа ресурса Kubernetes.

Возможные значения см. в документации API для поля status соответствующего ресурса.

wait_sleep

integer

Количество секунд ожидания между проверками.

По умолчанию: 5

wait_timeout

integer

Время ожидания перехода ресурса в требуемое состояние, в секундах.

Игнорируется, если wait не задан.

По умолчанию: 120

resources

complex

Отрисованные ресурсы, определённые в Template

Возвращается: при успешном выполнении, если значение state — rendered

apiVersion

string

Версионированная схема этого представления объекта.

Возвращается: при успешном выполнении

kind

string

Представляет REST-ресурс, который представляет этот объект.

Возвращается: при успешном выполнении

metadata

complex

Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д.

Возвращается: при успешном выполнении

name

string

Имя ресурса

Возвращается: при успешном выполнении

namespace

string

Пространство имён ресурса

Возвращается: при успешном выполнении

spec

dictionary

Определённые атрибуты объекта. Зависит от значений api_version и kind.

Возвращается: при успешном выполнении

status

dictionary

Текущие сведения о состоянии объекта.

Возвращается: при успешном выполнении

conditions

complex

Массив условий состояния объекта. Их наличие не гарантируется

Возвращается: при успешном выполнении

result

complex

Созданный, исправленный или иным образом присутствующий объект. При удалении будет пустым.

Возвращается: при успешном выполнении, если значение state — present или absent

apiVersion

string

Версионированная схема этого представления объекта.

Возвращается: при успешном выполнении

duration

integer

время выполнения задачи в секундах

Возвращается: если wait имеет значение true

Пример: 48

items

list / elements=string

Возвращается, только если в src или resource_definition передано несколько документов YAML

Возвращается: если resource_definition или src содержит список объектов

kind

string

Представляет REST-ресурс, который представляет этот объект.

Возвращается: при успешном выполнении

metadata

complex

Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д.

Возвращается: при успешном выполнении

name

string

Имя ресурса

Возвращается: при успешном выполнении

namespace

string

Пространство имён ресурса

Возвращается: при успешном выполнении

spec

dictionary

Определённые атрибуты объекта. Зависит от значений api_version и kind.

Возвращается: при успешном выполнении

status

complex

Текущие сведения о состоянии объекта.

Возвращается: при успешном выполнении

conditions

complex

Массив условий состояния объекта. Их наличие не гарантируется

Возвращается: при успешном выполнении