Модуль community.aws.msk_config — Управление конфигурациями кластеров Amazon MSK
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: community.aws.msk_config.
Добавлен в community.aws 2.0.0
Обзор
- Создание, удаление и изменение конфигураций кластеров Amazon MSK (Managed Streaming for Apache Kafka).
- До версии 5.0.0 этот модуль назывался
community.aws.aws_msk_config. Способ использования не изменился.
Псевдонимы: aws_msk_config
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке сертификатов SSL. Переменная окружения |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
config aliases: configuration dictionary | Содержимое файла server.properties. По умолчанию: |
debug_botocore_endpoint_logs boolean | Использовать Переменная окружения Варианты:
|
description string | Описание конфигурации. По умолчанию: |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только на AWS. Переменные окружения Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения |
kafka_versions list / elements=string | Версии Apache Kafka, с которыми можно использовать эту конфигурацию MSK. Обязательно, когда state=present. |
name string / required | Название конфигурации. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная окружения Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные окружения См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной окружения |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные окружения Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | AWS STS сессия токен для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры security_token и profile взаимоисключают друг друга. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
state string | Создать ( Выбои:
|
validate_certs boolean | При установке в Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого. Выбои:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), который использует Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- community.aws.msk_config:
name: kafka-cluster-configuration
state: present
kafka_versions:
- 2.6.0
- 2.6.1
config:
auto.create.topics.enable: false
num.partitions: 1
default.replication.factor: 3
zookeeper.session.timeout.ms: 18000
- community.aws.msk_config:
name: kafka-cluster-configuration
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
arn string | Amazon Resource Name (ARN) конфигурации. Возвращается: state=present Пример: |
response dictionary | Ответ от фактического API-запроса. Возвращается: всегда Пример: |
revision integer | Номер ревизии. Возвращается: state=present Пример: |
server_properties string | Содержимое файла server.properties. Возвращается: state=present Пример: |
Ссылки на сборку
© 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/msk_config_module.html