Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге сценариев укажите: kubevirt.core.kubevirt_vm_info.

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

Описание

  • Используйте клиент Python Kubernetes для выполнения операций чтения с виртуальными машинами 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

aliases: ssl_ca_cert

path

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

Может быть также указан через переменную среды K8S_AUTH_SSL_CA_CERT.

client_cert

aliases: cert_file

path

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

Может быть также указан через переменную среды K8S_AUTH_CERT_FILE.

client_key

aliases: key_file

path

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

Может быть также указан через переменную среды K8S_AUTH_KEY_FILE.

context

string

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

Может быть также указан через переменную среды K8S_AUTH_CONTEXT.

field_selectors

list / elements=string

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

Значение по умолчанию: []

host

string

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

Может быть также указан через переменную среды K8S_AUTH_HOST.

impersonate_groups

list / elements=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 может быть предоставлена в виде словаря. Для этой функции требуется версия клиента python kubernetes >= 17.17.0. Добавлено в версии 2.2.0.

label_selectors

list / elements=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), токен обновляется библиотекой клиента python k8s, но по умолчанию не сохраняется. Таким образом, старый токен обновления может истечь, и следующая авторизация может завершиться неудачей. Установка этого флага в true сообщит клиенту python k8s сохранить новый токен обновления в файл конфигурации 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

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

Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.

proxy_basic_auth

string

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

Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.

user_agent

string

Строка, представляющая пользовательского агента, например foo/1.0.

Также может быть указан через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.

running

boolean

added in kubevirt.core 1.4.0

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

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

Это требует wait=yes.

Варианты:

  • false
  • true

username

string

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

Также может быть указан через K8S_AUTH_USERNAME переменную окружения.

validate_certs

aliases: 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html

Spec-Zone.ru

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