community.kubernetes.k8s_rollback – Откат развертываний и демонов Kubernetes (K8S)

Примечание

Этот плагин входит в коллекцию community.kubernetes (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install community.kubernetes.

Для использования в книге задач укажите: community.kubernetes.k8s_rollback.

Новое в версии 1.0.0: из community.kubernetes

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Используйте Python-клиент OpenShift для выполнения откатки.
Авторизуйтесь с помощью файла конфигурации, сертификатов, пароля или токена.
Аналогично команде kubectl rollout undo.

Требования

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

python >= 2.7
openshift >= 0.6
PyYAML >= 3.11

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY.
api_version строка	Значение по умолчанию: "v1"	Используется для указания версии API. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется совместно с kind, name и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение apiVersion из resource_definition переопределит этот параметр. псевдонимы: api, version
ca_cert путь		Путь к сертификату CA, используемому для аутентификации с API. Для предотвращения ошибок проверки сертификатов необходимо предоставить полный цепочку сертификатов. Также может быть задан через переменную окружения K8S_AUTH_SSL_CA_CERT. псевдонимы: ssl_ca_cert
client_cert путь		Путь к сертификату, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_CERT_FILE. псевдонимы: cert_file
client_key путь		Путь к файлу ключа, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_KEY_FILE. псевдонимы: key_file
context строка		Имя контекста, найденного в файле конфигурации. Также может быть задан через переменную окружения K8S_AUTH_CONTEXT.
field_selectors список / элементы=строка		Список селекторов полей для фильтрации результатов.
host строка		Укажите URL для доступа к API. Также может быть задан через переменную окружения K8S_AUTH_HOST.
kind строка		Используется для указания модели объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется совместно с api_version, name и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение kind из resource_definition переопределит этот параметр.
kubeconfig путь		Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть задан через переменную окружения K8S_AUTH_KUBECONFIG.
label_selectors список / элементы=строка		Список селекторов меток для фильтрации результатов.
name строка		Используется для указания имени объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется совместно с api_version, kind и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение metadata.name из resource_definition переопределит этот параметр.
namespace строка		Используется для указания пространства имен объекта. Полезно при создании, удалении или поиске объекта без предоставления полного определения ресурса. Используется совместно с api_version, kind и name для идентификации конкретного объекта. Если предоставлено определение ресурса, значение metadata.namespace из resource_definition переопределит этот параметр.
password строка		Укажите пароль для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_PASSWORD. Пожалуйста, ознакомьтесь с описанием параметра `username`, чтобы понять, когда этот параметр применим.
persist_config булево	Варианты: no yes	Сохранять ли токены обновления конфигурации 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
proxy строка		URL HTTP-прокси для подключения. Также может быть задан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует типичные настройки прокси из окружения (например, HTTP_PROXY).
username строка		Укажите имя пользователя для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер имеет другой вид аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует ознакомиться с модулем `k8s_auth`, так как он может выполнить необходимую задачу.
validate_certs булево	Варианты: no yes	Проверять ли SSL-сертификаты сервера API. Также может быть задан через переменную окружения K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl

Примечания

Примечание

Python-клиент OpenShift оборачивает K8s Python-клиент, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версиях API и дополнительную информацию см. на странице https://github.com/openshift/openshift-restclient-python
Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, необходимо предоставить полную цепочку сертификатов сервера API через ca_cert или в файле kubeconfig.

Примеры

- name: Rollback a failed deployment
  community.kubernetes.k8s_rollback:
    api_version: apps/v1
    kind: Deployment
    name: web
    namespace: testing

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

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

Ключ		Возвращаемое значение	Описание
rollback_info сложный		success	Объект, который был откачен.
	api_version строка	success	Версионированная схема этого представления объекта.
	code строка	success	HTTP-код ответа
	kind строка	success	Статус
	metadata словарь	success	Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т. д.
	status словарь	success	Текущие подробности состояния объекта.

Авторы

Julien Huon (@julienhuon)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_rollback_module.html