ovirt_cluster – Модуль для управления кластерами в oVirt/RHV
Новый в версии 2.3.
Описание
- Модуль для управления кластерами в oVirt/RHV
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр ca_file не задан, используется системный хранилище сертификатов CA.Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname. | ||
| insecure логическое значение |
| Логический флаг, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos логическое значение |
| Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации по имени пользователя/паролю. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD. | ||
| token строка | Токен, который используется вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN. | ||
| url строка | Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например, admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME. | ||
| ballooning логическое значение |
| Если Истина, включите оптимизацию памяти balloon. Память balloon используется для динамического перераспределения/возврата памяти хоста на основе потребностей ВМ. | |
| comment - | Комментарий к кластеру. | ||
| compatibility_version - | Версия совместимости кластера. Все хосты в этом кластере должны поддерживать по крайней мере эту версию совместимости. | ||
| cpu_arch - |
| Архитектура процессора кластера. | |
| cpu_type - | Код процессора. Например, Intel SandyBridge Family. | ||
| data_center - | Имя ЦОД, где находится кластер. | ||
| description - | Описание кластера. | ||
| external_network_providers - добавлен в 2.5 | Список ссылок на внешних поставщиков сетевых ресурсов, доступных в кластере. Если поддерживается автоматическое развертывание внешнего поставщика сетевых ресурсов, сети указанного поставщика доступны на каждом хосте в кластере. Поддерживается с версии oVirt 4.2. | ||
| id - | ID внешнего поставщика сетевых ресурсов. Требуется либо name, либо id. | ||
| name - | Имя внешнего поставщика сетевых ресурсов. Требуется либо name, либо id. | ||
| fence_connectivity_threshold - | Порог, используемый fence_skip_if_connectivity_broken. | ||
| fence_enabled логическое значение |
| Если Истина, включите функцию защиты кластера. Защита включена по умолчанию. | |
| fence_skip_if_connectivity_broken логическое значение |
| Если Истина, защита временно отключится, если процент хостов в кластере, испытывающих проблемы с подключением, больше или равен заданному порогу. Порог может быть задан через fence_connectivity_threshold. | |
| fence_skip_if_gluster_bricks_up логическое значение добавлен в 2.8 |
| Флаг, указывающий, нужно ли пропускать защиту, если кирпичи Gluster активны на хосте, который необходимо защитить. Флаг является необязательным, и значение по умолчанию — `ложь`. | |
| fence_skip_if_gluster_quorum_not_met логическое значение добавлен в 2.8 |
| Флаг, указывающий, нужно ли пропускать защиту, если кирпичи Gluster активны и кворум Gluster не будет достигнут без этих кирпичей. Флаг является необязательным, и значение по умолчанию — `ложь`. | |
| fence_skip_if_sd_active логическое значение |
| Если Истина, любые хосты в кластере, которые не отвечают, но все еще подключены к хранилищу, не будут защищены. | |
| fetch_nested логическое значение добавлен в 2.3 |
| Если Истина, модуль получит дополнительные данные из API. Он получит ID дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| firewall_type строка добавлен в 2.8 |
| Тип брандмауэра, который будет использоваться на хостах в этом кластере. До версии 4.1 он всегда был iptables. С версии 4.2 можно выбрать между iptables и firewalld. Для кластеров с версией совместимости 4.2 и выше тип брандмауэра по умолчанию — firewalld. | |
| gluster логическое значение |
| Если Истина, хосты в этом кластере будут использоваться в качестве узлов сервера Gluster Storage, а не для запуска виртуальных машин. По умолчанию кластер создаётся для хостов виртуальных машин. | |
| gluster_tuned_profile строка добавлен в 2.8 | Имя профиля https://fedorahosted.org/tuned, который следует задать на всех хостах кластера. Это не обязательно и актуально только для кластеров с сервисом Gluster. Например, virtual-host, rhgs-sequential-io, rhgs-random-io
| ||
| ha_reservation boolean |
| Если истина, позволяет oVirt/RHV отслеживать емкость кластера для виртуальных машин с высокой доступностью. | |
| host_reason boolean |
| Если истина, включает дополнительное поле причины, когда хост помещается в режим технического обслуживания из менеджера, позволяя администратору предоставить объяснение для технического обслуживания. | |
| id - добавлено в 2.8 | Идентификатор кластера для управления. | ||
| ksm boolean |
| Если истина, MoM позволяет запускать слияние одинаковых страниц ядра (KSM) при необходимости и когда это может обеспечить экономию памяти, которая перевешивает затраты на ЦП. | |
| ksm_numa boolean |
| Если истина, включает KSM ksm для лучшей производительности внутри узлов NUMA. | |
| mac_pool - добавлено в 2.4 | Пул MAC-адресов, который будет использоваться этим кластером. Note:Поддерживается с версии oVirt 4.1. | ||
| memory_policy - |
|
выключен - Отключает совместное использование страниц памяти.
сервер - Устанавливает порог совместного использования страниц памяти на 150% от оперативной памяти системы на каждом хосте.
рабочий стол - Устанавливает порог совместного использования страниц памяти на 200% от оперативной памяти системы на каждом хосте. | |
| migration_auto_converge - |
| Если истина, используется автоматическое сведение во время живой миграции виртуальных машин. Используется только когда migration_policy установлено в legacy.Поддерживаются следующие варианты: true - Переопределяет глобальную настройку на истина.false - Переопределяет глобальную настройку на ложь.inherit - Использует значение, установленное глобально. | |
| migration_bandwidth - |
| Параметры пропускной способности определяют максимальную пропускную способность исходящих и входящих миграций на каждый хост. Поддерживаются следующие варианты пропускной способности: auto - Пропускная способность копируется из параметра limit rate [Мбит/с] в параметрах QoS сети хоста дата-центра.hypervisor_default - Пропускная способность контролируется локальным параметром VDSM на отправляющем хосте.custom - Определяется пользователем (в Мбит/с). | |
| migration_bandwidth_limit - | Установите ограничение пропускной способности миграции в пользовательском режиме. Этот параметр используется только когда migration_bandwidth равен пользовательскому. | ||
| migration_compressed - |
| Если истина, используется сжатие во время живой миграции виртуальной машины. Используется только когда migration_policy установлено в legacy.Поддерживаются следующие варианты: true - Переопределить глобальное значение на истина.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 равен истина. | ||
| 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 равен пользовательскому. | ||
| spice_proxy - | Прокси, по которому SPICE-клиент будет подключаться к виртуальным машинам. Адрес должен быть в формате: протокол://[хост]:[порт]
| ||
| state - |
| Кластер должен быть присутствующим или отсутствующим. | |
| switch_type - |
| Тип коммутатора, который будет использоваться всеми сетями в данном кластере. Либо legacy, использующий linux bridge, либо ovs, использующий Open vSwitch. | |
| threads_as_cores boolean |
| Если истина, экспонированные потоки хоста будут рассматриваться как ядра, которые могут использоваться виртуальными машинами. | |
| timeout целое число | По умолчанию: 180 | Количество времени в секундах, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние. | |
| trusted_service boolean |
| Если True, включает интеграцию с сервером OpenAttestation. | |
| virt boolean |
| Если True, узлы в этом кластере будут использоваться для запуска виртуальных машин. | |
| vm_reason boolean |
| Если True, включает необязательное поле причины при выключении виртуальной машины менеджером, позволяя администратору предоставить объяснение для обслуживания. | |
| wait boolean |
| yes если модуль должен ожидать, пока сущность перейдет в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# 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
# Change cluster Name
- ovirt_cluster:
id: 00000000-0000-0000-0000-000000000000
name: "new_cluster_name"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cluster словарь | При успехе, если кластер найден. | Словарь всех атрибутов кластера. Атрибуты кластера можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster. |
| id строка | При успехе, если кластер найден. | ID кластера, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/ovirt_cluster_module.html