gcp_redis_instance – Создаёт экземпляр GCP Instance
Новое в версии 2.8.
Описание
- Экземпляр Google Cloud Redis.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alternative_location_id строка | Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев зоны, предоставляя его в двух зонах. Если указано, оно должно отличаться от зоны, указанной в [locationId]. | |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| authorized_network строка | Полное имя сети Google Compute Engine, к которой подключён экземпляр. Если не указано, будет использована сеть по умолчанию. | |
| display_name строка | Произвольное и необязательное имя, предоставленное пользователем для экземпляра. | |
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Это значение не должно устанавливаться, если вы не знаете, что делаете. Это значение изменяет только строку User Agent для всех запросов API. | |
| labels словарь | Метки ресурсов для представления предоставленных пользователем метаданных. | |
| location_id строка | Зона, в которой будет создан экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также указано [alternativeLocationId], оно должно отличаться от [locationId]. | |
| memory_size_gb целое число / обязательно | Размер памяти Redis в ГБ. | |
| 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_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 с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
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
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]. |
| 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_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: высокодоступные экземпляры первичный/реплики. |
Статус
- Этот модуль не гарантирует обратной совместимости. [предварительная версия]
- Этот модуль поддерживается сообществом 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.9/modules/gcp_redis_instance_module.html
