k8s_facts – Описание объектов Kubernetes (K8s)

Новое в версии 2.7.

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

Обзор

Используйте OpenShift Python клиент для выполнения операций чтения над объектами K8s.
Доступ ко всему спектру API K8s.
Авторизуйтесь с помощью файла конфигурации, сертификатов, пароля или токена.
Поддерживает режим проверки.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key -		Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
api_version -	По умолчанию: "v1"	Используется для указания версии API. В сочетании с kind, name и namespace для идентификации конкретного объекта. псевдонимы: api, version
cert_file -		Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE.
context -		Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную окружения K8S_AUTH_CONTEXT.
field_selectors -		Список селекторов полей для фильтрации результатов
host -		Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST.
key_file -		Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_HOST.
kind - / обязательно		Используется для указания модели объекта. Используйте в сочетании с api_version, name и namespace для идентификации конкретного объекта.
kubeconfig -		Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG.
label_selectors -		Список селекторов меток для фильтрации результатов
name -		Используется для указания имени объекта. Используйте в сочетании с api_version, kind и namespace для идентификации конкретного объекта.
namespace -		Используется для указания пространства имен объекта. Используйте в сочетании с api_version, kind и name для идентификации конкретного объекта.
password -		Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD.
ssl_ca_cert -		Путь к сертификату CA, используемому для аутентификации с API. Для предотвращения ошибок проверки сертификатов должен быть предоставлен полный цепочка сертификатов. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT.
username -		Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME.
verify_ssl boolean	Варианты: no yes	Выполнять ли проверку SSL-сертификатов сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL.

Примечания

Примечание

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

Примеры

- name: Get an existing Service object
  k8s_facts:
    api_version: v1
    kind: Service
    name: web
    namespace: testing
  register: web_service

- name: Get a list of all service objects
  k8s_facts:
    api_version: v1
    kind: Service
    namespace: testing
  register: service_list

- name: Get a list of all pods from any namespace
  k8s_facts:
    kind: Pod
  register: pod_list

- name: Search for all Pods labelled app=web
  k8s_facts:
    kind: Pod
    label_selectors:
      - app = web
      - tier in (dev, test)

- name: Search for all running pods
  k8s_facts:
    kind: Pod
    field_selectors:
      - status.phase = running

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

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

Ключ		Возвращаемое значение	Описание
resources complex		success	Объект(ы), которые существуют
	api_version string	success	Версионированная схема этого представления объекта.
	kind string	success	Представляет REST-ресурс, который представляет этот объект.
	metadata dictionary	success	Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т.д.
	spec dictionary	success	Конкретные атрибуты объекта. Будут отличаться в зависимости от api_version и kind.
	status dictionary	success	Текущий статус объекта.

Статус

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

Авторы

Will Thames (@willthames)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/k8s_facts_module.html