Spec-Zone.ru › Ansible 2.11

community.kubevirt.kubevirt_vm – Управление виртуальными машинами KubeVirt

Примечание

Этот плагин является частью коллекции community.kubevirt (версия 1.0.0).

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

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

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

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

  • Используйте Openshift Python SDK для управления состоянием виртуальных машин KubeVirt.

Требования

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

  • openshift >= 0.8.2
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
affinity
словарь
Описывает правила планирования задания аффинити узла для виртуальной машины.
hard
словарь
Если требования аффинити, указанные в этом поле, не выполнены во время планирования, виртуальная машина не будет запланирована на узел. Если требования аффинити, указанные в этом поле, перестанут выполняться в какой-то момент во время работы виртуальной машины (например, из-за обновления метки виртуальной машины), система может или не может попытаться в конечном итоге выгнать виртуальную машину с узла. При наличии нескольких элементов списки узлов, соответствующие каждому term, пересекаются, т.е. все условия должны быть выполнены.
soft
словарь
Планировщик отдаст предпочтение планированию виртуальных машин на узлах, которые удовлетворяют выражениям аффинити, указанным в этом поле, но он может выбрать узел, нарушающий одно или несколько выражений. Узел, который предпочтительнее всего, — это тот, у которого наибольшая сумма весов, т.е. для каждого узла, который соответствует всем требованиям планирования (запрос ресурсов, выражения аффинити requiredDuringScheduling и т. д.), вычислите сумму, проитерировав элементы этого поля и добавив weight к сумме, если у узла есть виртуальные машины, которые соответствуют соответствующему term; узлы с наибольшей суммой являются наиболее предпочтительными.
anti_affinity
словарь
Описывает правила планирования антиаффинити виртуальных машин, например, избегать размещения этой виртуальной машины на том же узле, зоне и т. д., что и некоторые другие виртуальные машины.
hard
словарь
Если требования антиаффинити, указанные в этом поле, не выполнены во время планирования, виртуальная машина не будет запланирована на узел. Если требования антиаффинити, указанные в этом поле, перестанут выполняться в какой-то момент во время работы виртуальной машины (например, из-за обновления метки виртуальной машины), система может или не может попытаться в конечном итоге выгнать виртуальную машину с узла. При наличии нескольких элементов списки узлов, соответствующие каждому term, пересекаются, т.е. все условия должны быть выполнены.
soft
словарь
Планировщик отдаст предпочтение планированию виртуальных машин на узлах, которые удовлетворяют выражениям антиаффинити, указанным в этом поле, но он может выбрать узел, нарушающий одно или несколько выражений. Узел, который предпочтительнее всего, — это тот, у которого наибольшая сумма весов, т.е. для каждого узла, который соответствует всем требованиям планирования (запрос ресурсов, выражения антиаффинити requiredDuringScheduling и т. д.), вычислите сумму, проитерировав элементы этого поля и добавив weight к сумме, если у узла есть виртуальные машины, которые соответствуют соответствующему term; узлы с наибольшей суммой являются наиболее предпочтительными.
api_key
строка
Токен, используемый для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_API_KEY.
bootloader
строка
Укажите загрузчик виртуальной машины.
По умолчанию все виртуальные машины используют BIOS для загрузки.
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
cloud_init_nocloud
словарь
Представляет источник пользовательских данных cloud-init NoCloud. Данные NoCloud будут добавлены в виде диска к виртуальной машине. Требуется правильная установка cloud-init внутри гостевой системы. Дополнительная информация https://kubevirt.io/api-reference/master/definitions.html#_v1_cloudinitnocloudsource
context
строка
Имя контекста, найденного в файле конфигурации. Также можно указать через переменную окружения K8S_AUTH_CONTEXT.
cpu_cores
целое число
Количество ядер процессора.
cpu_features
список / элементы=строка
Список словарей для точной настройки функций, предоставляемых выбранной моделью процессора.
Примечание: атрибут политики может быть опущен или содержать одну из следующих политик: force, require, optional, disable, forbid.
Примечание: в случае, если политика опущена для функции, она по умолчанию устанавливается как require.
Дополнительная информация о политиках: https://libvirt.org/formatdomain.html#elementsCPU
cpu_limit
целое число
Преобразуется в значение в миллиядрах и умножается на 100. Результирующее значение — это общее количество времени работы процессора, которое может использовать контейнер каждые 100 мс. Виртуальная машина не может использовать больше, чем свою долю времени работы процессора в течение этого интервала.
cpu_model
строка
Модель процессора.
Вы можете проверить список доступных моделей здесь: https://github.com/libvirt/libvirt/blob/master/src/cpu_map/index.xml.
Примечание: Пользователь может определить модель процессора по умолчанию как default-cpu-model в kubevirt-config ConfigMap, если не установлено, используется host-model.
Примечание: Убедитесь, что модель процессора узла, на котором вы запускаете ВМ, имеет ту же или более высокую семейство процессоров.
Примечание: Если модель процессора не определена, у ВМ будет модель процессора, наиболее близкая к той, которая используется на узле, где запущена ВМ.
cpu_shares
целое число
Укажите долю процессора.
datavolumes
список / элементы=строка
DataVolumes — это способ автоматизации импорта дисков виртуальных машин на pvcs во время потока запуска виртуальных машин. Без использования DataVolume пользователям необходимо подготовить pvc с образом диска перед его назначением ВМ или манифесту VMI. С DataVolume создание pvc и импорт выполняются автоматически от имени пользователя.
disks
список / элементы=строка
Список словарей, которые определяют диски виртуальной машины.
Диск может быть доступен по четырем различным типам: disk, lun, cdrom, floppy.
Все возможные параметры конфигурации доступны в https://kubevirt.io/api-reference/master/definitions.html#_v1_disk
Каждый диск должен иметь указанный volume, который объявляет тип тома диска. Все возможные параметры конфигурации тома доступны в https://kubevirt.io/api-reference/master/definitions.html#_v1_volume.
ephemeral
булево
    Варианты:
  • нет ←
  • да
