Модуль kubernetes.core.k8s_service – Управление службами в Kubernetes

Примечание

Этот модуль является частью коллекции kubernetes.core (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install kubernetes.core. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

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

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

Краткое описание

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

Примечание

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

Требования

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

python >= 3.9
kubernetes >= 24.2.0

Параметры

Параметр	Комментарии
api_key string	Токен, используемый для аутентификации с API. Может быть также указан через переменную окружения K8S_AUTH_API_KEY.
apply boolean	`apply` compares the desired resource definition with the previously supplied resource definition, ignoring properties that are automatically generated `apply` works better with Services than ‘force=yes’ mutually exclusive with `merge_type` Варианты: `false` ← (default) `true`
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.
context string	Имя контекста, найденного в конфигурационном файле. Может быть также указан через переменную окружения K8S_AUTH_CONTEXT.
force boolean	Если установлено в `yes`, и state равен `present`, существующий объект будет заменен. Варианты: `false` ← (default) `true`
host string	Укажите URL для доступа к API. Может быть также указан через переменную окружения K8S_AUTH_HOST.
impersonate_groups list / elements=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.
merge_type list / elements=string	Следует ли переопределить стандартный подход к слиянию патчей определенным типом. По умолчанию обычно используется стратегическое слияние. Например, определения пользовательских ресурсов обычно не могут быть обновлены с помощью обычного стратегического слияния. Возможно, потребуется использовать `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 Если указано более одного `merge_type`, типы слияния будут опробованы в указанном порядке По умолчанию используется `['strategic-merge', 'merge']`, что идеально подходит для использования одних и тех же параметров для типов ресурсов, которые объединяют пользовательские ресурсы и встроенные ресурсы. Варианты: `"json"` `"merge"` `"strategic-merge"`
name string / required	Используется для указания имени объекта Service.
namespace string / required	Используется для указания пространства имен объекта Service.
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”
password string	Укажите пароль для аутентификации с API. Может быть также указан через переменную окружения K8S_AUTH_PASSWORD. Пожалуйста, ознакомьтесь с описанием параметра `username` для обсуждения случаев применения этого параметра.

persist_config boolean	Сохранять ли токены обновления kube config. Также может быть указано через переменную среды K8S_AUTH_PERSIST_CONFIG. Когда контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой клиента k8s python, но по умолчанию не сохраняется. Таким образом, старый токен обновления может истечь, и следующая авторизация может завершиться неудачей. Установка этого флага в true укажет клиенту k8s python сохранить новый токен обновления в файл kube config. По умолчанию false. Обратите внимание, что текущая версия библиотеки клиента k8s python ещё не поддерживает установку этого флага в True. Исправление для этой библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
ports list / elements=dictionary	Список портов для экспорта. https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services
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 aliases: definition, inline string	Предоставьте валидное YAML-определение (строкой, списком или словарем) для объекта при создании или обновлении. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в предоставленном resource_definition.
selector dictionary	Селекторы меток идентифицируют объекты, к которым должен применяться этот сервис. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
src path	Укажите путь к файлу, содержащему валидное YAML-определение объекта или объектов, которые необходимо создать или обновить. Взаимоисключаемо с resource_definition. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в конфигурации, прочитанной из файла src. Читает из локальной файловой системы. Для чтения из файловой системы контроллера Ansible, включая зашифрованные файлы, используйте плагин поиска файлов или плагин поиска шаблонов в сочетании с фильтром from_yaml и передайте результат в resource_definition. См. примеры ниже. URL-адрес к файлам манифеста, которые могут использоваться для создания ресурса. Добавлено в версии 2.4.0. Взаимоисключаемо с template в случае модуля kubernetes.core.k8s.
state string	Определяет, должен ли объект быть создан, исправлен или удален. Когда установлено в `present`, объект будет создан, если он ещё не существует. Если установлено в `absent`, существующий объект будет удален. Если установлено в `present`, существующий объект будет исправлен, если его атрибуты отличаются от тех, которые указаны с помощью resource_definition или src. Варианты: `"absent"` `"present"` ← (по умолчанию)
type string	Указывает тип сервиса для создания. См. https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types Варианты: `"NodePort"` `"ClusterIP"` `"LoadBalancer"` `"ExternalName"`
username string	Предоставьте имя пользователя для аутентификации с API. Также может быть указано через переменную среды K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер имеет другую форму аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует изучить модуль community.okd.k8s_auth, так как он может сделать то, что вам нужно.
validate_certs aliases: verify_ssl boolean	Проверять ли SSL-сертификаты сервера API. Также может быть указано через переменную среды K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`

Примечания

Примечание

Чтобы избежать ошибок проверки SSL-сертификата, когда validate_certs равно True, необходимо предоставить полную цепочку сертификатов для API-сервера через ca_cert или в файле kubeconfig.

Примеры

- name: Expose https port with ClusterIP
  kubernetes.core.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
  kubernetes.core.k8s_service:
    state: present
    name: test-https
    namespace: default
    inline:
      spec:
        ports:
        - port: 443
          protocol: TCP
        selector:
          key: special

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

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

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

Авторы

KubeVirt Team (@kubevirt)

Ссылки на коллекцию

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