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

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

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

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
config строка / обязательно		Имя конфигурации экземпляра (аналогично, но не совсем идентично региону), которая определяет географическое расположение и репликацию баз данных в этом экземпляре. Она определяет, где хранятся данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т. д. Для получения корректного списка обратитесь к разделу [Конфигурация в документации](https://cloud.google.com/spanner/docs/instances).
display_name строка / обязательно		Описание названия экземпляра, как оно отображается в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это поле следует заполнять только в том случае, если вы знаете, что делаете. Это влияет только на строку User Agent при всех запросах к API.
labels словарь		Объект, содержащий список пар "ключ": значение. Пример: { "name": "гаечный ключ", "масса": "1.3кг", "количество": "3" }.
name строка / обязательно		Уникальный идентификатор экземпляра, который нельзя изменить после его создания. Длина имени должна быть от 6 до 30 символов.
node_count целое число	По умолчанию: "1"	Количество узлов, выделенных для этого экземпляра.
project строка		Проект Google Cloud Platform, который нужно использовать.
scopes список / элементы=строка		Массив используемых областей видимости.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как JSON-строка, представляющая его.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Определяет, должен ли данный объект существовать в GCP.

Примечания

Примечание

Ссылка на 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.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
Параметры 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 строка	success	Имя конфигурации экземпляра (аналогично, но не совсем идентично региону), которая определяет географическое расположение и репликацию баз данных в этом экземпляре. Она определяет, где хранятся данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т. д. Для получения корректного списка обратитесь к разделу [Конфигурация в документации](https://cloud.google.com/spanner/docs/instances).
displayName строка	success	Описание названия экземпляра, как оно отображается в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов.
labels словарь	success	Объект, содержащий список пар "ключ": значение. Пример: { "name": "гаечный ключ", "масса": "1.3кг", "количество": "3" }.
name строка	success	Уникальный идентификатор экземпляра, который нельзя изменить после его создания. Длина имени должна быть от 6 до 30 символов.
nodeCount целое число	success	Количество узлов, выделенных для этого экземпляра.

Авторы

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.10/collections/google/cloud/gcp_spanner_instance_module.html