Spec-Zone.ru › Ansible

модуль kubevirt.core.kubevirt_vm_info – описание виртуальных машин KubeVirt

Примечание

Этот модуль входит в коллекцию kubevirt.core (версия 2.2.4).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install kubevirt.core. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: kubevirt.core.kubevirt_vm_info.

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

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

  • Использует клиент Kubernetes для Python для выполнения операций чтения с объектами KubeVirt VirtualMachines.
  • Параметры для поиска VirtualMachines передаются как аргументы модуля.
  • Поддерживается аутентификация с помощью файла конфигурации, сертификатов, пароля или токена.
  • Поддерживается режим проверки.

Требования

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

  • python >= 3.9
  • kubernetes >= 28.1.0
  • PyYAML >= 3.11

Параметры

Параметр

Комментарии

api_key

string

Токен для аутентификации в API.

Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.

api_version

string

Используйте этот параметр, чтобы задать версию API KubeVirt.

По умолчанию: "kubevirt.io/v1"

ca_cert

псевдонимы: ssl_ca_cert

path

Путь к сертификату центра сертификации, используемому для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо предоставить полную цепочку сертификатов.

Также можно задать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT.

client_cert

псевдонимы: cert_file

path

Путь к сертификату, используемому для аутентификации в API.

Также можно задать с помощью переменной окружения K8S_AUTH_CERT_FILE.

client_key

псевдонимы: key_file

path

Путь к файлу ключа, используемого для аутентификации в API.

Также можно задать с помощью переменной окружения K8S_AUTH_KEY_FILE.

context

string

Имя контекста, указанного в файле конфигурации.

Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.

field_selectors

list / элементы=string

Список селекторов полей для фильтрации результатов.

По умолчанию: []

hidden_fields

list / элементы=string

добавлено в kubevirt.core 2.2.0

Скрыть в результате поля, соответствующие этому параметру.

Например, это могут быть hidden_fields=[metadata.managedFields] или hidden_fields=[metadata.annotations[kubemacpool.io/transaction-timestamp]].

По умолчанию: ["metadata.annotations[kubemacpool.io/transaction-timestamp]", "metadata.managedFields"]

host

string

Укажите URL для доступа к API.

Также можно задать с помощью переменной окружения K8S_AUTH_HOST.

impersonate_groups

list / элементы=string

Группа или группы, от имени которых выполняется операция.

Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS, например Group1,Group2.

impersonate_user

string

Имя пользователя, от имени которого выполняется операция.

Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER.

kubeconfig

any

Путь к существующему файлу конфигурации Kubernetes. Если он не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.

Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG.

Можно указать несколько файлов конфигурации Kubernetes, используя разделитель ; в Windows или : на других платформах.

Конфигурацию Kubernetes можно передать в виде словаря. Для этого требуется версия клиента Kubernetes для Python не ниже 17.17.0.

label_selectors

list / элементы=string

Список селекторов меток для фильтрации результатов.

По умолчанию: []

name

string

Укажите имя VirtualMachine.

namespace

string

Укажите пространство имён для VirtualMachines.

no_proxy

string

Разделённый запятыми список узлов, доменов, IP-адресов или CIDR, для которых не следует использовать прокси.

Также можно задать с помощью переменной окружения K8S_AUTH_NO_PROXY.

Обратите внимание: этот модуль не считывает стандартные настройки прокси из окружения (например, NO_PROXY).

Для этой функции требуется kubernetes>=19.15.0. В версиях библиотеки Kubernetes ниже 19.15.0 возникает ошибка, даже если no_proxy задан правильно.

Пример значения: localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16.

password

string

Укажите пароль для аутентификации в API.

Также можно задать с помощью переменной окружения K8S_AUTH_PASSWORD.

Описание параметра username содержит пояснение, в каких случаях применим этот параметр.

persist_config

boolean

Сохранять ли токены обновления конфигурации kube.

Также можно задать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG.

