community.general.github_app_access_token поиск – Получение краткосрочных токенов доступа для приложения GitHub

Примечание

Этот плагин поиска входит в коллекцию community.general (версия 9.5.0).

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

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

Чтобы использовать его в книге задач, укажите: community.general.github_app_access_token.

Новое в community.general 8.2.0

Описание
Требования
Параметры ключевых слов
Примеры
Значение возврата

Описание

Это генерирует токен доступа GitHub, который может использоваться с командой git если вы используете приложение GitHub.

Требования

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

jwt (https://github.com/GehirnInc/python-jwt)

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

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

Параметр	Комментарии
app_id строка / обязательно	Ваш идентификатор приложения GitHub, его можно найти на странице настроек.
installation_id строка / обязательно	Идентификатор установки, содержащий репозиторий Git, к которому требуется доступ. По состоянию на 2023-12-24, он находится на странице настроек > Интеграции > Приложение. Последняя часть URL-адреса в кнопке настройки — это идентификатор установки. В качестве альтернативы можно использовать PyGithub (https://github.com/PyGithub/PyGithub) для получения идентификатора установки.
key_path путь / обязательно	Путь к вашему закрытому ключу.
token_expiry целое число	Сколько времени должен действовать токен в секундах. По умолчанию: `600`

Примеры

- name: Get access token to be used for git checkout with app_id=123456, installation_id=64209
  ansible.builtin.git:
    repo: >-
      https://x-access-token:{{ github_token }}@github.com/hidden_user/super-secret-repo.git
    dest: /srv/checkout
  vars:
    github_token: >-
      lookup('community.general.github_app_access_token', key_path='/home/to_your/key',
             app_id='123456', installation_id='64209')

Значение возврата

Ключ	Описание
Значение возврата список / элементы=строка	Список из одного элемента, содержащий ваш токен доступа GitHub. Возвращаемое значение: успех

Авторы

Poh Wei Sheng (@weisheng-p)

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, которая расположена ниже в списке, переопределит переменную, расположенную выше.

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

© 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/community/general/github_app_access_token_lookup.html