ovirt_cluster – Модуль управления кластерами в oVirt/RHV
Описание
- Модуль для управления кластерами в 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 строка | Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL.Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задается переменной окружения OVIRT_USERNAME. | ||
| ballooning булево |
| Если True, включить оптимизацию воздушного шара памяти. Воздушный шар памяти используется для динамического перераспределения/возврата памяти хоста в зависимости от потребностей виртуальной машины. | |
| comment - | Комментарий к кластеру. | ||
| compatibility_version - | Версия совместимости кластера. Все хосты в этом кластере должны поддерживать как минимум эту версию совместимости. | ||
| cpu_arch - |
| Архитектура процессора кластера. | |
| cpu_type - | Кодовое имя процессора. Например, Intel SandyBridge Family. | ||
| data_center - | Имя центра обработки данных, где находится кластер. | ||
| description - | Описание кластера. | ||
| external_network_providers - добавлен в 2.5 | Список ссылок на внешние поставщики сетей, доступные в кластере. Если автоматическое развертывание внешнего поставщика сети поддерживается, сети указанного поставщика доступны на каждом хосте в кластере. Поддерживается с версии oVirt 4.2. | ||
| id - | Идентификатор внешнего поставщика сети. Требуется либо name, либо id. | ||
| name - | Имя внешнего поставщика сети. Требуется либо name, либо id. | ||
| fence_connectivity_threshold - | Пороговое значение, используемое fence_skip_if_connectivity_broken. | ||
| fence_enabled булево |
| Если True, включить защиту кластера. Защита включена по умолчанию. | |
| fence_skip_if_connectivity_broken булево |
| Если True, защита временно отключена, если процент хостов в кластере, испытывающих проблемы с подключением, превышает или равен заданному пороговому значению. Пороговое значение можно указать с помощью fence_connectivity_threshold. | |
| fence_skip_if_gluster_bricks_up булево добавлен в 2.8 |
| Флаг, указывающий, следует ли пропускать защиту, если кирпичи Gluster работают на хосте, подлежащем защите. Этот флаг необязателен, и значение по умолчанию равно `false`. | |
| fence_skip_if_gluster_quorum_not_met булево добавлен в 2.8 |
| Флаг, указывающий, следует ли пропускать защиту, если кирпичи Gluster активны и кворум Gluster не будет достигнут без этих кирпичей. Этот флаг необязателен, и значение по умолчанию равно `false`. | |
| fence_skip_if_sd_active булево |
| Если True, хосты в кластере, которые не отвечают, но по-прежнему подключены к хранилищу, не будут подлежать защите. | |
| fetch_nested булево |
| Если True, модуль получит дополнительные данные из API. Будут получены ID дисков, снимков и т.д. виртуальных машин. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| firewall_type строка добавлен в 2.8 |
| Тип брандмауэра, который будет использоваться на хостах в этом кластере. До версии 4.1 он всегда был iptables. С версии 4.2 вы можете выбрать между iptables и firewalld. Для кластеров с версией совместимости 4.2 и выше, тип брандмауэра по умолчанию — firewalld. | |
| gluster булево |
| Если True, хосты в этом кластере будут использоваться в качестве узлов сервера Gluster Storage, а не для запуска виртуальных машин. По умолчанию кластер создается для хостов виртуальных машин. | |
| gluster_tuned_profile строка добавлен в 2.8 | Имя профиля https://fedorahosted.org/tuned для установки на всех хостах в кластере. Это не обязательно и актуально только для кластеров с сервисом Gluster. Может быть, например, virtual-host, rhgs-sequential-io, rhgs-random-io
| ||
| ha_reservation boolean |
| Если True, разрешает oVirt/RHV контролировать емкость кластера для высокодоступных виртуальных машин. | |
| host_reason boolean |
| Если True, разрешает добавление необязательного поля причины, когда хост переводится в режим технического обслуживания из менеджера. Это позволяет администратору предоставить объяснение причины обслуживания. | |
| id - добавлено в 2.8 | Идентификатор кластера для управления. | ||
| ksm boolean |
| Если True, MoM разрешает запуск Kernel Same-page Merging (KSM) при необходимости, если это приносит выгоду в виде экономии памяти, которая перевешивает затраты на ЦП. | |
| ksm_numa boolean |
| Если True, разрешает 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 список | Указывает список атрибутов, которые должны быть получены из 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 | Пользовательские свойства политики планирования кластера. Эти дополнительные свойства переопределяют свойства политики планирования, указанные параметром vm. | ||
| serial_policy - | Указывает политику серийного номера для виртуальных машин в кластере. Поддерживаются следующие варианты: vm - Устанавливает UUID виртуальной машины как её серийный номер.host - Устанавливает UUID хоста как серийный номер виртуальной машины.custom - Разрешает указать пользовательский серийный номер в yes. | ||
| serial_policy_value - | Разрешает указать пользовательский серийный номер. Этот параметр используется только когда serial_policy custom. | ||
| spice_proxy - | Прокси, через который клиент SPICE будет подключаться к виртуальным машинам. Адрес должен иметь следующий формат: протокол://[хост]:[порт]
| ||
| state - |
| Кластер должен быть present или absent. | |
| switch_type - |
| Тип коммутатора, который будет использоваться всеми сетями в данном кластере. Либо legacy, использующий linux bridge, либо ovs, использующий Open vSwitch. | |
| threads_as_cores boolean |
| Если True, экспонированные потоки хоста будут рассматриваться как ядра, которые могут использоваться виртуальными машинами. | |
| timeout целое число | По умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в требуемое состояние. | |
| trusted_service boolean |
| Если Истина, включает интеграцию с сервером OpenAttestation. | |
| virt boolean |
| Если Истина, узлы в этом кластере будут использоваться для запуска виртуальных машин. | |
| vm_reason boolean |
| Если Истина, включает необязательное поле причины при выключении виртуальной машины из диспетчера, позволяя администратору указать объяснение для обслуживания. | |
| 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. [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.9/modules/ovirt_cluster_module.html
