community.general.github_deploy_key – Управляет ключами развертывания для репозиториев GitHub.

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.github_deploy_key.

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

Обзор

Добавляет или удаляет ключи развертывания для репозиториев GitHub. Поддерживает аутентификацию с использованием имени пользователя и пароля, имени пользователя и пароля и кода двухфакторной аутентификации (OTP), токена OAuth2 или персонального токена доступа. Требуются права администратора на репозиторий.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
force boolean	Варианты: нет ← да	Если `true`, принудительно добавляет ключ развертывания, удаляя любой существующий ключ развертывания с тем же открытым ключом или названием.
github_url string добавлен в версии 0.2.0 community.general	Значение по умолчанию: "https://api.github.com"	Базовый URL API GitHub
key string / обязательно		Открытый ключ SSH для добавления в репозиторий в качестве ключа развертывания.
name string / обязательно		Имя для ключа развертывания. Псевдонимы: title, label
otp string		6-значный одноразовый пароль для двухфакторной аутентификации. Требуется вместе с именем пользователя и паролем. Псевдонимы: 2fa_token
owner string / обязательно		Имя индивидуальной учетной записи или организации, владеющей репозиторием GitHub. Псевдонимы: account, organization
password string		Пароль для аутентификации. В качестве альтернативы, вместо комбинации имя пользователя и пароль можно использовать персональный токен доступа.
read_only boolean	Варианты: нет да ←	Если `true`, ключ развертывания сможет только читать содержимое репозитория. В противном случае ключ развертывания сможет читать и записывать.
repo string / обязательно		Имя репозитория GitHub. Псевдонимы: repository
state string	Варианты: present ← absent	Состояние ключа развертывания.
token string		Токен OAuth2 или персональный токен доступа для аутентификации. Взаимоисключительно с паролем.
username string		Имя пользователя для аутентификации. Не должно быть установлено при использовании персонального токена доступа.

Примечания

Примечание

Обратитесь к документации API GitHub здесь: https://developer.github.com/v3/repos/keys/.

Примеры

- name: Add a new read-only deploy key to a GitHub repository using basic authentication
  community.general.github_deploy_key:
    owner: "johndoe"
    repo: "example"
    name: "new-deploy-key"
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAwXxn7kIMNWzcDfou..."
    read_only: yes
    username: "johndoe"
    password: "supersecretpassword"

- name: Remove an existing deploy key from a GitHub repository
  community.general.github_deploy_key:
    owner: "johndoe"
    repository: "example"
    name: "new-deploy-key"
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAwXxn7kIMNWzcDfou..."
    force: yes
    username: "johndoe"
    password: "supersecretpassword"
    state: absent

- name: Add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
  community.general.github_deploy_key:
    owner: "johndoe"
    repository: "example"
    name: "new-deploy-key"
    key: "{{ lookup('file', '~/.ssh/github.pub') }}"
    force: yes
    token: "ABAQDAwXxn7kIMNWzcDfo..."

- name: Re-add a deploy key to a GitHub repository but with a different name
  community.general.github_deploy_key:
    owner: "johndoe"
    repository: "example"
    name: "replace-deploy-key"
    key: "{{ lookup('file', '~/.ssh/github.pub') }}"
    username: "johndoe"
    password: "supersecretpassword"

- name: Add a new deploy key to a GitHub repository using 2FA
  community.general.github_deploy_key:
    owner: "johndoe"
    repo: "example"
    name: "new-deploy-key-2"
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAwXxn7kIMNWzcDfou..."
    username: "johndoe"
    password: "supersecretpassword"
    otp: 123456

- name: Add a read-only deploy key to a repository hosted on GitHub Enterprise
  community.general.github_deploy_key:
    github_url: "https://api.example.com"
    owner: "janedoe"
    repo: "example"
    name: "new-deploy-key"
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAwXxn7kIMNWzcDfou..."
    read_only: yes
    username: "janedoe"
    password: "supersecretpassword"

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

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

Ключ	Возвращаемое значение	Описание
error string	неудачно	сообщение об ошибке, возвращенное API GitHub Пример: ключ уже используется
http_status_code integer	неудачно	код HTTP-статуса, возвращенный API GitHub Пример: 400
id integer	изменено	идентификатор ключа, назначенный GitHub для ключа развертывания Пример: 24381901
msg string	всегда	сообщение о статусе, описывающее произошедшее Пример: Ключ развертывания успешно добавлен

Авторы

Ali (@bincyber)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/github_deploy_key_module.html