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

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

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

Описание

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

Требования

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

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

Параметры

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

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить 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_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
  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 строка	успех	Имя хоста, с которого пользователь может подключиться. Для операций вставки хост по умолчанию пустой. Для операций обновления хост указывается в URL-адресе запроса. Имя хоста нельзя обновить после вставки.
instance словарь	успех	Имя экземпляра Cloud SQL. Он не включает идентификатор проекта.
name строка	успех	Имя пользователя в экземпляре Cloud SQL.
password строка	успех	Пароль пользователя.

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/gcp_sql_user_module.html