модуль google.cloud.gcp_parameter_manager – доступ к объектам Google Cloud Parameter Manager и их обновление

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_parameter_manager.

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

Обзор

Доступ к объектам Google Cloud Parameter Manager и их обновление
Создание параметров.
Создание параметров с указанием формата.
Создание параметров с метками.
Создание параметров с указанием формата и меток.
Добавление и удаление версий параметров.
Удаление параметров.

Требования

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

python >= 3.7
requests >= 2.32.3
google-auth >= 2.39.0

Параметры

Параметр	Описание
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent для любых запросов к API.
format string	Формат используемого параметра. Варианты: `"UNFORMATTED"` ← (по умолчанию) `"JSON"` `"YAML"`
labels dictionary	Набор пар «ключ-значение», назначаемых параметру в качестве меток используется только при создании Обратите внимание: часть «value» метки должна содержать только читаемые символы По умолчанию: `{}`
location string	Расположение используемого параметра По умолчанию: `"global"`
name псевдонимы: key, parameter, parameter_id string / обязательный	Имя используемого параметра
project string	Используемый проект Google Cloud Platform. Если значение не задано, по умолчанию используется переменная среды ОС GCP_PROJECT
return_value boolean	если значение true, значение параметра будет возвращено в Ansible в незашифрованном виде если значение false, значение не будет возвращено или расшифровано Варианты: `false` `true` ← (по умолчанию)
scopes list / элементы=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли параметр существовать Варианты: `"absent"` `"present"` ← (по умолчанию)
value string	Значение, которое должен иметь параметр будет установлено при создании Если значение параметра отличается, будет добавлена новая версия с этим значением
version псевдонимы: version_id, parameter_version_id string	Имя используемого параметра

Примеры

- name: Create a new parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a new parameter with version
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: super_parameter
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a new structured parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    format: JSON
    value: '{"key":"value"}'
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a parameter with labels
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: super_parameter
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json
    labels:
      key_name: "ansible_rox"

- name: Create a structured parameter with labels
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    format: JSON
    value: '{"key":"value"}'
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json
    labels:
      key_name: "ansible_rox"

- name: Ensure the parameter exists, fail otherwise and return the value
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present

- name: Ensure parameter exists but don't return the value
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present
    return_value: false

- name: Add a new version of a parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: updated super parameter
    state: present

- name: Delete version 1 of a parameter (but not the parameter itself)
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    state: absent

- name: Delete parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: absent

- name: Create a new regional parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a new regional parameter with version
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: super_parameter
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a new structured regional parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    format: JSON
    value: '{"key":"value"}'
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Create a regional parameter with labels
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: super_parameter
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json
    labels:
      key_name: "ansible_rox"

- name: Create a structured regional parameter with labels
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    format: JSON
    value: '{"key":"value"}'
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json
    labels:
      key_name: "ansible_rox"

- name: Ensure the regional parameter exists, fail otherwise and return the value
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present

- name: Ensure regional parameter exists but don't return the value
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: present
    return_value: false

- name: Add a new version of a regional parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    value: updated super parameter
    state: present

- name: Delete version 1 of a regional parameter (but not the regional parameter itself)
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    version: version_key
    state: absent

- name: Delete parameter
  google.cloud.gcp_parameter_manager:
    name: parameter_key
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
location string	Расположение регионального параметра Возвращается: при успехе
msg string	Сообщение о том, что было (или не было) сделано Возвращается: при успехе, при ошибке
name string	Имя параметра Возвращается: при успехе
payload dictionary	Данные параметра в кодировке Base64 Возвращается: при успехе
status_code string	Код состояния HTTP ответа Google Cloud Возвращается: при успехе
url string	URL Google Cloud, использованный для выполнения запроса Возвращается: при успехе
value string	Расшифрованное значение данных параметра; используйте с осторожностью Возвращается: при успехе
version string	Возвращаемая версия параметра Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_parameter_manager_module.html