kubevirt – Источник инвентаризации KubeVirt
Новая версия с 2.8.
Описание
- Получение запущенных VirtualMachines для одного или нескольких пространств имён.
- Группировка по пространству имён, namespace_vms и меткам.
- Использует файл конфигурации kubevirt.(yml|yaml) YAML для задания значений параметров.
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, выполняющем эту инвентаризацию.
- openshift >= 0.6
- PyYAML >= 3.11
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии | |
|---|---|---|---|---|
| cache boolean |
| Записи ini: [inventory] переменная окружения:ANSIBLE_INVENTORY_CACHE | Включение/выключение кэширования данных источника инвентаризации, требует настройки плагина кэша для работы. | |
| cache_connection строка | Записи ini: [defaults] [inventory] переменная окружения:ANSIBLE_CACHE_PLUGIN_CONNECTION переменная окружения:ANSIBLE_INVENTORY_CACHE_CONNECTION | Данные подключения к кэшу или путь, см. документацию плагина кэша для деталей. | ||
| cache_plugin строка | По умолчанию: "память" | Записи ini: [defaults] [inventory] переменная окружения:ANSIBLE_CACHE_PLUGIN переменная окружения:ANSIBLE_INVENTORY_CACHE_PLUGIN | Плагин кэша для использования данных источника инвентаризации. | |
| cache_prefix - | По умолчанию: "ansible_inventory_" | Записи ini: [default] [inventory] переменная окружения:ANSIBLE_CACHE_PLUGIN_PREFIX переменная окружения:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX | Префикс для использования файлов/таблиц плагина кэша | |
| cache_timeout целое число | По умолчанию: 3600 | Записи ini: [defaults] [inventory] переменная окружения:ANSIBLE_CACHE_PLUGIN_TIMEOUT переменная окружения:ANSIBLE_INVENTORY_CACHE_TIMEOUT | Время кэширования в секундах | |
| compose словарь | По умолчанию: {} | Создание переменных из выражений jinja2. | ||
| connections список | Необязательный список параметров подключения к кластеру. Если не указаны подключения, используется по умолчанию ~/.kube/config и активный контекст, и будут возвращены объекты для всех пространств имён, к которым активный пользователь имеет права доступа. | |||
| annotation_variable строка | По умолчанию: "ansible" | Укажите имя аннотации, которая предоставляет данные, которые должны использоваться как переменные узла инвентаризации. Обратите внимание, что значение в аннотациях ansible должно быть json. | ||
| api_key строка | Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY. | |||
| api_version строка | Укажите версию API KubeVirt. | |||
| cert_file строка | Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE. | |||
| context строка | Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную окружения K8S_AUTH_CONTEXT. | |||
| host строка | Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST. | |||
| key_file строка | Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_HOST. | |||
| kubeconfig строка | Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. | |||
| name строка | Необязательное имя для назначения кластера. Если не указано, имя строится из сервера и порта. | |||
| namespaces список | Список пространств имён. Если не указан, будут извлечены все виртуальные машины для всех пространств имён, к которым пользователь имеет права доступа. | |||
| network_name строка | В случае наличия нескольких сетевых подключений к виртуальной машине, определите, какой интерфейс должен возвращаться в качестве основного IP-адреса. | |||
| password строка | Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. | |||
| ssl_ca_cert строка | Путь к сертификату CA, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT. | |||
| username строка | Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. | |||
| verify_ssl boolean |
| Требовать проверку сертификатов SSL сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL. | ||
| groups словарь | По умолчанию: {} | Добавить узлы в группу на основе условных выражений Jinja2. | ||
| host_format - | По умолчанию: "{namespace}-{name}-{uid}" | Укажите формат узла в группе инвентаризации. | ||
| keyed_groups список | По умолчанию: [] | Добавить узлы в группу на основе значений переменной. | ||
| plugin строка / обязательный |
| токен, гарантирующий, что это исходный файл для плагина '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: 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: kubevirt
connections:
- namespaces:
- vms
network_name: myovsnetwork
Статус
- Гарантируется совместимость с предыдущими версиями интерфейса этой инвентаризации. [превью]
- Эта инвентаризация поддерживается сообществом 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.9/plugins/inventory/kubevirt.html
