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

Новое в версии 2.4.

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

Описание

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

Требования

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

python-requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
force boolean	Варианты: нет ← да	Если `true`, принудительно добавляет ключ развертывания, удалив любой существующий ключ развертывания с тем же открытым ключом или заголовком.
key - / обязательно		Открытый ключ SSH для добавления в репозиторий в качестве ключа развертывания.
name - / обязательно		Название для ключа развертывания. псевдонимы: заголовок, метка
otp -		6-значный одноразовый пароль для двухфакторной аутентификации. Требуется вместе с именем пользователя и паролем. псевдонимы: токен_2fa
owner - / обязательно		Имя учетной записи или организации, владеющей репозиторием GitHub. псевдонимы: учетная запись, организация
password -		Пароль для аутентификации. В качестве альтернативы можно использовать личный токен доступа вместо комбинации имя пользователя и пароль.
read_only boolean	Варианты: нет да ←	Если `true`, ключ развертывания сможет только читать содержимое репозитория. В противном случае ключ развертывания сможет читать и записывать.
repo - / обязательно		Имя репозитория GitHub. псевдонимы: репозиторий
state -	Варианты: present ← absent	Состояние ключа развертывания.
token -		Токен OAuth2 или личный токен доступа для аутентификации. Взаимоисключающее с паролем.
username -		Имя пользователя для аутентификации. Не должно быть установлено при использовании личного токена доступа

Примечания

Примечание

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

Примеры

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

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

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

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

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

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

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

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

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/github_deploy_key_module.html