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, включить оптимизацию памяти balloon. Память balloon используется для динамического перераспределения/возврата памяти хоста на основе потребностей виртуальной машины. | |
| 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) для кластера. Защита включена по умолчанию. | |
| fence_skip_if_connectivity_broken | Если True, временное отключение защиты, если процент хостов в кластере, испытывающих проблемы с подключением, больше или равен заданному порогу. Порог можно указать в fence_connectivity_threshold. | |
| fence_skip_if_sd_active | Если True, хосты в кластере, которые не отвечают, но по-прежнему подключены к хранилищу, не будут отключаться. | |
| fetch_nested (добавлен в 2.3) | Если True, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков и т. д. виртуальных машин. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| gluster | Если True, хосты в этом кластере будут использоваться как узлы сервера Gluster Storage, а не для запуска виртуальных машин. По умолчанию кластер создаётся для хостов виртуальных машин. | |
| ha_reservation | Если True, oVirt/RHV будет отслеживать ресурсы кластера для высокодоступных виртуальных машин. | |
| host_reason | Если True, при переходе хоста в режим технического обслуживания из менеджера будет добавлено необязательное поле причины, позволяющее администратору объяснить причину технического обслуживания. | |
| ksm | Если True, MoM позволяет запускать KSM (Kernel Same-page Merging), когда это необходимо и когда это принесёт выгоду в плане экономии памяти, превышающей затраты ЦП. | |
| 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 - Виртуальные машины не должны испытывать значительных простоев. Если миграция VM не сходится долго, миграция будет переключена на 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 (added in 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 |
| Должен ли кластер быть присутствующим или отсутствующим |
| switch_type |
| Тип коммутатора, который будет использоваться всеми сетями в заданном кластере. Либо legacy, который использует linux bridge, либо ovs, использующий Open vSwitch. |
| threads_as_cores | Если True, то доступные потоки хоста будут рассматриваться как ядра, которые могут использоваться виртуальными машинами. | |
| timeout | По умолчанию: 180 | Количество времени в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в желаемое состояние. |
| trusted_service | Если (True), включить интеграцию с сервером OpenAttestation. | |
| virt | Если True, хосты в этом кластере будут использоваться для запуска виртуальных машин. | |
| vm_reason | Если True, включить дополнительное поле причины при выключении виртуальной машины из менеджера, позволяя администратору предоставить объяснение для технического обслуживания. | |
| wait |
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 dict | При успехе, если кластер найден. | Словарь всех атрибутов кластера. Атрибуты кластера можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster. |
| id str | При успехе, если кластер найден. | Идентификатор управляемого кластера Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Состояние
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Смотрите Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/ovirt_cluster_module.html
