поиск google.cloud.gcp_parameter_manager — получение параметров из Google Cloud с помощью плагина поиска

Примечание

Этот плагин поиска входит в коллекцию 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 и их формате см. на странице https://cloud.google.com/iam/docs/service-account-creds
после получения значение параметра возвращается в декодированном виде. Разработчик должен обеспечить конфиденциальность этого значения после его получения.
если задан параметр location, выполняется обращение к региональным параметрам указанного местоположения

Параметры ключевых слов

Здесь описаны параметры ключевых слов для поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('google.cloud.gcp_parameter_manager', key1=value1, key2=value2, ...) и query('google.cloud.gcp_parameter_manager', key1=value1, key2=value2, ...)

Параметр	Комментарии
access_token строка	поддержка токена доступа GCP если значение не задано, используется переменная среды ОС GCP_ACCESS_TOKEN
auth_kind строка	тип аутентификации для Google Cloud (например, serviceaccount или machineaccount) если значение не задано, используется переменная среды ОС GCP_AUTH_KIND
key псевдонимы: name, parameter, parameter_id строка / обязательный	имя параметра для поиска в Менеджере параметров
location строка	Если указано, задаёт местоположение регионального параметра.
on_error строка	способ обработки ошибок strict — вызвать исключение warn — вывести предупреждение и вернуть none ignore — просто вернуть none Варианты: `"strict"` ← (по умолчанию) `"warn"` `"ignore"`
project строка	имя проекта Google Cloud если значение не задано, используется переменная среды ОС GCP_PROJECT
render_secret логическое значение	поддержка отображения секретов если значение не задано, используется false Варианты: `false` `true`
scopes список / элементы=строка	области аутентификации для Менеджера параметров Google По умолчанию: `["https://www.googleapis.com/auth/cloud-platform"]`
service_account_email строка	адрес электронной почты, связанный с сервисным аккаунтом если значение не задано, используется переменная среды ОС GCP_SERVICE_ACCOUNT_EMAIL
service_account_file строка	файл учётных данных JSON, полученный из Google Cloud если значение не задано, используется переменная среды ОС GCP_SERVICE_ACCOUNT_FILE подробные сведения см. на странице https://cloud.google.com/iam/docs/service-account-creds
service_account_info словарь	объект JSON, представляющий содержимое файла service_account_file, полученного из Google Cloud если значение не задано, используется переменная среды ОС GCP_SERVICE_ACCOUNT_INFO
version строка	имя версии извлекаемого параметра

Примеры

- name: Test parameter using env variables for credentials
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', version='test_version') }}"

- name: Test parameter using explicit credentials
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', version='test_version', project='project', auth_kind='serviceaccount',
                    service_account_file='file.json') }}"

- name: Test getting specific version of a parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', version='test-version') }}"

- name: Test getting latest version of a parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key') }}"

- name: Test render specific version of a parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', version='test-version', render_secret=True) }}"

- name: Test render latest version of a parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', render_secret=True) }}"

- name: Test regional parameter using env variables for credentials
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1', version='test_version') }}"

- name: Test regional parameter using explicit credentials
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1', version='test_version', project='project',
                    auth_kind='serviceaccount', service_account_file='file.json') }}"

- name: Test getting specific version of a regional parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1', version='test_version') }}"

- name: Test getting latest version of a regional parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1') }}"

- name: Test render specific version of a regional parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1', version='test_version', render_secret=True) }}"

- name: Test render latest version of a regional parameter
  ansible.builtin.debug:
    msg: "{{ lookup('google.cloud.gcp_parameter_manager', key='parameter_key', location='us-central1', render_secret=True) }}"

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

Ключ	Описание
Возвращаемое значение список / элементы=строка	содержимое запрошенного параметра (используйте «no_log», чтобы не раскрыть этот параметр) Возвращается: при успешном выполнении

Авторы

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