Модуль openstack.cloud.catalog_service — управление службами OpenStack

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: openstack.cloud.catalog_service.

Краткое описание

Создание, обновление или удаление службы OpenStack.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго уровень сокетов должен ожидать перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не будет передано.
auth dictionary	Словарь с данными аутентификации, необходимыми выбранному облачному плагину аутентификации. Для плагина password, используемого по умолчанию, в словаре должны быть указаны auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов в этом параметре необходимо указать все параметры, требуемые соответствующим плагином аутентификации. Этот параметр не нужен, если указано имя облака или заданы переменные среды OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина, а содержимое параметра auth необходимо обновить соответствующим образом.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов CA, который можно использовать для проверки запросов API по SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при SSL-соединении.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при SSL-соединении.
cloud any	Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или заданы переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
description string	Описание службы.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, извлекаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_enabled псевдонимы: enabled boolean	Включена ли эта служба. Варианты: `false` `true`
name string / обязательный	Имя службы.
region_name string	Имя региона.
sdk_log_level string	Уровень журналирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если он не указан, журнал не ведётся.
state string	Должна ли служба быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: `180`
type псевдонимы: service_type string / обязательный	Тип службы.
validate_certs псевдонимы: verify boolean	Нужно ли проверять запросы API по SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
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: Create a service for glance
  openstack.cloud.catalog_service:
     cloud: mycloud
     state: present
     name: glance
     type: image
     description: OpenStack Image Service

- name: Delete a service
  openstack.cloud.catalog_service:
     cloud: mycloud
     state: absent
     name: glance
     type: image

Возвращаемые значения

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

Ключ	Описание
service dictionary	Словарь с описанием службы. Возвращается: при успешном выполнении, если state имеет значение ‘present’
description string	Описание службы. Возвращается: при успешном выполнении Пример: `"OpenStack Image Service"`
id string	Идентификатор службы. Возвращается: при успешном выполнении Пример: `"3292f020780b4d5baf27ff7e1d224c44"`
is_enabled boolean	Состояние службы. Возвращается: при успешном выполнении Пример: `true`
links string	Ссылка на службу Возвращается: при успешном выполнении Пример: `"http://10.0.0.1/identity/v3/services/0ae87"`
name string	Имя службы. Возвращается: при успешном выполнении Пример: `"glance"`
type string	Тип службы. Возвращается: при успешном выполнении Пример: `"image"`

Авторы

Специальная группа OpenStack Ansible

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

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