Модуль google.cloud.gcp_sql_user – Создание пользователя GCP

Примечание

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

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

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

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

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

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

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

Требования

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

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"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
host string / required	Имя хоста, с которого пользователь может подключаться. Для операций вставки host по умолчанию — пустая строка. Для операций обновления host указывается как часть URL запроса. Имя хоста не может быть обновлено после вставки.
instance dictionary / required	Имя экземпляра Cloud SQL. Это не включает идентификатор проекта. Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, можно разместить словарь с ключом ‘name’ и значением имени вашего ресурса. В качестве альтернативы, можно добавить `register: name-of-resource` к задаче gcp_sql_instance, а затем установить это поле instance в “{{ name-of-resource }}”
name string / required	Имя пользователя в экземпляре Cloud SQL.
password string	Пароль для пользователя.
project string	Используемый проект Google Cloud Platform.
scopes list / elements=string	Массив областей, которые будут использоваться
service_account_contents jsonarg	Содержимое файла Service Account JSON, либо в виде словаря, либо в виде представляющей его JSON-строки.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примеры

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

Авторы

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