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

Примечание

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

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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
force boolean	Варианты: no ← yes	Если `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-значный одноразовый пароль для двухфакторной аутентификации. Требуется вместе с username и password. псевдонимы: 2fa_token
owner string / обязательно		Имя учетной записи или организации, владеющей репозиторием GitHub. псевдонимы: account, organization
password string		Пароль для аутентификации. В качестве альтернативы вместо комбинации username и password можно использовать личный токен доступа.
read_only boolean	Варианты: no yes ←	Если `true`, ключ развертывания сможет только читать содержимое репозитория. В противном случае ключ развертывания сможет читать и записывать.
repo string / обязательно		Имя репозитория GitHub. псевдонимы: repository
state string	Варианты: present ← absent	Состояние ключа развертывания.
token string		Токен OAuth2 или личный токен доступа для аутентификации. Взаимоисключительно с password.
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	failed	сообщение об ошибке, возвращенное API GitHub Пример: ключ уже используется
http_status_code integer	failed	код HTTP-статуса, возвращенный API GitHub Пример: 400
id integer	changed	идентификатор ключа, назначенный GitHub для ключа развертывания Пример: 24381901
msg string	always	сообщение статуса, описывающее произошедшее Пример: Ключ развертывания добавлен успешно

Авторы

Ali (@bincyber)

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