redshift_facts - Сбор фактов о кластере(ах) Redshift
Новое в версии 2.4.
Обзор
- Сбор фактов о кластере(ах) Redshift
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| cluster_identifier | Префикс идентификатора кластера Redshift, который вы ищете. Это сопоставление по регулярному выражению с неявным '^'. Добавьте '$' для полного соответствия. псевдонимы: name, identifier | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. | |
| profile (добавлен в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token (добавлен в 1.6) | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| tags | Словарь/хеш тегов в формате { tag1_name: 'tag1_value', tag2_name: 'tag2_value' }, для сопоставления с целевыми группами безопасности. | |
| validate_certs bool (добавлен в 1.5) |
| При значении "no", сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Note: These examples do net set authentication details, see the AWS guide for details.
# Find all clusters
- redshift_facts:
register: redshift
# Find cluster(s) with matching tags
- redshift_facts:
tags:
env: prd
stack: monitoring
register: redshift_tags
# Find cluster(s) with matching name/prefix and tags
- redshift_facts:
tags:
env: dev
stack: web
name: user-
register: redshift_web
# Fail if no cluster(s) is/are found
- redshift_facts:
tags:
env: stg
stack: db
register: redshift_user
failed_when: "{{ redshift_user.results | length == 0 }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| allow_version_upgrade boolean | success | Булево значение, которое, если равно true, указывает, что обновления основной версии будут автоматически применяться к кластеру во время окна обслуживания. Пример: true|false |
| automated_snapshot_retention_period int | success | Количество дней, в течение которых сохраняются автоматические снимки кластера. Пример: 1 |
| availibility_zone string | success | Имя зоны доступности, в которой расположен кластер. Пример: us-east-1b |
| cluster_create_time string | success | Дата и время создания кластера. Пример: 2016-05-10T08:33:16.629000+00:00 |
| cluster_identifier string | success | Уникальный ключ для идентификации кластера. Пример: redshift-identifier |
| cluster_nodes list | success | Узлы в кластере. Пример: [{'node_role': 'LEADER', 'private_ip_address': '10.0.0.1', 'public_ip_address': 'x.x.x.x'}, {'node_role': 'COMPUTE-1', 'private_ip_address': '10.0.0.3', 'public_ip_address': 'x.x.x.x'}] |
| cluster_paramater_groups list | success | Список параметров кластера, связанных с этим кластером. Пример: [{'cluster_parameter_status_list': [{'parameter_apply_status': 'in-sync', 'parameter_name': 'statement_timeout'}, {'parameter_apply_status': 'in-sync', 'parameter_name': 'require_ssl'}], 'parameter_apply_status': 'in-sync', 'parameter_group_name': 'tuba'}] |
| cluster_public_keys string | success | Открытый ключ для кластера. Пример: ssh-rsa anjigfam Amazon-Redshift |
| cluster_revision_number string | success | Конкретный номер ревизии базы данных в кластере. Пример: 1231 |
| cluster_security_groups list | success | Список групп безопасности кластера, связанных с кластером. |
| cluster_snapshot_copy_status dict | success | Значение, возвращающее целевую область и срок хранения, настроенные для копирования снимков между регионами. |
| cluster_status string | success | Текущее состояние кластера. Пример: available |
| cluster_subnet_group_name string | success | Имя группы подсетей, связанной с кластером. Пример: redshift-subnet |
| cluster_version string | success | Идентификатор версии движка Amazon Redshift, работающего в кластере. Пример: 1.0 |
| db_name string | success | Имя начальной базы данных, созданной при создании кластера. Пример: dev |
| elastic_ip_status dict | success | Состояние эластичного IP-адреса (EIP). |
| encrypted boolean | success | Булево значение, которое, если равно true, указывает, что данные в кластере шифруются в состоянии покоя. Пример: true|false |
| endpoint string | success | Точка подключения. Пример: {'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439} |
| enhanced_vpc_routing boolean | success | Опция, которая указывает, следует ли создавать кластер с включённым улучшенным маршрутизацией VPC. Пример: true|false |
| hsm_status dict | success | Значение, которое сообщает, завершил ли кластер Amazon Redshift применение изменений настроек модуля аппаратной безопасности (HSM), указанных в команде изменения кластера. |
| iam_roles list | success | Список ролей IAM, прикрепленных к кластеру. |
| kms_key_id string | success | Идентификатор ключа AWS Key Management Service (AWS KMS) ключа шифрования, используемого для шифрования данных в кластере. |
| master_username string | success | Имя пользователя мастера для кластера. Пример: admin |
| modify_status string | optional | Состояние операции изменения. |
| node_type string | success | Тип узла для узлов в кластере. Пример: ds2.xlarge |
| number_of_nodes int | success | Количество вычислительных узлов в кластере. Пример: 12 |
| pending_modified_values dict | success | Значение, если оно присутствует, указывает на то, что изменения в кластере находятся в ожидании. |
| preferred_maintenance_window string | success | Еженедельный временной интервал в формате универсального времени координации (UTC), в течение которого может выполняться техническое обслуживание системы. Пример: tue:07:30-tue:08:00 |
| publicly_accessible boolean | success | Булево значение, которое, если равно true, указывает, что к кластеру можно получить доступ из общедоступной сети. Пример: true|false |
| restore_status dict | success | Значение, описывающее состояние действия восстановления кластера. |
| tags list | success | Список тегов для кластера. |
| vpc_id string | success | Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. Пример: vpc-1234567 |
| vpc_security_groups list | success | Список групп безопасности VPC, связанных с кластером. Пример: [{'status': 'активный', 'vpc_security_group_id': 'sg-12cghhg'}] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Jens Carl (@j-carl)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/redshift_facts_module.html