gcp_redis_instance_facts – Сбор фактов для экземпляра GCP
Новая в версии 2.8.
Обзор
- Сбор фактов для экземпляра GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| project строка | Проект Google Cloud Platform для использования. | |
| region - / обязательно | Имя региона Redis экземпляра. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи сервиса. Не следует передавать это как словарь, а как строку, содержащую точное содержимое файла JSON учетной записи сервиса (действительный JSON). | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если выбран тип serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a instance facts"
gcp_redis_instance_facts:
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны в разделе, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| items сложное | всегда | Список элементов | |
| alternativeLocationId строка | успех | Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев в зоне, развертывая его в двух зонах. Если указано, оно должно быть отличным от зоны, указанной в [locationId]. | |
| authorizedNetwork строка | успех | Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, будет использоваться сеть по умолчанию. | |
| createTime строка | успех | Время создания экземпляра в формате RFC3339 UTC "Zulu", точное до наносекунд. | |
| currentLocationId строка | успех | Текущая зона размещения конечной точки Redis. Для экземпляров уровня Basic эта зона всегда совпадает с [locationId], указанным пользователем при создании. Для экземпляров уровня Standard она может быть либо [locationId], либо [alternativeLocationId] и может изменяться после события переключения. | |
| displayName строка | успех | Произвольное и необязательное имя экземпляра, заданное пользователем. | |
| host строка | успех | Имя хоста или IP-адрес открытой конечной точки Redis, используемой клиентами для подключения к службе. | |
| labels словарь | успех | Метки ресурсов для представления пользовательских метаданных. | |
| locationId строка | успех | Зона, в которой будет развернут экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев в зоне. Если также указан [alternativeLocationId], он должен отличаться от [locationId]. | |
| memorySizeGb целое число | успех | Размер памяти Redis в ГБ. | |
| name строка | успех | Идентификатор экземпляра или полное квалифицированное идентификатор экземпляра. | |
| port целое число | успех | Номер порта открытой конечной точки Redis. | |
| redisConfigs словарь | успех | Параметры конфигурации Redis, согласно http://redis.io/topics/config.
Пожалуйста, проверьте документацию Memorystore для списка поддерживаемых параметров: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs . | |
| redisVersion строка | успех | Версия программного обеспечения Redis. Если не указано, будет использоваться последняя поддерживаемая версия. Обновление версии выполнит обновление/перевод на новую версию. В настоящее время поддерживаемые значения — REDIS_3_2 для Redis 3.2. | |
| region строка | успех | Имя региона Redis экземпляра. | |
| reservedIpRange строка | успех | Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если не указано, служба выберет неиспользуемый блок /29, например, 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не пересекаться с существующими подсетями в авторизованной сети. | |
| tier строка | успех | Уровень службы экземпляра. Должно быть одно из следующих значений: - BASIC: автономный экземпляр - STANDARD_HA: высокодоступные экземпляры primary/replica. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_redis_instance_facts_module.html