Если (истина), будет создана эфемерная виртуальная машина. После удаления она больше не будет доступна.
Работает только с state present и absent.
force
булево
    Варианты:
  • нет ←
  • да
Если установлено no, и состояние равно present, существующий объект будет заменён.
headless
строка
Укажите, должна ли виртуальная машина иметь подключенное минимальное оборудование видео и графики.
По умолчанию виртуальной машине будет применена минимальная конфигурация видео и графики. Видеоустройство совместимо с vga и имеет размер памяти 16 МБ.
host
строка
Укажите URL для доступа к API. Также можно указать через переменную окружения K8S_AUTH_HOST.
hostname
строка
Указывает имя хоста виртуальной машины. Имя хоста будет установлено либо DHCP, либо cloud-init, если настроено, или будет использоваться имя виртуальной машины.
hugepage_size
строка
Укажите размер огромной страницы.
interfaces
список / элементы=строка
Интерфейс определяет виртуальный сетевой интерфейс виртуальной машины (также называемый передним интерфейсом).
Все возможные параметры конфигурации интерфейсов доступны в https://kubevirt.io/api-reference/master/definitions.html#_v1_interface
Каждый интерфейс должен иметь указанный network, который объявляет, к какому логическому или физическому устройству он подключен (также называемый задним интерфейсом). Все возможные параметры конфигурации сети доступны в https://kubevirt.io/api-reference/master/definitions.html#_v1_network.
kubeconfig
путь
Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также можно указать через переменную окружения K8S_AUTH_KUBECONFIG.
метки
словарь
Метки представляют собой пары ключ/значение, которые прикрепляются к виртуальным машинам. Метки предназначены для указания идентификационных атрибутов виртуальных машин, имеющих смысл и значение для пользователей, но не прямо влияющих на семантику основной системы. Метки могут использоваться для организации и выбора подмножеств виртуальных машин. Метки могут быть прикреплены к виртуальным машинам во время создания и впоследствии добавлены и изменены в любое время.
Дополнительная информация о метках, используемых для внутренней реализации https://kubevirt.io/user-guide/#/misc/annotations_and_labels
тип_машины
строка
Тип машины QEMU — это фактический чипсет виртуальной машины.
память
строка
Объем памяти, запрашиваемый виртуальной машиной.
Например, 1024Mi.
предел_памяти
строка
Максимальный объем памяти, используемый виртуальной машиной.
Например, 1024Mi.
тип_слияния
список / элементы=строка
    Варианты:
  • json
  • слияние
  • стратегическое_слияние