Если в контексте k8s используются учётные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется клиентской библиотекой k8s для Python, но по умолчанию не сохраняется. В результате старый токен обновления может истечь, и при следующей аутентификации может произойти сбой. Если установить этот флаг в true, клиентская библиотека k8s для Python сохранит новый токен обновления в файл конфигурации kube.

По умолчанию отключено.

Варианты:

  • false
  • true

proxy

string

URL HTTP-прокси, используемого для подключения.

Также можно задать с помощью переменной окружения K8S_AUTH_PROXY.

Обратите внимание: этот модуль не считывает стандартные настройки прокси из окружения (например, HTTP_PROXY).

proxy_headers

dictionary

Заголовок, используемый для HTTP-прокси.

Документацию можно найти здесь: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.

basic_auth

string

Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации.

Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.

proxy_basic_auth

string

Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации прокси.

Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.

user_agent

string

Строка, задающая желаемый user-agent, например foo/1.0.

Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.

running

boolean

добавлено в kubevirt.core 1.4.0

Укажите, должна ли VirtualMachine быть запущена.

Это влияет на то, какого состояния готовности следует ожидать.

Для этого требуется wait=yes.

Варианты:

  • false
  • true

username

string

Укажите имя пользователя для аутентификации в API.

Также можно задать с помощью переменной окружения K8S_AUTH_USERNAME.

validate_certs

псевдонимы: verify_ssl

boolean

Проверять ли SSL-сертификаты сервера API.

Также можно задать с помощью переменной окружения K8S_AUTH_VERIFY_SSL.

Варианты:

  • false
  • true

wait

boolean

Ожидать ли перехода VirtualMachine в состояние готовности.

По умолчанию ожидается, что VirtualMachine будет запущена и работать.

Измените это поведение, задав running.

Варианты:

  • false
  • true

wait_sleep

integer

Количество секунд ожидания между проверками.

Игнорируется, если wait не задан.

По умолчанию: 5

wait_timeout

integer

Время ожидания перехода ресурса в состояние готовности, в секундах.

Игнорируется, если wait не задан.

По умолчанию: 120

Примечания

Примечание

  • Чтобы избежать ошибок проверки SSL-сертификата при validate_certs=yes, необходимо предоставить полную цепочку сертификатов сервера API через ca_cert или в файле kubeconfig.

Примеры

- name: Get an existing VirtualMachine
  kubevirt.core.kubevirt_vm_info:
    name: testvm
    namespace: default
  register: default_testvm

- name: Get a list of all VirtualMachines
  kubevirt.core.kubevirt_vm_info:
    namespace: default
  register: vm_list

- name: Get a list of all VirtualMachines from any namespace
  kubevirt.core.kubevirt_vm_info:
  register: vm_list

- name: Search for all VirtualMachines labelled app=test
  kubevirt.core.kubevirt_vm_info:
    label_selectors:
      - app=test

- name: Wait until the VirtualMachine is running
  kubevirt.core.kubevirt_vm_info:
    name: testvm
    namespace: default
    wait: true

- name: Wait until the VirtualMachine is stopped
  kubevirt.core.kubevirt_vm_info:
    name: testvm
    namespace: default
    running: false
    wait: true

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

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

Ключ

Описание

api_found

boolean

Указывает, были ли указанные api_version и VirtualMachine Kind успешно сопоставлены с существующим API в целевом кластере.

Возвращается: всегда

resources

complex

Существующие VirtualMachines.

Возвращается: при успешном выполнении

api_version

string

Версия схемы, представляющей объект.

Возвращается: при успешном выполнении

kind

string

Тип ресурса REST, представленного этим объектом.

Возвращается: при успешном выполнении

metadata

dictionary

Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д.

Возвращается: при успешном выполнении

spec

dictionary

Специфичные атрибуты VirtualMachine. Могут различаться в зависимости от api_version.

Возвращается: при успешном выполнении

status

dictionary

Сведения о текущем состоянии VirtualMachine.

Возвращается: при успешном выполнении

Авторы

  • Проект KubeVirt.io

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)
  • Сообщить о проблеме
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API