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

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

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

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

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

Псевдонимы: k8s_facts

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
api_version -	Значение по умолчанию: "v1"	Используется для указания версии API. В сочетании с kind, name и namespace для идентификации конкретного объекта. Псевдонимы: api, версия
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` для обсуждения случаев её применения.
proxy - добавлено в 2.9		URL HTTP-прокси, используемого для подключения. Также может быть указан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не подхватывает типичные настройки прокси из среды (например, HTTP_PROXY).
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: Get an existing Service object
  k8s_info:
    api_version: v1
    kind: Service
    name: web
    namespace: testing
  register: web_service

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

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

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

- name: Search for all running pods
  k8s_info:
    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.9/modules/k8s_info_module.html