Spec-Zone.ru › Ansible

openstack.cloud.baremetal_node модуль — Создание/удаление ресурсов Bare Metal из OpenStack

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: openstack.cloud.baremetal_node.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание или удаление узлов Ironic в OpenStack.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

целое число

Сколько времени должна ждать транспортная сокет-слой перед истечением срока ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests.

auth

словарь

Словарь, содержащий информацию об авторизации, необходимую стратегии подключа к облаку. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые для этого плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.

auth_type

строка

Имя плагина авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.

bios_interface

строка

Интерфейс BIOS для данного узла, например no-bios.

boot_interface

строка

Интерфейс загрузки для этого узла, например pxe.

ca_cert

псевдонимы: cacert

строка

Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL.

chassis_id

псевдонимы: chassis_uuid

строка

Связать узел с предварительно определённым шасси.

client_cert

псевдонимы: cert

строка

Путь к клиенту сертификату, используемому в рамках SSL-транзакции.

client_key

псевдонимы: key

строка

Путь к ключу клиента, используемому в рамках SSL-транзакции.

cloud

любой тип

Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.

console_interface

строка

Консольный интерфейс для этого узла, например no-console.

deploy_interface

строка

Интерфейс развертывания для данного узла, например iscsi.

driver

строка

Имя драйвера Ironic, которое нужно использовать с этим узлом.

Необходимо, когда state равно present

driver_info

словарь / обязательно

Информация для драйвера этого узла. Будет меняться в зависимости от используемого драйвера. Любой подполе, которое заполняется, будет проверено во время создания. По соображениям совместимости подполя `power`, `deploy`, `management` и `console` сглаживаются.

id

псевдонимы: uuid

строка

ID, который будет присвоен узлу baremetal. Будет сгенерирован автоматически при создании, если не указан, и если указано name. Определение id всегда будет иметь приоритет над name.

inspect_interface

строка

Интерфейс, используемый для инспекции узла, например no-inspect.

interface

псевдонимы: endpoint_type

строка

Тип URL конечной точки для извлечения из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

management_interface

строка

Интерфейс для управления узлом вне канала, например «ipmitool».

name

строка

Уникальный идентификатор имени для ресурса.

network_interface

строка

Провайдер сетевого интерфейса для использования при описании подключений для этого узла.

nics

список / элементы=словарь / обязательный

Список сетевых адаптеров, например, - mac: aa:bb:cc:aa:bb:cc

Это атрибут узла, который нельзя обновить.

mac

строка / обязательный

MAC-адрес сетевого адаптера.

power_interface

строка

Интерфейс, используемый для управления действиями питания на данном узле, например, ipmitool

properties

словарь

Определение физических характеристик этого узла

Используется для планирования

capabilities

строка

Специальные возможности этого узла, такие как boot_option и т. д.

Дополнительную информацию см. на странице https://docs.openstack.org/ironic/latest/install/advanced.html.

cpu_arch

строка

Архитектура процессора (x86_64, i686, …)

cpus

строка

Количество ядер процессора в этом компьютере

local_gb

псевдонимы: disk_size

строка

Размер первого накопителя в этом компьютере в ГБ (обычно /dev/sda)

memory_mb

псевдонимы: ram

строка

Объем ОЗУ в МБ этого компьютера

root_device

словарь

Рекомендации по устройству корневого диска для развертывания.

Допустимые рекомендации см. на странице https://docs.openstack.org/ironic/latest/install/advanced.html.

raid_interface

строка

Интерфейс для настройки RAID на этом узле.

region_name

строка

Название региона.

rescue_interface

строка

Интерфейс, используемый для восстановления узла, например, no-rescue

resource_class

строка

Конкретный тип ресурса, к которому принадлежит этот узел.

sdk_log_level

строка

Уровень логирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

строка

Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается

skip_update_of_masked_password

булево

Устарело, больше не используется.

Обновление или указание пароля не поддерживаются в течение длительного времени.

Варианты:

  • false
  • true

state

строка

Указывает желаемое состояние ресурса

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

storage_interface

строка

Интерфейс для подключения и отключения томов на этом узле, например, cinder

timeout

целое число

Количество секунд ожидания, пока новый узел не перейдет в доступное состояние.

По умолчанию: 1800

validate_certs

псевдонимы: verify

булево

Требуется ли проверка запросов API SSL.

До Ansible 2.3 это по умолчанию true

Варианты:

  • false
  • true

vendor_interface

строка

Интерфейс для всех действий, специфичных для поставщика, на этом узле, например, no-vendor

