Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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 или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

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

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

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

authentication_strategy

string

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

Варианты:

  • "SIMPLE"
  • "LDAP"

auto_minor_version_upgrade

boolean

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

Варианты:

  • false
  • true ← (default)

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

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

aws_config

dictionary

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

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

broker_name

string / required

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

  • false ← (default)
  • true

deployment_mode

string

Установите тип развертывания брокера.

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

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

Варианты:

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

enable_audit_log

boolean

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

Варианты:

  • false ← (default)
  • true

enable_general_log

boolean

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

Варианты:

  • false ← (default)
  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

engine_type

string

Установите тип движка брокера.

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

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

Варианты:

  • "ACTIVEMQ"
  • "RABBITMQ"

engine_version

string

Установите версию движка брокера.

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

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

host_instance_type

string

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

kms_key_id

string

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

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

maintenance_window_start_time

dictionary

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

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

Отсутствие значения означает «отсутствие окна обслуживания».

профиль

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

строка

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

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

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

Параметр профиль взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

доступно_извне

логическое

Разрешить/запретить внешний доступ.

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

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

Варианты:

  • false
  • true

регион

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

строка

Регион AWS для использования.

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

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

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

Псевдоним ec2_region устарел и будет удалён в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

секретный_ключ

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры секретный_ключ и профиль взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

группы_безопасности

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

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

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

токен_сессии

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры токен_сессии и профиль взаимоисключающие.

Псевдонимы aws_session_token и токен_сессии добавлены в релизе 3.2.0, параметр был переименован из security_token в токен_сессии в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

состояние

строка

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

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

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

Варианты:

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

тип_хранилища

строка

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

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

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

Варианты:

  • "EBS"
  • "EFS"

id_подсетей

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

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

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

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

метки

словарь

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

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

использовать_ключ_aws

логическое

Должен быть установлен в значение false если также указан kms_key_id.

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

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

Варианты:

  • false
  • true

пользователи

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

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

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

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

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

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверятся.

Настройка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите возможность настройки aws_ca_bundle вместо неё.

Варианты:

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

wait

boolean

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

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

Время ожидания можно контролировать с помощью настройки wait_timeout.

Варианты:

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

wait_timeout

integer

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

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

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». В связи с этим файлы, возможно, потребуются явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

dictionary

Все ответы API преобразуются в snake yaml, за исключением «Тегов»

‘state=present’: Ответ API вызова create_broker() или update_broker()

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

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

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

Авторы

  • FCO (@fotto)

Ссылки на сборку

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

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

Spec-Zone.ru

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