ovirt_cluster – Модуль для управления кластерами в oVirt/RHV
Новая версия с 2.3.
Краткое описание
- Модуль для управления кластерами в oVirt/RHV
Псевдонимы: ovirt_clusters
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth - / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной среды OVIRT_PASSWORD.url - Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL. Необходимо указать либо url, либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME. Необходимо указать либо url, либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN.insecure - Флажок, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE.kerberos - Флажок, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые нужно добавлять к каждому API-запросу. | |
| ballooning - | Если True, включить оптимизацию баллонирования памяти. Баллонирование памяти используется для динамического перераспределения/возврата памяти хоста в зависимости от потребностей ВМ. | |
| comment - | Комментарий к кластеру. | |
| compatibility_version - | Версия совместимости кластера. Все хосты в этом кластере должны поддерживать, как минимум, эту версию совместимости. | |
| cpu_arch - |
| Архитектура процессора кластера. |
| cpu_type - | Код процессора. Например, Intel SandyBridge Family. | |
| data_center - | Имя ЦОД, в котором находится кластер. | |
| description - | Описание кластера. | |
| external_network_providers - добавлено в 2.5 | Список ссылок на внешние поставщиков сетевых услуг, доступные в кластере. Если автоматическое развертывание внешнего поставщика сетевых услуг поддерживается, сети указанного поставщика доступны на каждом хосте в кластере. Внешний поставщик сетевых услуг описывается следующим словарем: name - Имя внешнего поставщика сетевых услуг. Необходимо указать либо name, либо id. id - Идентификатор внешнего поставщика сетевых услуг. Необходимо указать либо name, либо id. Поддерживается с версии oVirt 4.2. | |
| fence_connectivity_threshold - | Порог, используемый fence_skip_if_connectivity_broken. | |
| fence_enabled - | Если True, включает защиту кластера. Защита включена по умолчанию. | |
| fence_skip_if_connectivity_broken - | Если True, защита временно отключится, если процент хостов в кластере с проблемами подключения превысит заданный порог. Порог можно указать в fence_connectivity_threshold. | |
| fence_skip_if_sd_active - | Если True, любые хосты в кластере, которые не отвечают, но всё ещё подключены к хранилищу, не будут помечены для защиты. | |
| fetch_nested boolean добавлено в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т. д. ВМ. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. |
| gluster - | Если True, хосты в этом кластере будут использоваться как узлы сервера Gluster Storage, а не для запуска виртуальных машин. По умолчанию кластер создается для хостов виртуальных машин. | |
| ha_reservation - | Если True, oVirt/RHV будет отслеживать емкость кластера для высокодоступных виртуальных машин. | |
| host_reason - | Если True, включает дополнительное поле причины при помещении хоста в режим технического обслуживания из диспетчера, позволяя администратору указать причину. | |
| ksm - | Если True, MoM включит объединение одинаковых страниц ядра (KSM) при необходимости и когда это принесёт выгоду в плане экономии памяти, превышающую затраты на процессор. | |
| ksm_numa - | Если True, включает KSM ksm для лучшей производительности внутри узлов NUMA. | |
| mac_pool - добавлено в 2.4 | Пул MAC-адресов, который будет использоваться этим кластером. Note:Поддерживается с версии oVirt 4.1. | |
| memory_policy - |
|
disabled - Отключает совместное использование страниц памяти.
server - Устанавливает порог совместного использования страниц памяти на 150% от объёма оперативной памяти каждого хоста.
desktop - Устанавливает порог совместного использования страниц памяти на 200% от объёма оперативной памяти каждого хоста. |
| migration_auto_converge - |
| Если True, используется автоматическая сходимость во время живой миграции виртуальных машин. Используется только когда migration_policy установлено в legacy.Поддерживаются следующие варианты: true - Переопределяет глобальное значение на true.false - Переопределяет глобальное значение на false.inherit - Использует значение, установленное глобально. |
| migration_bandwidth - |
| Параметры пропускной способности определяют максимальную пропускную способность исходящих и входящих миграций на хост. Поддерживаются следующие варианты пропускной способности: auto - Пропускная способность копируется из настройки лимита скорости [Мбит/с] в QoS сети хоста ЦОД.hypervisor_default - Пропускная способность контролируется локальными настройками VDSM на отправляющем хосте.custom - Определяется пользователем (в Мбит/с). |
| migration_bandwidth_limit - | Установить лимит пропускной способности миграции при custom. Этот параметр используется только когда migration_bandwidth равен custom. | |
| migration_compressed - |
| Если True, используется сжатие во время живой миграции виртуальной машины. Используется только когда migration_policy установлено в legacy.Поддерживаются следующие варианты: true - Переопределяет глобальное значение на true.false - Переопределяет глобальное значение на false.inherit - Использует значение, установленное глобально. |
| migration_policy - |
| Политика миграции определяет условия для живой миграции виртуальных машин в случае сбоя хоста. Поддерживаются следующие политики: legacy - Поведение по умолчанию версии 3.6.minimal_downtime - Виртуальные машины не должны испытывать значительных простоев.suspend_workload - Виртуальные машины могут испытывать более значительные простои.post_copy - Виртуальные машины не должны испытывать значительных простоев. Если миграция ВМ не сходится долго, миграция будет переключена на пост-копирование. Добавлено в версии 2.4. |
| name - / обязательно | Имя кластера для управления. | |
| nested_attributes - добавлено в 2.3 | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| network - | Управляющая сеть кластера для доступа к хостам кластера. | |
| poll_interval - | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса состояния сущности. |
| resilience_policy - |
| Политика отказоустойчивости определяет, как виртуальные машины имеют приоритет при миграции. Поддерживаются следующие значения: do_not_migrate - Препятствует миграции виртуальных машин.migrate - Мигрирует все виртуальные машины в порядке их определенного приоритета.migrate_highly_available - Мигрирует только высокодоступные виртуальные машины, чтобы предотвратить перегрузку других хостов. |
| rng_sources - | Список, который определяет устройства генераторов случайных чисел, которые будут использоваться всеми хостами в кластере. Поддерживаемые генераторы: hwrng и random. | |
| scheduling_policy - | Имя политики планирования, которая будет использоваться для кластера. | |
| scheduling_policy_properties - добавлено в 2.6 | Настраиваемые свойства политики планирования кластера. Эти необязательные свойства переопределяют свойства политики планирования, указанные параметром scheduling_policy. | |
| serial_policy - | Укажите политику серийного номера для виртуальных машин в кластере. Поддерживаются следующие варианты: vm - Устанавливает UUID виртуальной машины в качестве ее серийного номера.host - Устанавливает UUID хоста в качестве серийного номера виртуальной машины.custom - Позволяет указать настраиваемый серийный номер в serial_policy_value. | |
| serial_policy_value - | Позволяет указать настраиваемый серийный номер. Этот параметр используется только когда serial_policy равен custom. | |
| spice_proxy - | Прокси, с помощью которого клиент SPICE будет подключаться к виртуальным машинам. Адрес должен иметь следующий формат: protocol://[host]:[port]
| |
| state - |
| Кластер должен быть present или absent. |
| switch_type - |
| Тип коммутатора, который будет использоваться всеми сетями в данном кластере. Либо legacy, который использует linux bridge, либо ovs, использующий Open vSwitch. |
| threads_as_cores - | Если True, то доступные потоки хоста будут рассматриваться как ядра, которые могут использоваться виртуальными машинами. | |
| timeout - | По умолчанию: 180 | Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние. |
| trusted_service - | Если True, активирует интеграцию с сервером OpenAttestation. | |
| virt - | Если True, хосты в этом кластере будут использоваться для запуска виртуальных машин. | |
| vm_reason - | Если True, активирует необязательное поле причины, когда виртуальная машина выключается из диспетчера, позволяя администратору указать объяснение для технического обслуживания. | |
| wait boolean |
|
True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create cluster
- ovirt_cluster:
data_center: mydatacenter
name: mycluster
cpu_type: Intel SandyBridge Family
description: mycluster
compatibility_version: 4.0
# Create virt service cluster:
- ovirt_cluster:
data_center: mydatacenter
name: mycluster
cpu_type: Intel Nehalem Family
description: mycluster
switch_type: legacy
compatibility_version: 4.0
ballooning: true
gluster: false
threads_as_cores: true
ha_reservation: true
trusted_service: false
host_reason: false
vm_reason: true
ksm_numa: true
memory_policy: server
rng_sources:
- hwrng
- random
# Create cluster with default network provider
- ovirt_cluster:
name: mycluster
data_center: Default
cpu_type: Intel SandyBridge Family
external_network_providers:
- name: ovirt-provider-ovn
# Remove cluster
- ovirt_cluster:
state: absent
name: mycluster
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cluster словарь | При успехе, если кластер найден. | Словарь всех атрибутов кластера. Атрибуты кластера можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster. |
| id строка | При успехе, если кластер найден. | ID кластера, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
- Гарантия обратной совместимости этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Ondra Machacek (@machacekondra)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_cluster_module.html