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
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.
field_selectors -		Список селекторов полей для фильтрации результатов
host строка		Укажите URL для доступа к 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. Пожалуйста, ознакомьтесь с описанием опции `username` для обсуждения случаев, когда эта опция применима.
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 равно Истина, полная цепочка сертификатов для сервера API должна быть предоставлена через 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 сложный тип		успех	Объект(ы), которые существуют
	api_version строка	успех	Версионированная схема этого представления объекта.
	kind строка	успех	Представляет REST-ресурс, который представляет этот объект.
	metadata словарь	успех	Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т.д.
	spec словарь	успех	Конкретные атрибуты объекта. Будут отличаться в зависимости от api_version и kind.
	status словарь	успех	Текущие данные состояния объекта.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/k8s_facts_module.html