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 - | Произвольное и необязательное имя, указанное пользователем для экземпляра. | |
| 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_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 строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться в качестве словаря, а как строка, содержащая точное содержимое файла json учетной записи службы (корректный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount. | |
| state - |
| Следует ли, чтобы данный объект существовал в GCP |
| tier - |
| Уровень обслуживания экземпляра. Должно быть одно из этих значений: - 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_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: 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_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.8/modules/gcp_redis_instance_module.html
