community.kubevirt.kubevirt_rs – Управление репликатными наборами виртуальных машин KubeVirt
Примечание
Этот плагин входит в коллекцию community.kubevirt (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.kubevirt.
Для использования в плейбуке укажите: community.kubevirt.kubevirt_rs.
Описание
- Используйте 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 целое число | Преобразуется в значение millicore и умножается на 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 целое число | Укажите доли процессорного времени. | ||
| 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. | ||
| force булево |
| Если установлено значение no, и state — present, существующий объект будет заменён. | |
| headless строка | Укажите, должна ли виртуальная машина иметь подключенное минимальное конфигурирование устройства видео и графики. По умолчанию для VirtualMachineInstance будет применена минимальная конфигурация устройства видео и графики. Устройство видео совместимо с 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. | ||
| labels словарь | Метки — это пары «ключ/значение», которые прикреплены к виртуальным машинам. Метки предназначены для указания идентифицирующих атрибутов виртуальных машин, которые имеют смысл и относятся к пользователям, но не подразумевают семантики для основной системы. Метки могут быть использованы для организации и для выбора подмножеств виртуальных машин. Метки могут быть прикреплены к виртуальным машинам во время создания и впоследствии добавлены и изменены в любое время. Подробнее о метках, используемых для внутренней реализации https://kubevirt.io/user-guide/#/misc/annotations_and_labels
| ||
| machine_type строка | Тип машины QEMU — это фактический чипсет виртуальной машины. | ||
| memory string | Объём памяти, запрашиваемый виртуальной машиной. Например, 1024Mi. | ||
| memory_limit string | Максимальный объём памяти, используемый виртуальной машиной. Например, 1024Mi. | ||
| merge_type list / elements=string |
| Тип слияния для переопределения стандартного подхода. Если указано несколько типов, они будут применяться в порядке перечисления. По умолчанию ['strategic-merge', 'merge'], что идеально подходит для использования одних и тех же параметров для типов ресурсов, объединяющих пользовательские ресурсы и встроенные ресурсы, так как определения пользовательских ресурсов обычно не могут обновляться с помощью обычного стратегического слияния. | |
| name string / required | Имя набора реплик виртуальной машины. | ||
| namespace string / required | Пространство имён, в котором существует набор реплик виртуальной машины. | ||
| node_affinity dictionary | Описание правил планирования для привязки виртуальной машины, например, расположить её на одном узле, в той же зоне, что и другие виртуальные машины. | ||
| hard dictionary | Если требования привязки, указанные в этом поле, не выполнены во время планирования, виртуальная машина не будет размещена на узле. Если требования привязки, указанные в этом поле, перестанут выполняться в какой-либо момент во время выполнения виртуальной машины (например, из-за обновления), система может или не может попытаться в конечном итоге выгнать виртуальную машину с её узла. | ||
| soft dictionary | Планировщик отдаст предпочтение размещению виртуальных машин на узлах, которые удовлетворяют выражениям привязки, указанным в этом поле, но может выбрать узел, нарушающий одно или несколько выражений. Узел, которому отдаётся наибольшее предпочтение, — это узел с наибольшей суммой весов, т.е. для каждого узла, который удовлетворяет всем требованиям планирования (запросы ресурсов, требования привязки во время планирования и т.д.), вычислите сумму, проходя по элементам этого поля и добавляя weight к сумме, если узел соответствует соответствующим выражениям соответствия; узлы с наибольшей суммой — самые предпочтительные. | ||
| 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. Обратите внимание, что текущая версия библиотеки k8s python пока не поддерживает установку этого флага в значение True. Исправление для этой библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169 | |
| proxy string | URL HTTP-прокси, используемого для подключения. Также можно указать через переменную среды K8S_AUTH_PROXY. Обратите внимание, что этот модуль не подхватывает типичные настройки прокси из среды (например, HTTP_PROXY). | ||
| replicas integer | Количество желаемых под. Это указатель, чтобы отличать явное значение нуля от отсутствия указания. По умолчанию replicas равно 1, если набор реплик создаётся впервые. | ||
| resource_definition dictionary | Частичное YAML-определение объекта, создаваемого/обновляемого. Здесь вы можете определить параметры ресурсов Kubernetes, не охваченные параметрами этого модуля. ПРИМЕЧАНИЕ: resource_definition имеет более низкий приоритет, чем параметры модуля. Если вы попытаетесь определить, например, metadata.namespace здесь, это значение будет проигнорировано, и вместо него будет использовано namespace. псевдонимы: definition, inline | ||
| selector dictionary / required | Селектор — это запрос по меткам для набора виртуальных машин. | ||
| smbios_uuid string | Для обеспечения согласованного представления виртуализированного оборудования для гостевой ОС можно установить UUID SMBIOS. | ||
| state string |
| Создание или удаление наборов реплик виртуальных машин. | |
| subdomain string | Если указано, полное доменное имя виртуальной машины будет hostname.subdomain.namespace.svc.cluster_domain. Если не указано, у виртуальной машины не будет доменного имени. Запись DNS будет разрешать виртуальную машину, независимо от того, может ли сама виртуальная машина получить имя хоста. | ||
| tablets list / elements=string | Укажите планшеты, которые будут использоваться в качестве устройств ввода. | ||
| username string | Укажите имя пользователя для аутентификации с API. Также можно указать через переменную среды K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер имеет другой вид аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вы должны обратиться к модулю k8s_auth, так как он может выполнять то, что вам нужно. | ||
| validate_certs boolean |
| Проверять ли сертификаты SSL API-сервера. Также можно указать через переменную среды K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl | |
| wait boolean |
|
True, если модуль должен ожидать, пока ресурс не перейдёт в нужное состояние. | |
| wait_sleep string | По умолчанию: 5 | Количество секунд ожидания между проверками. | |
| wait_timeout integer | По умолчанию: 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: Create virtual machine replica set 'myvmir'
community.kubevirt.kubevirt_rs:
state: present
name: myvmir
namespace: vms
wait: true
replicas: 3
memory: 64M
labels:
myvmi: myvmi
selector:
matchLabels:
myvmi: myvmi
disks:
- name: containerdisk
volume:
containerDisk:
image: kubevirt/cirros-container-disk-demo:latest
path: /custom-disk/cirros.img
disk:
bus: virtio
- name: Remove virtual machine replica set 'myvmir'
community.kubevirt.kubevirt_rs:
state: absent
name: myvmir
namespace: vms
wait: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| kubevirt_rs complex | success | Управляемый пользователем набор реплик виртуальных машин KubeVirt. Этот словарь содержит все значения, возвращаемые API KubeVirt, все параметры описаны здесь https://kubevirt.io/api-reference/master/definitions.html#_v1_virtualmachineinstance
|
Авторы
- Команда 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/kubevirt/kubevirt_rs_module.html
