Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_redis_instance — создание экземпляра GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: 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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учётных данных — accesstoken.

alternative_location_id

string

Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев зоны, размещая его в двух зонах.

Если это значение задано, оно должно указывать на зону, отличную от указанной в [locationId].

auth_enabled

boolean

Необязательный параметр. Указывает, включена ли для экземпляра аутентификация OSS Redis AUTH. Если задано значение «true», аутентификация AUTH включена для экземпляра.

Значение по умолчанию — «false», то есть аутентификация AUTH отключена.

Варианты:

  • false
  • true

auth_kind

string / обязательный

Тип используемых учётных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

authorized_network

string

Полное имя сети Google Compute Engine, к которой подключён экземпляр. Если значение не указано, будет использоваться сеть по умолчанию.

connect_mode

string

Режим подключения экземпляра Redis.

Допустимые варианты: «DIRECT_PEERING», «PRIVATE_SERVICE_ACCESS»

По умолчанию: "DIRECT_PEERING"

display_name

string

Произвольное необязательное имя экземпляра, заданное пользователем.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Этот параметр изменяет только строку User Agent для запросов к API.

labels

dictionary

Метки ресурса для представления метаданных, заданных пользователем.

location_id

string

Зона, в которой будет размещён экземпляр. Если значение не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также указано значение [alternativeLocationId], оно должно отличаться от [locationId].

memory_size_gb

integer / обязательный

Объём памяти Redis в ГиБ.

name

string / обязательный

Идентификатор экземпляра или его полное имя.

project

string

Проект Google Cloud Platform, который следует использовать.

redis_configs

dictionary

Параметры конфигурации 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

string

Версия программного обеспечения Redis. Если значение не указано, будет использоваться последняя поддерживаемая версия. Список актуальных допустимых значений см. в документации API по ссылке выше.

region

string / обязательный

Название региона Redis, в котором находится экземпляр.

reserved_ip_range

string

Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если значение не указано, служба выберет неиспользуемый блок /29, например 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не пересекаться с существующими подсетями в авторизованной сети.

scopes

list / elements=string

Массив используемых областей доступа

service_account_contents

jsonarg

Содержимое JSON-файла сервисного аккаунта — в виде словаря или JSON-строки, представляющей его.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбран serviceaccount.

state

string

Должен ли указанный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tier

string

Уровень службы экземпляра. Допустимые значения: - BASIC: автономный экземпляр - STANDARD_HA: высокодоступные экземпляры «основной/реплика» .

Допустимые варианты: «BASIC», «STANDARD_HA»

По умолчанию: "BASIC"

transit_encryption_mode

string

Режим TLS для экземпляра Redis. Если значение не указано, TLS для экземпляра отключён.

- SERVER_AUTHENTICATION: включено шифрование трафика от клиента к серверу с аутентификацией сервера .

Допустимые варианты: «SERVER_AUTHENTICATION», «DISABLED»

По умолчанию: "DISABLED"

Примечания

Примечание

  • Справочник API: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances
  • Официальная документация: 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.
  • Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно задать 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

string

Применяется только к уровню STANDARD_HA, который защищает экземпляр от сбоев зоны, размещая его в двух зонах.

Если значение указано, оно должно отличаться от зоны, заданной в [locationId].

Возвращается: при успешном выполнении

authEnabled

boolean

Необязательный параметр. Указывает, включена ли для экземпляра аутентификация Redis AUTH OSS. Если задано значение «true», аутентификация AUTH включена для экземпляра.

Значение по умолчанию — «false», то есть аутентификация AUTH отключена.

Возвращается: при успешном выполнении

authorizedNetwork

string

Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если значение не указано, будет использоваться сеть по умолчанию.

Возвращается: при успешном выполнении

connectMode

string

Режим подключения экземпляра Redis.

Возвращается: при успешном выполнении

createTime

string

Время создания экземпляра в формате RFC3339 UTC «Zulu» с точностью до наносекунд.

Возвращается: при успешном выполнении

currentLocationId

string

Текущая зона, в которой размещена конечная точка Redis.

Для экземпляров уровня Basic это значение всегда совпадает с [locationId], указанным пользователем при создании. Для экземпляров уровня Standard это может быть [locationId] или [alternativeLocationId]; значение может измениться после события переключения при сбое.

Возвращается: при успешном выполнении

displayName

string

Произвольное необязательное имя экземпляра, заданное пользователем.

Возвращается: при успешном выполнении

host

string

Имя хоста или IP-адрес открытой конечной точки Redis, используемой клиентами для подключения к сервису.

Возвращается: при успешном выполнении

labels

dictionary

Метки ресурса для представления метаданных, заданных пользователем.

Возвращается: при успешном выполнении

locationId

string

Зона, в которой будет создан экземпляр. Если значение не указано, сервис выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также указано значение [alternativeLocationId], оно должно отличаться от [locationId].

Возвращается: при успешном выполнении

memorySizeGb

integer

Размер памяти Redis в ГиБ.

Возвращается: при успешном выполнении

name

string

Идентификатор экземпляра или его полное имя.

Возвращается: при успешном выполнении

persistenceIamIdentity

string

Только для вывода. Идентификатор Cloud IAM, используемый операциями импорта и экспорта для передачи данных в Cloud Storage и из него. Формат: «serviceAccount:».

Для данного экземпляра значение может меняться со временем, поэтому его следует проверять перед каждой операцией импорта или экспорта.

Возвращается: при успешном выполнении

port

integer

Номер порта открытой конечной точки Redis.

Возвращается: при успешном выполнении

redisConfigs

dictionary

Параметры конфигурации 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

string

Версия программного обеспечения Redis. Если значение не указано, будет использоваться последняя поддерживаемая версия. Последние допустимые значения см. в документации API, ссылка на которую приведена выше.

Возвращается: при успешном выполнении

region

string

Название региона Redis, в котором находится экземпляр.

Возвращается: при успешном выполнении

reservedIpRange

string

Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если значение не указано, сервис выберет неиспользуемый блок /29, например 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не пересекаться с существующими подсетями в авторизованной сети.

Возвращается: при успешном выполнении

serverCaCerts

complex

Список сертификатов CA сервера для экземпляра.

Возвращается: при успешном выполнении

cert

string

Серийный номер, извлечённый из сертификата.

Возвращается: при успешном выполнении

createTime

string

Время создания сертификата.

Возвращается: при успешном выполнении

expireTime

string

Время истечения срока действия сертификата.

Возвращается: при успешном выполнении

serialNumber

string

Серийный номер, извлечённый из сертификата.

Возвращается: при успешном выполнении

sha1Fingerprint

string

Отпечаток сертификата SHA-1.

Возвращается: при успешном выполнении

tier

string

Уровень сервиса экземпляра. Должно быть указано одно из следующих значений: - BASIC: автономный экземпляр - STANDARD_HA: экземпляры «основной/реплика» с высокой доступностью.

Возвращается: при успешном выполнении

transitEncryptionMode

string

Режим TLS экземпляра Redis. Если значение не указано, TLS для экземпляра отключён.

- SERVER_AUTHENTICATION: шифрование трафика между клиентом и сервером включено с аутентификацией сервера.

Возвращается: при успешном выполнении

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_redis_instance_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API