Модуль google.cloud.gcp_spanner_instance – Создает экземпляр GCP

Примечание

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

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

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

Для использования в playbook, укажите: google.cloud.gcp_spanner_instance.

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

Краткое описание

Изолированный набор ресурсов Cloud Spanner, на которых могут размещаться базы данных.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / required	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
config string / required	Имя конфигурации экземпляра (похожее, но не совсем то же самое, что и регион), которое определяет географическое размещение и репликацию ваших баз данных в этом экземпляре. Оно определяет, где хранятся ваши данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т. д. Чтобы получить действительный список, обратитесь к [разделу «Конфигурация» в документации](https://cloud.google.com/spanner/docs/instances).
display_name string / required	Описательное имя этого экземпляра, как оно отображается в пользовательских интерфейсах. Должно быть уникальным для каждого проекта и иметь длину от 4 до 30 символов.
env_type string	Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
labels dictionary	Объект, содержащий список пар «ключ»: значение. Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
name string / required	Уникальный идентификатор экземпляра, который не может быть изменен после создания экземпляра. Имя должно иметь длину от 6 до 30 символов.
node_count integer	Количество узлов, выделенных для этого экземпляра. В terraform может присутствовать не более одного из node_count или processing_units.
processing_units integer	Количество процессорных единиц, выделенных для этого экземпляра. В terraform может присутствовать не более одного из processing_units или node_count.
project string	Проект Google Cloud Platform для использования.
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"`

Примечания

Примечание

Справочник по API: https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances
Официальная документация: https://cloud.google.com/spanner/
для аутентификации вы можете установить 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.
Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a instance
  google.cloud.gcp_spanner_instance:
    name: testinstance
    display_name: My Spanner Instance
    node_count: 2
    labels:
      cost_center: ti-1700004
    config: regional-us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
config строка	Имя конфигурации экземпляра (аналогичное, но не совсем то же самое, что регион), определяющее географическое расположение и репликацию ваших баз данных в этом экземпляре. Оно определяет, где хранятся ваши данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т.д. Для получения допустимого списка обратитесь к [разделу «Конфигурация» документации](https://cloud.google.com/spanner/docs/instances). Возвращается: успех
displayName строка	Дескриптивное имя для этого экземпляра, как оно отображается в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов. Возвращается: успех
labels словарь	Объект, содержащий список пар «ключ»: значение. Пример: { «имя»: «гаечный ключ», «масса»: «1,3 кг», «количество»: «3» }. Возвращается: успех
name строка	Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна быть от 6 до 30 символов. Возвращается: успех
nodeCount целое число	Количество узлов, выделенных для этого экземпляра. В terraform может присутствовать только одно из node_count или processing_units. Возвращается: успех
processingUnits целое число	Количество процессорных единиц, выделенных для этого экземпляра. В terraform может присутствовать только одно из processing_units или node_count. Возвращается: успех

Авторы

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_spanner_instance_module.html