google.cloud.gcp_sql_user – Создаёт пользователя GCP

Примечание

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

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

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

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

Обзор

Ресурс Users представляет пользователя базы данных в экземпляре Cloud SQL.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательный	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется данный модуль. Это значение не должно устанавливаться, если вы не знаете, что делаете. Это значение влияет только на строку User Agent для любых запросов к API.
host строка / обязательный		Имя хоста, с которого пользователь может подключиться. Для операций вставки хост по умолчанию равен пустой строке. Для операций обновления хост указывается в URL запроса. Имя хоста нельзя обновить после вставки.
instance словарь / обязательный		Имя экземпляра Cloud SQL. Не включает идентификатор проекта. Это поле представляет собой ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_sql_instance, а затем установить это поле instance в "{{ name-of-resource }}"
name строка / обязательный		Имя пользователя в экземпляре Cloud SQL.
password строка		Пароль пользователя.
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Требуется ли существование данного объекта в GCP

Примеры

- name: create a instance
  google.cloud.gcp_sql_instance:
    name: "{{resource_name}}-1"
    settings:
      ip_configuration:
        authorized_networks:
        - name: google dns server
          value: 8.8.8.8/32
      tier: db-n1-standard-1
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a user
  google.cloud.gcp_sql_user:
    name: test-user
    host: 10.1.2.3
    password: secret-password
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Возвращаемое значение	Описание
host строка	success	Имя хоста, с которого пользователь может подключиться. Для операций вставки хост по умолчанию равен пустой строке. Для операций обновления хост указывается в URL запроса. Имя хоста нельзя обновить после вставки.
instance словарь	success	Имя экземпляра Cloud SQL. Не включает идентификатор проекта.
name строка	success	Имя пользователя в экземпляре Cloud SQL.
password строка	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_sql_user_module.html