google.cloud.gcp_sql_user – Создаёт пользователя GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_sql_user.
Описание
- Ресурс Пользователи представляет базу данных пользователя в экземпляре Cloud SQL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| 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 строка |
| Требуется ли существование объекта в 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_sql_user_module.html