community.general.github_app_access_token lookup — получение краткосрочных токенов доступа GitHub App

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 App.

Требования

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

jwt (https://github.com/GehirnInc/python-jwt) ИЛИ
PyJWT (https://pypi.org/project/PyJWT/) И cryptography (https://pypi.org/project/cryptography/)

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

Здесь описаны параметры ключевых слов плагина поиска. В следующих примерах это значения 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 string / обязательный	Идентификатор вашего GitHub App. Его можно найти на странице Settings.
github_url string добавлено в community.general 11.4.0	Базовый URL API GitHub (для GitHub Enterprise Server). Пример: `https://github-enterprise-server.example.com/api/v3` По умолчанию: `"https://api.github.com"`
installation_id string / обязательный	Идентификатор установки, в которой находится репозиторий Git, к которому требуется доступ. По состоянию на 2023-12-24 его можно найти на странице Settings > Integrations > Application. Последняя часть URL в кнопке Configure — это идентификатор установки. Кроме того, для получения идентификатора установки можно использовать PyGithub (https://github.com/PyGithub/PyGithub).
key_path path	Путь к закрытому ключу. Необходимо указать либо `key_path`, либо `private_key`.
private_key string добавлено в community.general 10.0.0	Закрытый ключ GitHub App в формате PEM, переданный в виде строки. Необходимо указать либо `key_path`, либо `private_key`.
token_expiry integer	Срок действия токена в секундах. По умолчанию: `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') }}

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

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

Авторы

Poh Wei Sheng (@weisheng-p)
Bruno Lavoie (@blavoie)

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

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