community.general.kubevirt – Источник инвентаризации KubeVirt

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в плейбуке укажите: community.general.kubevirt

Описание
Требования
Параметры
Примеры

Описание

Получение запущенных VirtualMachines для одного или нескольких пространств имён.
Группировка по пространству имён, namespace_vms и меткам.
Использует файл конфигурации kubevirt.(yml|yaml) YAML для установки значений параметров.

Требования

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

openshift >= 0.6
PyYAML >= 3.11

Параметры

Параметр		Варианты/Значения по умолчанию	Конфигурация	Комментарии
cache boolean		Варианты: нет ← да	записи в ini: [inventory] cache = нет переменная окружения:ANSIBLE_INVENTORY_CACHE	Включает/отключает кэширование данных источника инвентаризации, требует настройки плагина кэша для работы.
cache_connection string			записи в ini: [defaults] fact_caching_connection = None [inventory] cache_connection = None переменная окружения:ANSIBLE_CACHE_PLUGIN_CONNECTION переменная окружения:ANSIBLE_INVENTORY_CACHE_CONNECTION	Данные или путь к соединению кэша, см. документацию по плагинам кэша для получения подробной информации.
cache_plugin string		По умолчанию: "память"	записи в ini: [defaults] fact_caching = память [inventory] cache_plugin = память переменная окружения:ANSIBLE_CACHE_PLUGIN переменная окружения:ANSIBLE_INVENTORY_CACHE_PLUGIN	Плагин кэша для использования данных источника инвентаризации.
cache_prefix string		По умолчанию: "ansible_inventory_"	записи в ini: [default] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ переменная окружения:ANSIBLE_CACHE_PLUGIN_PREFIX переменная окружения:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX	Префикс для использования файлов/таблиц плагина кэша
cache_timeout integer		По умолчанию: 3600	записи в ini: [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 переменная окружения:ANSIBLE_CACHE_PLUGIN_TIMEOUT переменная окружения:ANSIBLE_INVENTORY_CACHE_TIMEOUT	Срок действия кэша в секундах
compose dictionary		По умолчанию: {}		Создаёт переменные из выражений jinja2.
connections list / elements=string				Необязательный список настроек соединения кластера. Если соединения не указаны, будет использоваться стандартный файл ~/.kube/config и активный контекст, и объекты будут возвращены для всех пространств имен, к которым активный пользователь имеет доступ.
	annotation_variable string	По умолчанию: "ansible"		Укажите имя аннотации, которая предоставляет данные, которые должны использоваться как переменные узла инвентаризации. Обратите внимание, что значение в аннотациях ansible должно быть json.
	api_key string			Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
	api_version string			Укажите версию API KubeVirt.
	cert_file string			Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE.
	context string			Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную окружения K8S_AUTH_CONTEXT.
	host string			Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST.
	key_file string			Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_HOST.
	kubeconfig string			Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры соединения, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG.
	name string			Необязательное имя для присвоения кластеру. Если не указано, имя строится из сервера и порта.
	namespaces list / elements=string			Список пространств имён. Если не указано, будут получены все виртуальные машины для всех пространств имён, к которым пользователь имеет доступ.
	network_name string			В случае нескольких сетевых подключений к виртуальной машине, определите, какой интерфейс должен возвращаться как основной IP-адрес. алиасы: имя_интерфейса
	password string			Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD.
	ssl_ca_cert string			Путь к сертификату CA, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT.
	username string			Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME.
	verify_ssl boolean	Варианты: нет да		Требовать проверку SSL-сертификатов сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL.
groups dictionary		По умолчанию: {}		Добавляет узлы в группу на основе условных выражений Jinja2.
host_format string		По умолчанию: "{namespace}-{name}-{uid}"		Укажите формат узла в группе инвентаризации.
keyed_groups list / elements=string		По умолчанию: []		Добавляет узлы в группу на основе значений переменной.
plugin string / required		Варианты: kubevirt community.general.kubevirt		токен, который гарантирует, что это исходный файл для плагина 'kubevirt'.
strict boolean		Варианты: нет ← да		Если `yes`, то невалидные записи являются ошибкой, в противном случае пропускаются и продолжаются. Поскольку использование фактов в выражениях возможно, они могут быть недоступны, и по умолчанию такие ошибки игнорируются.

Примеры

# File must be named kubevirt.yaml or kubevirt.yml

# Authenticate with token, and return all virtual machines for all namespaces
plugin: community.general.kubevirt
connections:
 - host: https://kubevirt.io
   token: xxxxxxxxxxxxxxxx
   ssl_verify: false

# Use default config (~/.kube/config) file and active context, and return vms with interfaces
# connected to network myovsnetwork and from namespace vms
plugin: community.general.kubevirt
connections:
  - namespaces:
      - vms
    network_name: myovsnetwork

Авторы

Команда 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.10/collections/community/general/kubevirt_inventory.html