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

Новая версия с 2.7.

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

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind - / обязательно	Варианты: machineaccount serviceaccount application	Тип используемых учетных данных.
config -		Ссылка на конфигурацию экземпляра.
display_name - / обязательно		Дескриптивное имя экземпляра, отображаемое в пользовательских интерфейсах. Должно быть уникальным для проекта и содержать от 4 до 30 символов.
labels -		Метки Cloud — это гибкий и лёгкий механизм для организации ресурсов облака в группы, которые отражают организационные потребности и стратегии развертывания клиента. Метки Cloud могут использоваться для фильтрации наборов ресурсов. Они могут использоваться для управления тем, как агрегируются метрики ресурсов. И они могут использоваться в качестве аргументов правил управления политикой (например, маршрутизации, брандмауэра, балансировки нагрузки и т. д.). Ключи меток должны иметь длину от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9][a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9][a-z0-9])?)?`. Не более 64 меток могут быть связаны с данным ресурсом. Дополнительную информацию и примеры меток см. на странице https://goo.gl/xmQnxf. Если вы планируете использовать метки в собственном коде, имейте в виду, что в будущем могут быть разрешены дополнительные символы. Поэтому рекомендуется использовать внутреннее представление меток, например, JSON, которое не зависит от запрещённых символов. Например, представление меток в виде строки: имя + "_" + значение может вызвать проблемы, если в будущем будет разрешён символ "_". Объект, содержащий список пар "ключ": значение. Пример: { "name": "отвёртка", "масса": "1,3 кг", "количество": "3" }.
name -		Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Значения имеют вид projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. Последний сегмент имени должен иметь длину от 6 до 30 символов.
node_count -		Количество узлов, выделенных для этого экземпляра.
project -	Значение по умолчанию: null	Проект Google Cloud Platform, который необходимо использовать.
scopes -		Массив используемых областей.
service_account_email -		Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file -		Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount.
state -	Варианты: present ← absent	Необходимо ли наличие данного объекта в GCP

Примечания

Примечание

Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключают друг друга.

Примеры

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

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
config строка	success	Ссылка на конфигурацию экземпляра.
display_name строка	success	Дескриптивное имя экземпляра, отображаемое в пользовательских интерфейсах. Должно быть уникальным для проекта и содержать от 4 до 30 символов.
labels словарь	success	Метки Cloud — это гибкий и лёгкий механизм для организации ресурсов облака в группы, которые отражают организационные потребности и стратегии развертывания клиента. Метки Cloud могут использоваться для фильтрации наборов ресурсов. Они могут использоваться для управления тем, как агрегируются метрики ресурсов. И они могут использоваться в качестве аргументов правил управления политикой (например, маршрутизации, брандмауэра, балансировки нагрузки и т. д.). Ключи меток должны иметь длину от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9][a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9][a-z0-9])?)?`. Не более 64 меток могут быть связаны с данным ресурсом. Дополнительную информацию и примеры меток см. на странице https://goo.gl/xmQnxf. Если вы планируете использовать метки в собственном коде, имейте в виду, что в будущем могут быть разрешены дополнительные символы. Поэтому рекомендуется использовать внутреннее представление меток, например, JSON, которое не зависит от запрещённых символов. Например, представление меток в виде строки: имя + "_" + значение может вызвать проблемы, если в будущем будет разрешён символ "_". Объект, содержащий список пар "ключ": значение. Пример: { "name": "отвёртка", "масса": "1,3 кг", "количество": "3" }.
name строка	success	Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Значения имеют вид projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. Последний сегмент имени должен иметь длину от 6 до 30 символов.
node_count целое число	success	Количество узлов, выделенных для этого экземпляра.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.7/modules/gcp_spanner_instance_module.html