Spec-Zone.ru › Ansible

Модуль community.aws.mq_broker — управление брокерами MQ

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.aws.mq_broker.

Добавлено в community.aws 6.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

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

  • Создание, обновление и удаление брокера.
  • Перезагрузка брокера.

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

authentication_strategy

строка

Выберите локальное или удаленное управление пользователями.

Варианты:

  • "SIMPLE"
  • "LDAP"

auto_minor_version_upgrade

логический

Разрешить или запретить автоматическое обновление до младшей версии.

Варианты:

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

aws_ca_bundle

путь

Путь к пакету сертификатов центра сертификации для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

broker_name

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

Имя брокера MQ, с которым нужно работать.

debug_botocore_endpoint_logs

логический

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных в ходе задачи, и вывода их набора в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

deployment_mode

строка

Задать тип развертывания брокера.

Можно использовать только при создании.

По умолчанию — SINGLE_INSTANCE.

Варианты:

  • "SINGLE_INSTANCE"
  • "ACTIVE_STANDBY_MULTI_AZ"
  • "CLUSTER_MULTI_AZ"

enable_audit_log

логический

Включить или отключить отправку журналов аудита в AWS CloudWatch.

Варианты:

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

enable_general_log

логический

Включить или отключить отправку общих журналов в AWS CloudWatch.

Варианты:

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

endpoint_url

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

строка

URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

engine_type

строка

Задать тип обработчика брокера.

Можно использовать только при создании.

По умолчанию — ACTIVEMQ.

Варианты:

  • "ACTIVEMQ"
  • "RABBITMQ"

engine_version

строка

Задать версию обработчика брокера.

Специальное значение latest выберет последнюю доступную версию.

Специальное значение latest игнорируется при обновлении.

host_instance_type

строка

Тип экземпляров брокера.

kms_key_id

строка

Использовать указанный ключ для шифрования данных брокера в состоянии покоя.

Можно использовать только при создании.

maintenance_window_start_time

словарь

Задать окно обслуживания для автоматических обновлений до младшей версии.

Можно использовать только при создании.

Если значение не указано, окно обслуживания не задается.

profile

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

строка

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

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.

publicly_accessible

логический

Разрешить или запретить публичный доступ.

Можно использовать только при создании.

По умолчанию — false.

Варианты:

  • false
  • true

region

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

строка

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

security_groups

список / элементы=строка

Связать группы безопасности с брокером.

При создании необходимо указать хотя бы одну группу.

session_token

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

строка

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

строка

present: создать или обновить брокер.

absent: удалить брокер.

restarted: перезагрузить брокер.

Варианты:

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

storage_type

строка

Задать тип базового хранилища.

Можно использовать только при создании.

По умолчанию — EFS.

Варианты:

  • "EBS"
  • "EFS"

subnet_ids

список / элементы=строка

Определяет, в каких подсетях развертывать экземпляры брокера.

Минимально необходимое количество зависит от типа развертывания.

Можно использовать только при создании.

tags

словарь

Добавить теги к создаваемым брокерам.

Можно использовать только при создании.

use_aws_owned_key

логический

Если также указан kms_key_id, значение должно быть false.

Можно использовать только при создании.

По умолчанию — true.

Варианты:

  • false
  • true

users

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

Этот параметр позволяет задать собственный набор начальных пользователей.

Для управления (локальными) пользователями предпочтительно использовать community.aws.mq_user, однако брокер нельзя создать без пользователей.

Если ничего не указано, вместе с брокерами будет создан пользователь admin по умолчанию.

Можно использовать только при создании. Для обновления используйте модуль community.aws.mq_user.

validate_certs

логический

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

wait

логический

добавлено в community.aws 7.1.0

Указывает, ожидает ли модуль достижения желаемого состояния state.

Время ожидания можно задать с помощью параметра wait_timeout.

Варианты:

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

wait_timeout

целое число

добавлено в community.aws 7.1.0

Сколько секунд ожидать перехода брокера в желаемое состояние, если wait=true.

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: create broker (if missing) with minimal required parameters
  community.aws.mq_broker:
    broker_name: "{{ broker_name }}"
    security_groups:
      - sg_xxxxxxx
    subnet_ids:
      - subnet_xxx
      - subnet_yyy
    register: result

- set_fact:
    broker_id: "{{ result.broker['BrokerId'] }}"

- name: use mq_broker_info to wait until broker is ready
  community.aws.mq_broker_info:
    broker_id: "{{ broker_id }}"
  register: result
  until: "result.broker['BrokerState'] == 'RUNNING'"
  retries: 15
  delay: 60

- name: create or update broker with almost all parameter set including credentials
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: present
    deployment_mode: 'ACTIVE_STANDBY_MULTI_AZ'
    use_aws_owned_key: false
    kms_key_id: 'my-precreted-key-id'
    engine_type: 'ACTIVEMQ'
    maintenance_window_start_time:
      DayOfWeek: 'MONDAY'
      TimeOfDay: '03:15'
      TimeZone: 'Europe/Berlin'
    publicly_accessible: true
    storage_type: 'EFS'
    security_groups:
      - sg_xxxxxxx
    subnet_ids:
      - subnet_xxx
      - subnet_yyy
    users:
      - Username: 'initial-user'
        Password': 'plain-text-password'
        ConsoleAccess: true
    tags:
      env: Test
      creator: ansible
    authentication_strategy: 'SIMPLE'
    auto_minor_version_upgrade: true
    engine_version: "5.15.13"
    host_instance_type: 'mq.t3.micro'
    enable_audit_log: true
    enable_general_log: true

- name: reboot a broker
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: restarted

- name: delete a broker
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: absent

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

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

Ключ

Описание

broker

словарь

Все ответы API преобразуются в snake yaml, кроме «Tags»

«state=present»: ответ API при вызове create_broker() или update_broker()

«state=absent»: результат вызова describe_broker() до запуска delete_broker()

«state=restarted»: результат вызова describe_broker() после запуска перезагрузки

Возвращается: при успешном выполнении

Авторы

  • FCO (@fotto)

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)
  • Связь

© 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/community/aws/mq_broker_module.html

Spec-Zone.ru

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