wait

boolean

Должен ли Ansible ожидать завершения запрошенного ресурса.

Выбори:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Могут использоваться стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
  • Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в заданиях. Более подробная информация доступна по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Enroll a node with some basic properties and driver info
  openstack.cloud.baremetal_node:
    chassis_id: "00000000-0000-0000-0000-000000000001"
    cloud: "devstack"
    driver: "pxe_ipmitool"
    driver_info:
      ipmi_address: "1.2.3.4"
      ipmi_username: "admin"
      ipmi_password: "adminpass"
    id: "00000000-0000-0000-0000-000000000002"
    nics:
      - mac: "aa:bb:cc:aa:bb:cc"
      - mac: "dd:ee:ff:dd:ee:ff"
    properties:
      capabilities: "boot_option:local"
      cpu_arch: "x86_64"
      cpus: 2
      local_gb: 64
      memory_mb: 8192
      root_device:
        wwn: "0x4000cca77fc4dba1"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

node

dictionary

Словарь, описывающий узел Bare Metal.

Возвращается: При успешном завершении, когда state имеет значение ‘present’.

allocation_id

string

UUID выделения, связанного с узлом. Если не null, будет совпадать с instance_id (обратное не всегда верно). В отличие от instance_id, это поле доступно только для чтения. Пожалуйста, используйте API Allocation для удаления выделений.

Возвращается: при успехе

bios_interface

string

BIOS-интерфейс, который будет использоваться для этого узла.

Возвращается: при успехе

boot_interface

string

Загрузочный интерфейс для узла, например, “pxe”.

Возвращается: при успехе

boot_mode

string

Режим загрузки для узла, либо “uefi”, либо “bios”

Возвращается: при успехе

chassis_id

string

UUID шасси, связанного с этим узлом. Может быть пустым или None.

Возвращается: при успехе

clean_step

string

Текущий шаг очистки.

Возвращается: при успехе

conductor

string

Кондуктор, в настоящее время обслуживающий узел.

Возвращается: при успехе

conductor_group

string

Группа кондукторов для узла.

Возвращается: при успехе

console_interface

string

Консольный интерфейс для узла, например, “no-console”.

Возвращается: при успехе

created_at

string

Метка времени создания узла Bare Metal.

Возвращается: при успехе

deploy_interface

string

Интерфейс развертывания для узла, например, “direct”.

Возвращается: при успехе

deploy_step

string

Текущий шаг развертывания.

Возвращается: при успехе

driver

string

Имя драйвера.

Возвращается: при успехе

driver_info

dictionary

Все метаданные, необходимые драйверу для управления этим узлом. Список полей варьируется в зависимости от драйверов и может быть получен из ресурса /v1/drivers/<DRIVER_NAME>/properties.

Возвращается: при успехе

driver_internal_info

dictionary

Внутренние метаданные, установленные и хранящиеся драйвером узла.

Возвращается: при успехе

extra

dictionary

Набор из одной или нескольких произвольных пар «ключ-значение» метаданных.

Возвращается: при успехе

fault

string

Ошибка указывает на активную ошибку, обнаруженную ironic, обычно узел находится в «режиме обслуживания». None означает, что ironic не обнаружил ошибок. «power failure» указывает на то, что ironic не смог получить состояние питания с этого узла. Существуют и другие возможные типы, например, «clean failure» и «rescue abort failure».

Возвращается: при успехе

id

string

UUID для ресурса.

Возвращается: при успехе

inspect_interface

string

Интерфейс, используемый для проверки узла.

Возвращается: при успехе

instance_id

string

UUID экземпляра Nova, связанного с этим узлом.

Возвращается: при успехе

instance_info

dictionary

Информация, используемая для настройки развертываемого образа. Может включать размер корневого раздела, закодированный в base64 конфигурационный диск и другие метаданные. Обратите внимание, что это поле автоматически очищается при удалении экземпляра (это делается путем запроса изменения состояния подготовки узла на DELETED).

Возвращается: success

is_automated_clean_enabled

boolean

Указывает, будет ли узел выполнять автоматическую очистку или нет.

Возвращается: success

is_console_enabled

boolean

Указывает, включен или отключен доступ к консоли на этом узле.

Возвращается: success

is_maintenance

boolean

Находится ли этот узел в режиме технического обслуживания. Перевод узла в режим технического обслуживания удаляет его из доступного пула ресурсов и приостанавливает некоторую внутреннюю автоматизацию. Это может происходить вручную (например, через запрос API) или автоматически, когда Ironic обнаруживает аппаратный сбой, который предотвращает связь с машиной.

