redshift_info – Сбор информации о кластере(ах) Redshift

Новая версия с 2.4.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

Сбор информации о кластере(ах) Redshift
Этот модуль назывался redshift_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: redshift_facts

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

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
debug_botocore_endpoint_logs булево добавлен в 2.8	Варианты: нет ← да	Используйте логирватель botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время исполнения playbook. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
profile строка		Использует профиль 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 строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
tags -		Словарь/хеш тегов в формате { имя_тега1: 'значение_тега1', имя_тега2: 'значение_тега2' } для соответствия группам безопасности, которые вы ищете.
validate_certs булево	Варианты: нет да ←	При установке в "нет", сертификаты 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), если данные об учетных данных не предоставлены. См. https://boto.readthedocs.io/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_info:
  register: redshift

# Find cluster(s) with matching tags
- redshift_info:
    tags:
      env: prd
      stack: monitoring
  register: redshift_tags

# Find cluster(s) with matching name/prefix and tags
- redshift_info:
    tags:
      env: dev
      stack: web
    name: user-
  register: redshift_web

# Fail if no cluster(s) is/are found
- redshift_info:
    tags:
      env: stg
      stack: db
  register: redshift_user
  failed_when: "{{ redshift_user.results | length == 0 }}"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
allow_version_upgrade boolean	успех	Логическое значение, которое, если истинно, указывает, что обновления основной версии будут автоматически применяться к кластеру во время окна технического обслуживания. Пример: true\|false
automated_snapshot_retention_period integer	успех	Количество дней, в течение которого сохраняются автоматические снимки кластера. Пример: 1
availability_zone string	успех	Имя зоны доступности, в которой расположен кластер. Пример: us-east-1b
cluster_create_time string	успех	Дата и время создания кластера. Пример: 2016-05-10T08:33:16.629000+00:00
cluster_identifier string	успех	Уникальный ключ для идентификации кластера. Пример: redshift-identifier
cluster_nodes list	успех	Узлы в кластере. Пример: [{'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	успех	Список параметров кластера, связанных с этим кластером. Пример: [{'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	успех	Открытый ключ для кластера. Пример: ssh-rsa anjigfam Amazon-Redshift
cluster_revision_number string	успех	Конкретный номер версии базы данных в кластере. Пример: 1231
cluster_security_groups list	успех	Список групп безопасности кластера, связанных с кластером.
cluster_snapshot_copy_status dictionary	успех	Значение, которое возвращает целевой регион и период хранения, настроенные для копирования снимков в другие регионы.
cluster_status string	успех	Текущее состояние кластера. Пример: available
cluster_subnet_group_name string	успех	Имя группы подсетей, связанной с кластером. Пример: redshift-subnet
cluster_version string	успех	Идентификатор версии движка Amazon Redshift, работающего в кластере. Пример: 1.0
db_name string	успех	Имя начальной базы данных, созданной при создании кластера. Пример: dev
elastic_ip_status dictionary	успех	Состояние адреса Elastic IP (EIP).
encrypted boolean	успех	Булево значение, которое, если истинно, указывает, что данные в кластере зашифрованы в состоянии покоя. Пример: true\|false
endpoint string	успех	Точка подключения. Пример: {'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439}
enhanced_vpc_routing boolean	успех	Параметр, указывающий, следует ли создавать кластер с включенным расширенным маршрутизацией VPC. Пример: true\|false
hsm_status dictionary	успех	Значение, которое сообщает, завершил ли кластер Amazon Redshift применение любых изменений настроек модуля аппаратной безопасности (HSM), указанных в команде модификации кластера.
iam_roles list	успех	Список ролей IAM, прикрепленных к кластеру.
kms_key_id string	успех	Идентификатор ключа AWS Key Management Service (AWS KMS) используемого ключа шифрования для шифрования данных в кластере.
master_username string	успех	Имя пользователя для кластера. Пример: admin
modify_status string	необязательно	Состояние операции модификации.
node_type string	успех	Тип узла для узлов в кластере. Пример: ds2.xlarge
number_of_nodes integer	успех	Количество вычислительных узлов в кластере. Пример: 12
pending_modified_values dictionary	успех	Значение, которое, если присутствует, указывает на то, что изменения в кластере ожидают обработки.
preferred_maintenance_window string	успех	Еженедельный диапазон времени в формате UTC, в течение которого может происходить техническое обслуживание системы. Пример: вторник:07:30-вторник:08:00
publicly_accessible boolean	успех	Булево значение, которое, если истинно, указывает, что к кластеру можно получить доступ из общедоступной сети. Пример: true\|false
restore_status dictionary	успех	Значение, описывающее состояние действия восстановления кластера.
tags list	успех	Список тегов для кластера.

vpc_id строка	success	Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. Пример: vpc-1234567
vpc_security_groups список	success	Список групп безопасности VPC, связанных с кластером. Пример: [{'status': 'активно', 'vpc_security_group_id': 'sg-12cghhg'}]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/redshift_info_module.html