community.kubernetes.k8s_service – Управление сервисами в Kubernetes

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.kubernetes.k8s_service.

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

Описание

Используйте Openshift Python SDK для управления сервисами в Kubernetes.

Примечание

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

Требования

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

python >= 2.7
openshift >= 0.6.2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY.
apply логическое	Варианты: no yes	`apply` сравнивает желаемое определение ресурса с ранее предоставленным определением ресурса, игнорируя свойства, которые автоматически генерируются `apply` работает лучше с сервисами, чем 'force=yes' взаимоисключающее с `merge_type`
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.
force логическое	Варианты: no ← yes	Если установлено в значение `yes`, и state равно `present`, существующий объект будет заменён.
host строка		Укажите URL для доступа к API. Также может быть задан через переменную окружения K8S_AUTH_HOST.
kubeconfig путь		Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть задан через переменную окружения K8S_AUTH_KUBECONFIG.
merge_type список / элементы=строка	Варианты: json merge strategic-merge	Метод объединения патчей по умолчанию может быть переопределён с помощью данного типа. По умолчанию обычно используется стратегическое объединение. Например, определения пользовательских ресурсов обычно не обновляются с помощью обычного стратегического объединения. Вы можете использовать `merge` если видите сообщение "strategic merge patch format is not supported" См. https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment Требуется openshift >= 0.6.2 Если указано несколько merge_type, типы объединения будут использоваться в заданном порядке Если openshift >= 0.6.2, по умолчанию `['strategic-merge', 'merge']`, что идеально подходит для использования одних и тех же параметров для типов ресурсов, которые объединяют пользовательские ресурсы и встроенные ресурсы. Для openshift < 0.6.2, значение по умолчанию `strategic-merge`.
name строка / обязательно		Используется для указания имени объекта Service.
namespace строка / обязательно		Используется для указания пространства имён объекта Service.
password строка		Укажите пароль для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_PASSWORD. Прочитайте описание параметра `username` для получения информации о том, когда этот параметр применим.
persist_config логическое	Варианты: no yes	Сохранять ли токен обновления конфигурации kube. Также может быть задан через переменную окружения K8S_AUTH_PERSIST_CONFIG. Когда контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой k8s python, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и следующая аутентификация может завершиться неудачно. Установка этого флага в значение true сообщит библиотеке k8s python о сохранении нового токена обновления в файле конфигурации kube. Значение по умолчанию false. Обратите внимание, что текущая версия библиотеки k8s python еще не поддерживает установку этого флага в значение True. Исправление для библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169
ports список / элементы=словарь		Список портов для экспонирования. https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services
proxy строка		URL HTTP-прокси, используемого для подключения. Также может быть задан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует типичные настройки прокси из среды (например, HTTP_PROXY).
resource_definition строка		Укажите действительное YAML-определение (в виде строки, списка или словаря) для объекта при создании или обновлении. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в предоставленном resource_definition. псевдонимы: definition, inline
selector словарь		Селекторы меток идентифицируют объекты, к которым должен применяться этот сервис. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
src путь		Укажите путь к файлу, содержащему действительное YAML-определение объекта или объектов, которые будут созданы или обновлены. Взаимоисключительно с resource_definition. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в конфигурации, считанной из файла src. Считывает данные из локальной файловой системы. Чтобы считывать данные из файловой системы контроллера Ansible, включая зашифрованные файлы, используйте плагин поиска файлов или плагин поиска шаблонов, в сочетании с фильтром from_yaml, и передайте результат в resource_definition. См. Примеры ниже. Взаимоисключительно с template в случае модуля k8s.
state строка	Варианты: absent present ←	Определяет, должен ли объект быть создан, изменён или удалён. При установке в значение `present`, объект будет создан, если он ещё не существует. При установке в значение `absent`, существующий объект будет удалён. При установке в значение `present`, существующий объект будет изменён, если его атрибуты отличаются от указанных с помощью resource_definition или src.
type строка	Варианты: NodePort ClusterIP LoadBalancer ExternalName	Указывает тип сервиса для создания. См. https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
username строка		Укажите имя пользователя для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер использует другой тип аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует обратиться к модулю `k8s_auth`, так как он может выполнять необходимые действия.
validate_certs логическое	Варианты: no yes	Проверять ли SSL-сертификаты сервера API. Также может быть задан через переменную окружения K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl

Примечания

Примечание

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

Примеры

- name: Expose https port with ClusterIP
  community.kubernetes.k8s_service:
    state: present
    name: test-https
    namespace: default
    ports:
    - port: 443
      protocol: TCP
    selector:
      key: special

- name: Expose https port with ClusterIP using spec
  community.kubernetes.k8s_service:
    state: present
    name: test-https
    namespace: default
    inline:
      spec:
        ports:
        - port: 443
          protocol: TCP
        selector:
          key: special

Значения возврата

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

Ключ		Возвращаемое значение	Описание
result complex		успех	Созданный, измененный или иначе присутствующий объект Service. Будет пустым в случае удаления.
	api_version строка	успех	Версионная схема этого представления объекта.
	kind строка	успех	Всегда 'Service'.
	metadata complex	успех	Стандартные метаданные объекта. Включают имя, пространство имен, аннотации, метки и т. д.
	spec complex	успех	Уникальные атрибуты объекта. Будут отличаться в зависимости от api_version и kind.
	status complex	успех	Текущие детали статуса объекта.

Авторы

Команда KubeVirt (@kubevirt)

© 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_service_module.html