openstack.cloud.server_metadata – Добавление/Обновление/Удаление метаданных в вычислительных экземплярах из OpenStack
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook укажите: openstack.cloud.server_metadata.
Обзор
- Добавление, обновление или удаление метаданных в вычислительных экземплярах из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать сокетовое звено, прежде чем истечёт время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любые сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые для этого подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной авторизации, здесь следует указать имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Зона доступности, в которой нужно создать моментальную копию. | |
| ca_cert строка | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| meta словарь / обязательно | Список пар ключ-значение, которые должны быть предоставлены в качестве метаданных экземпляру, или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2" | |
| region_name строка | Название региона. | |
| server строка / обязательно | Имя экземпляра для обновления метаданных псевдонимы: name | |
| state строка |
| Должен ли ресурс быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs булево |
| Нужно ли проверять запросы API SSL. Перед Ansible 2.3 это имело значение по умолчанию yes. псевдонимы: verify |
| wait булево |
| Должен ли Ansible ждать, пока запрошенный ресурс будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Creates or updates hostname=test1 as metadata of the server instance vm1
- name: add metadata to compute instance
hosts: localhost
tasks:
- name: add metadata to instance
openstack.cloud.server_metadata:
state: present
auth:
auth_url: https://openstack-api.example.com:35357/v2.0/
username: admin
password: admin
project_name: admin
name: vm1
meta:
hostname: test1
group: group1
# Removes the keys under meta from the instance named vm1
- name: delete metadata from compute instance
hosts: localhost
tasks:
- name: delete metadata from instance
openstack.cloud.server_metadata:
state: absent
auth:
auth_url: https://openstack-api.example.com:35357/v2.0/
username: admin
password: admin
project_name: admin
name: vm1
meta:
hostname:
group:
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| metadata словарь | успех | Метаданные вычислительного экземпляра после изменения Пример: {'key1': 'value1', 'key2': 'value2'} |
| server_id строка | успех | Идентификатор вычислительного экземпляра, в котором были внесены изменения Пример: 324c4e91-3e03-4f62-9a4d-06119a8a8d16 |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/server_metadata_module.html
