google.cloud.gcp_redis_instance – Создаёт экземпляр GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_redis_instance.
Обзор
- Экземпляр Google Cloud Redis.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alternative_location_id строка | Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев в зоне, предоставляя его в двух зонах. Если указано, оно должно отличаться от зоны, указанной в [locationId]. | |
| auth_enabled булево |
"false" | Необязательно. Указывает, включен ли для экземпляра OSS Redis AUTH. Если установлено "true", AUTH включен для экземпляра. Значение по умолчанию "false", что означает, что AUTH отключен. |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| authorized_network строка | Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, используется сеть по умолчанию. | |
| connect_mode строка | По умолчанию: "DIRECT_PEERING" | Режим подключения к экземпляру Redis. Некоторые допустимые варианты: "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS" |
| display_name строка | Произвольное и необязательное имя, заданное пользователем для экземпляра. | |
| env_type строка | Указывает, в какой среде Ansible вы запускаете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | |
| labels словарь | Метки ресурсов для представления предоставленных пользователем метаданных. | |
| location_id строка | Зона, в которой будет развернут экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев в зоне. Если также указан [alternativeLocationId], он должен отличаться от [locationId]. | |
| memory_size_gb целое число / обязательно | Размер памяти Redis в GiB. | |
| name строка / обязательно | Идентификатор экземпляра или полностью квалифицированный идентификатор экземпляра. | |
| project строка | Проект Google Cloud Platform для использования. | |
| redis_configs словарь | Параметры конфигурации Redis в соответствии с http://redis.io/topics/config. Обратитесь к документации Memorystore, чтобы узнать список поддерживаемых параметров: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs . | |
| redis_version строка | Версия программного обеспечения Redis. Если не указана, будет использована последняя поддерживаемая версия. В настоящее время поддерживаются следующие значения: - REDIS_5_0 для совместимости с Redis 5.0 - REDIS_4_0 для совместимости с Redis 4.0 - REDIS_3_2 для совместимости с Redis 3.2 . | |
| region строка / обязательно | Название региона Redis экземпляра. | |
| reserved_ip_range строка | Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если не указан, служба выберет неиспользуемый блок /29, например 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не перекрываться с существующими подсетями в авторизованной сети. | |
| scopes список / элементы=строка | Массив областей, которые будут использоваться. | |
| service_account_contents jsonarg | Содержание файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |
| state строка |
| Требуется ли существование данного объекта в GCP. |
| tier строка | По умолчанию: "BASIC" | Уровень службы экземпляра. Должно быть одно из следующих значений: - BASIC: автономный экземпляр - STANDARD_HA: высокодоступные первичные/реплицированные экземпляры . Некоторые допустимые варианты: "BASIC", "STANDARD_HA" |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/memorystore/docs/redis/reference/rest/
- Официальная документация: https://cloud.google.com/memorystore/docs/redis/
- для аутентификации можно установить service_account_file с помощью переменной среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
google.cloud.gcp_compute_network:
name: network-instance
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a instance
google.cloud.gcp_redis_instance:
name: instance37
tier: STANDARD_HA
memory_size_gb: 1
region: us-central1
location_id: us-central1-a
redis_version: REDIS_3_2
display_name: Ansible Test Instance
reserved_ip_range: 192.168.0.0/29
labels:
my_key: my_val
other_key: other_val
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Результат | Описание |
|---|---|---|
| alternativeLocationId строка | успешно | Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев зоны, предоставляя его в двух зонах. Если указано, оно должно отличаться от зоны, указанной в [locationId]. |
| authEnabled булево | успешно | Необязательно. Указывает, включена ли функция OSS Redis AUTH для экземпляра. Если установлено «true», AUTH включена для экземпляра. Значение по умолчанию — «false», что означает, что AUTH отключена. |
| authorizedNetwork строка | успешно | Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, будет использоваться сеть по умолчанию. |
| connectMode строка | успешно | Режим подключения экземпляра Redis. |
| createTime строка | успешно | Время создания экземпляра в формате RFC3339 UTC «Zulu», с точностью до наносекунд. |
| currentLocationId строка | успешно | Текущая зона размещения конечной точки Redis. Для экземпляров уровня Basic эта зона всегда будет совпадать с [locationId], указанным пользователем при создании. Для экземпляров уровня Standard она может быть либо [locationId], либо [alternativeLocationId], и может измениться после события отключения. |
| displayName строка | успешно | Произвольное и необязательное имя, предоставленное пользователем для экземпляра. |
| host строка | успешно | Имя хоста или IP-адрес открытой конечной точки Redis, используемой клиентами для подключения к службе. |
| labels словарь | успешно | Метки ресурсов для представления предоставленных пользователем метаданных. |
| locationId строка | успешно | Зона, в которой будет развернут экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также указан [alternativeLocationId], он должен отличаться от [locationId]. |
| memorySizeGb целое число | успешно | Размер памяти Redis в ГБ. |
| name строка | успешно | Идентификатор экземпляра или полное идентификатор экземпляра. |
| persistenceIamIdentity строка | успешно | Только для вывода. Идентификатор Cloud IAM, используемый операциями импорта/экспорта для передачи данных в/из Cloud Storage. Формат — "serviceAccount:". Значение может изменяться со временем для данного экземпляра, поэтому его следует проверять перед каждой операцией импорта/экспорта. |
| 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_5_0 для совместимости с Redis 5.0 - REDIS_4_0 для совместимости с Redis 4.0 - 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: высокодоступные экземпляры первичного/реплики. |
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_redis_instance_module.html
