k8s_service – Управление службами в Kubernetes

Новая версия с 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

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

Требования

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

python >= 2.7
openshift >= 0.6.2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
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 логическое значение	Варианты: нет ← да	Если установлено в `True`, и состояние равно `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, merge_types будут использоваться в порядке следования Если openshift >= 0.6.2, значение по умолчанию `['strategic-merge', 'merge']`, что идеально подходит для использования одних и тех же параметров для типов ресурсов, которые объединяют пользовательские ресурсы и встроенные ресурсы. Для openshift < 0.6.2 значение по умолчанию просто `strategic-merge`.
name строка / обязательно		Используется для указания имени объекта Service.
namespace строка / обязательно		Используется для указания пространства имен объекта Service.
password строка		Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. Прочитайте описание параметра `username` для понимания, когда этот параметр применим.
ports список		Список портов для экспонирования. https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services
resource_definition словарь		Частичное YAML-определение объекта Service, создаваемого/обновляемого. Здесь можно задать параметры Kubernetes Service Resource, не покрытые параметрами этого модуля. ПРИМЕЧАНИЕ: resource_definition имеет более низкий приоритет, чем параметры модуля. Если вы попытаетесь определить, например, metadata.namespace здесь, это значение будет проигнорировано, и вместо него будет использоваться значение в metadata. псевдонимы: definition, inline
selector словарь		Селекторы меток идентифицируют объекты, к которым должна применяться эта служба. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
state -	Варианты: present ← absent	Определяет, должен ли объект быть создан, изменён или удалён. При установке в `present`, объект будет создан, если он ещё не существует. При установке в `absent`, существующий объект будет удалён. При установке в `present`, существующий объект будет изменён, если его атрибуты отличаются от тех, что указаны с помощью параметров модуля и resource_definition.
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
  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
  k8s_service:
    state: present
    name: test-https
    namespace: default
    inline:
      spec:
        ports:
        - port: 443
          protocol: TCP
        selector:
          key: special

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

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

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

Состояние

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Команда 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.8/modules/k8s_service_module.html