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

Примечание

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

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

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

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

Описание

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

Примечание

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

Требования

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

python >= 2.7
openshift >= 0.6.2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
apply булево	Варианты: нет да	`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 булево	Варианты: нет ← да	Если установлено в `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` если вы видите "формат стратегического слияния патчей не поддерживается" См. 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 булево	Варианты: нет да	Сохранять ли токен обновления конфигурации 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 словарь		Селекторы меток идентифицируют объекты, к которым должен применяться этот Service. 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 строка	Варианты: отсутствует есть ←	Определяет, должен ли объект быть создан, изменен или удален. Если установлено в `present`, объект будет создан, если он еще не существует. Если установлено в `absent`, существующий объект будет удален. Если установлено в `present`, существующий объект будет изменен, если его атрибуты отличаются от указанных с помощью resource_definition или src.
type строка	Варианты: NodePort ClusterIP LoadBalancer ExternalName	Определяет тип Service, который нужно создать. См. 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 булево	Варианты: нет да	Подтверждать ли 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/kubernetes/k8s_service_module.html