Определяет, нужно ли переопределить стандартный подход к слиянию исправлений на определенный тип.
Если указано несколько типов слияния, они будут применяться по порядку.
По умолчанию ['strategic-merge', 'merge'], что идеально подходит для использования одних и тех же параметров для типов ресурсов, которые объединяют пользовательские ресурсы и встроенные ресурсы, так как определения пользовательских ресурсов обычно не обновляются с помощью обычного стратегического слияния.
См. https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment
имя
строка / обязательно
Имя виртуальной машины.
пространство_имен
строка / обязательно
Пространство имен, в котором существует виртуальная машина.
сродство_узла
словарь
Описывает правила планирования сродства VM, например, размещение этой VM на том же узле, зоне и т. д., что и некоторых других VM
жесткий
словарь
Если требования сродства, указанные в этом поле, не выполняются во время планирования, VM не будет запланирована на узел. Если требования сродства, указанные в этом поле, перестанут выполняться в какой-то момент во время выполнения VM (например, из-за обновления), система может или не может попытаться в конечном итоге удалить VM с узла.
мягкий
словарь
Планировщик предпочтительно размещает VM на узлах, удовлетворяющих выражениям сродства, указанным в этом поле, но может выбрать узел, нарушающий одно или несколько выражений. Наиболее предпочтительным узлом является тот, у которого наибольшая сумма весов, т. е. для каждого узла, удовлетворяющего всем требованиям планирования (запрос ресурсов, необходимые во время планирования выражения сродства и т. д.), вычисляется сумма, итерируя элементы этого поля и добавляя weight к сумме, если узел соответствует соответствующим выражениям соответствия; узлы с наибольшей суммой являются наиболее предпочтительными.
пароль
строка
Укажите пароль для аутентификации с API. Также можно указать через переменную среды K8S_AUTH_PASSWORD.
См. описание параметра username для обсуждения случаев применения этого параметра.
persist_config
логическое
    Варианты:
  • нет
  • да
Определяет, сохранять ли токены обновления конфигурации kube. Также может быть указан через переменную среды K8S_AUTH_PERSIST_CONFIG.
Когда контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой k8s python, но по умолчанию не сохраняется. Таким образом, старый токен обновления может истечь, и следующая аутентификация может завершиться ошибкой. Установка этого флага в значение true сообщит библиотеке k8s python о сохранении нового токена обновления в файле конфигурации kube.
По умолчанию false.
Обратите внимание, что текущая версия библиотеки k8s python пока не поддерживает установку этого флага в значение True.
Исправление для этой библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169
прокси
строка
URL HTTP-прокси, который необходимо использовать для подключения. Также может быть указан через переменную среды K8S_AUTH_PROXY.
Обратите внимание, что этот модуль не получает типичные настройки прокси из среды (например, HTTP_PROXY).
определение_ресурса
словарь
Частичное YAML-определение создаваемого/обновляемого объекта. Здесь можно определить параметры ресурса Kubernetes, не охваченные параметрами этого модуля.
ПРИМЕЧАНИЕ: определение_ресурса имеет более низкий приоритет, чем параметры модуля. Если вы попытаетесь определить, например, metadata.namespace здесь, это значение будет проигнорировано, и вместо него будет использовано namespace.

псевдонимы: определение, встроенный
smbios_uuid
строка
Для обеспечения согласованного представления виртуализированного оборудования для гостевой ОС можно установить SMBIOS UUID.
состояние
строка
    Варианты:
  • настоящее ←
  • отсутствует
  • запущено
  • остановлено
Установите виртуальную машину в настоящее, отсутствующее, запущено или остановлено.
настоящее - Создать или обновить виртуальную машину. (И запустить её, если она временная.)
отсутствующее - Удалить виртуальную машину.
запущено - Создать или обновить виртуальную машину и запустить её.
остановлено - Остановить виртуальную машину. (Это удаляет временные VM.)
поддомен
строка
Если указано, полное доменное имя виртуальной машины будет hostname.subdomain.namespace.svc.cluster_domain. Если не указано, у виртуальной машины не будет доменного имени. Запись DNS будет разрешать виртуальную машину, независимо от того, может ли сама виртуальная машина получить имя хоста.
планшеты
список / элементы=строка
Укажите планшеты, которые будут использоваться в качестве устройств ввода
шаблон
строка
Имя шаблона, который будет использоваться при создании виртуальной машины.
параметры_шаблона
словарь
Новые значения параметров из шаблона.
имя_пользователя
строка
Укажите имя пользователя для аутентификации с API. Также можно указать через переменную среды K8S_AUTH_USERNAME.
Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер имеет другой вид аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует обратиться к модулю k8s_auth, так как он может сделать то, что вам нужно.
validate_certs
логическое
    Варианты:
  • нет
  • да
Определяет, проверять ли сертификаты SSL сервера API. Также можно указать через переменную среды K8S_AUTH_VERIFY_SSL.

псевдонимы: verify_ssl
ждать
логическое
    Варианты:
  • нет
  • да ←
True, если модуль должен ждать, пока ресурс не перейдет в желаемое состояние.
wait_sleep
строка
По умолчанию:
5
Количество секунд ожидания между проверками.
wait_timeout
целое число
По умолчанию:
120
Время в секундах, в течение которого модуль должен ждать, пока ресурс не перейдет в желаемое состояние.

