google.cloud.gcp_runtimeconfig_variable – Создаёт переменную GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_runtimeconfig_variable.
Описание
- Описывает одну переменную внутри ресурса конфигурации времени выполнения.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| config строка / обязательно | Имя конфигурации времени выполнения, к которой принадлежит эта переменная. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это значение не должно устанавливаться, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов к API. | |
| name строка / обязательно | Имя ресурса переменной. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список / элементы=строка | Массив используемых областей доступа. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount. | |
| state строка |
| Требуется ли существование данного объекта в GCP. |
| text строка | Строковое значение переменной. Можно указать либо это, либо `value`. | |
| value строка | Двоичное значение переменной. Можно указать либо это, либо `text`. |
Примеры
- name: create a config
google.cloud.gcp_runtimeconfig_config:
name: my-config
description: My config
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: config
- name: create a variable
google.cloud.gcp_runtimeconfig_variable:
name: prod-variables/hostname
config: my-config
text: example.com
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| config строка | success | Имя конфигурации времени выполнения, к которой принадлежит эта переменная. |
| name строка | success | Имя ресурса переменной. |
| text строка | success | Строковое значение переменной. Можно указать либо это, либо `value`. |
| value строка | success | Двоичное значение переменной. Можно указать либо это, либо `text`. |
Авторы
- 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_runtimeconfig_variable_module.html
