google.cloud.gcp_runtimeconfig_variable модуль — Создаёт переменную GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные зависимости, чтобы использовать этот модуль. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_runtimeconfig_variable.
Описание
- Описывает отдельную переменную в ресурсе конфигурации runtime.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации — accesstoken. |
auth_kind строка / обязательный | Тип используемых учетных данных. Варианты:
|
config строка / обязательный | Имя конфигурации runtime, к которой принадлежит эта переменная. |
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 строка | Имя конфигурации runtime, к которой принадлежит эта переменная. Возвращено: успешно |
name строка | Имя ресурса переменной. Возвращено: успешно |
text строка | Строковое значение переменной. Можно установить либо это, либо `value`. Возвращено: успешно |
value строка | Бинарное значение переменной. Можно установить либо это, либо `text`. Возвращено: успешно |
Ссылки на коллекцию
© 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_runtimeconfig_variable_module.html