Примечания

Примечание

  • Клиент OpenShift Python обертывает клиент K8s Python, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версии API и дополнительную информацию см. на https://github.com/openshift/openshift-restclient-python
  • Чтобы избежать ошибок проверки сертификатов SSL, когда validate_certs имеет значение True, полная цепочка сертификатов сервера API должна быть предоставлена через ca_cert или в файле kubeconfig.
  • Для использования этого модуля необходимо установить Openshift Python SDK. Чтобы гарантировать, что он установлен с правильной версией, можно создать следующую задачу: pip: name=openshift>=0.8.2

Примеры

- name: Start virtual machine 'myvm'
  community.kubevirt.kubevirt_vm:
      state: running
      name: myvm
      namespace: vms

- name: Create virtual machine 'myvm' and start it
  community.kubevirt.kubevirt_vm:
      state: running
      name: myvm
      namespace: vms
      memory: 64Mi
      cpu_cores: 1
      bootloader: efi
      smbios_uuid: 5d307ca9-b3ef-428c-8861-06e72d69f223
      cpu_model: Conroe
      headless: true
      hugepage_size: 2Mi
      tablets:
        - bus: virtio
          name: tablet1
      cpu_limit: 3
      cpu_shares: 2
      disks:
        - name: containerdisk
          volume:
            containerDisk:
              image: kubevirt/cirros-container-disk-demo:latest
              path: /custom-disk/cirros.img
          disk:
            bus: virtio

- name: Create virtual machine 'myvm' with multus network interface
  community.kubevirt.kubevirt_vm:
      name: myvm
      namespace: vms
      memory: 512M
      interfaces:
        - name: default
          bridge: {}
          network:
            pod: {}
        - name: mynet
          bridge: {}
          network:
            multus:
              networkName: mynetconf

- name: Combine inline definition with Ansible parameters
  community.kubevirt.kubevirt_vm:
      # Kubernetes specification:
      definition:
        metadata:
          labels:
            app: galaxy
            service: web
            origin: vmware

      # Ansible parameters:
      state: running
      name: myvm
      namespace: vms
      memory: 64M
      disks:
        - name: containerdisk
          volume:
            containerDisk:
              image: kubevirt/cirros-container-disk-demo:latest
              path: /custom-disk/cirros.img
          disk:
            bus: virtio

- name: Start ephemeral virtual machine 'myvm' and wait to be running
  community.kubevirt.kubevirt_vm:
      ephemeral: true
      state: running
      wait: true
      wait_timeout: 180
      name: myvm
      namespace: vms
      memory: 64M
      labels:
        kubevirt.io/vm: myvm
      disks:
        - name: containerdisk
          volume:
            containerDisk:
              image: kubevirt/cirros-container-disk-demo:latest
              path: /custom-disk/cirros.img
          disk:
            bus: virtio

- name: Start fedora vm with cloud init
  community.kubevirt.kubevirt_vm:
      state: running
      wait: true
      name: myvm
      namespace: vms
      memory: 1024M
      cloud_init_nocloud:
        userData: |-
          #cloud-config
          password: fedora
          chpasswd: { expire: False }
      disks:
        - name: containerdisk
          volume:
            containerDisk:
              image: kubevirt/fedora-cloud-container-disk-demo:latest
              path: /disk/fedora.qcow2
          disk:
            bus: virtio
      node_affinity:
        soft:
          - weight: 1
            term:
              match_expressions:
                - key: security
                  operator: In
                  values:
                    - S2

- name: Create virtual machine with datavolume and specify node affinity
  community.kubevirt.kubevirt_vm:
    name: myvm
    namespace: default
    memory: 1024Mi
    datavolumes:
      - name: mydv
        source:
          http:
            url: https://url/disk.qcow2
        pvc:
          accessModes:
            - ReadWriteOnce
          storage: 5Gi
    node_affinity:
      hard:
        - term:
            match_expressions:
              - key: security
                operator: In
                values:
                  - S1

- name: Remove virtual machine 'myvm'
  community.kubevirt.kubevirt_vm:
      state: absent
      name: myvm
      namespace: vms

Значения возврата

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

Ключ Возвращено Описание
kubevirt_vm
сложное
успех
Спецификация словаря виртуальной машины, возвращенная API.
Этот словарь содержит все значения, возвращенные API KubeVirt, все параметры описаны здесь https://kubevirt.io/api-reference/master/definitions.html#_v1_virtualmachine



Авторы

  • Команда KubeVirt (@kubevirt)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/kubevirt/kubevirt_vm_module.html

Spec-Zone.ru

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