Spec-Zone.ru › Ansible

google.cloud.gcp_redis_instance модуль — Создаёт экземпляр GCP Instance

Примечание

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

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в книге задач укажите: google.cloud.gcp_redis_instance.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Экземпляр Redis Google Cloud.

Требования

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

строка

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

alternative_location_id

строка

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

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

auth_enabled

булево

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

Значение по умолчанию — «false», что означает отключение AUTH.

Варианты:

  • false ← (по умолчанию)
  • true

auth_kind

строка / обязательно

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

Варианты:

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

authorized_network

строка

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

connect_mode

строка

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

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

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

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. Если не указано, будет использоваться последняя поддерживаемая версия. Последние допустимые значения см. в документации API, приведенной вверху.

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

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

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

Значение по умолчанию — «false», что означает, что AUTH отключена.

Возвращается: успех

authorizedNetwork

string

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

Возвращается: успех

connectMode

string

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

Возвращается: успех

createTime

string

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

Возвращается: успех

currentLocationId

string

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

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

Возвращается: успех

displayName

string

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

Возвращается: успех

host

string

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

Возвращается: успех

labels

dictionary

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

Возвращается: успех

locationId

string

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

Возвращается: успех

memorySizeGb

integer

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

Возвращается: успех

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 для экземпляра.

Возвращается: success

cert

string

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

Возвращается: success

createTime

string

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

Возвращается: success

expireTime

string

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

Возвращается: success

serialNumber

string

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

Возвращается: success

sha1Fingerprint

string

Отпечаток SHA1 сертификата.

Возвращается: success

tier

string

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

Возвращается: success

transitEncryptionMode

string

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

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

Возвращается: success

Авторы

  • Google Inc. (@googlecloudplatform)

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

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

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

Spec-Zone.ru

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