Возвращается: success

is_protected

boolean

Защищен ли узел от отключения, пересборки и удаления.

Возвращается: success

is_retired

boolean

Выведен ли узел из эксплуатации и, следовательно, больше не может быть предоставлен, т. е. перейти из управляемого в доступный, и окажется в управляемом после очистки (а не в доступном).

Возвращается: success

is_secure_boot

boolean

Указывает, загружен ли узел в данный момент с включенным secure_boot.

Возвращается: success

last_error

string

Любая ошибка из последней транзакции, которая началась, но не завершилась.

Возвращается: success

links

list / elements=string

Список относительных ссылок, включая ссылки self и bookmark.

Возвращается: success

maintenance_reason

string

Устанавливаемое пользователем описание причины, по которой этот узел был переведен в режим технического обслуживания

Возвращается: success

management_interface

string

Интерфейс для внеполосного управления узлом.

Возвращается: success

name

string

Читаемый человеком идентификатор ресурса узла. Может быть неопределен. Некоторые слова зарезервированы.

Возвращается: success

network_interface

string

Какой поставщик сетевого интерфейса использовать при подключении сетевых соединений для этого узла.

Возвращается: success

owner

string

Строка или UUID арендатора, которому принадлежит объект.

Возвращается: success

port_groups

list / elements=string

Список групп портов ironic на этом узле.

Возвращается: success

ports

list / elements=string

Список портов ironic на этом узле.

Возвращается: success

power_interface

string

Интерфейс, используемый для выполнения действий с питанием на узле, например, «ipmitool».

Возвращается: success

power_state

string

Текущее состояние питания этого узла. Обычно «включено» или «выключено», но может быть «None», если Ironic не может определить состояние питания (например, из-за аппаратного сбоя).

Возвращается: success

properties

dictionary

Физические характеристики этого узла. Заполняется ironic-inspector во время проверки. Может быть отредактирован через REST API в любое время.

Возвращается: success

protected_reason

string

Причина, по которой узел помечен как защищенный.

Возвращается: success

provision_state

string

Текущее состояние подготовки этого узла.

Возвращено: success

raid_config

dictionary

Представляет текущую конфигурацию RAID узла. Введено с функцией очистки.

Возвращено: success

raid_interface

string

Интерфейс, используемый для настройки RAID на этом узле.

Возвращено: success

rescue_interface

string

Интерфейс, используемый для аварийного восстановления узла, например, «no-rescue».

Возвращено: success

reservation

string

Имя хоста Ironic Conductor, который удерживает блокировку на этом узле, если блокировка удерживается. Обычно «null», но это поле может быть полезно для отладки.

Возвращено: success

resource_class

string

Строка, которая может использоваться внешними планировщиками для идентификации этого узла как единицы определенного типа ресурса. Для получения дополнительной информации см. https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html

Возвращено: success

retired_reason

string

Причина, по которой узел помечен как устаревший.

Возвращено: success

states

list / elements=string

Ссылки на коллекцию состояний.

Возвращено: success

storage_interface

string

Интерфейс, используемый для подключения и отключения томов на этом узле, например, «cinder».

Возвращено: success

target_power_state

string

Если был запрошен переход состояния питания, это поле представляет запрошенное (т. е. «целевое») состояние, либо «включено», либо «выключено».

Возвращено: success

target_provision_state

string

Если было запрошено действие подготовки, это поле представляет запрошенное (т. е. «целевое») состояние. Обратите внимание, что узел может пройти через несколько состояний во время перехода в это целевое состояние. Например, при запросе развертывания экземпляра на доступном узле узел может пройти через следующую последовательность изменений состояния: ДОСТУПНО -> РАЗВЕРТЫВАЕТСЯ -> DEPLOYWAIT -> РАЗВЕРТЫВАЕТСЯ -> АКТИВНО

Возвращено: success

target_raid_config

dictionary

Представляет запрошенную конфигурацию RAID узла, которая будет применена, когда узел в следующий раз перейдет в состояние ОЧИСТКИ. Введено с функцией очистки.

Возвращено: success

traits

list / elements=string

Список признаков для этого узла.

Возвращено: success

updated_at

string

Bare Metal узел обновлен в метку времени.

Возвращено: success

vendor_interface

string

Интерфейс для функций, специфичных для поставщика, на этом узле, например, «no-vendor».

Возвращено: success

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/baremetal_node_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API