Github Deploy Key
Resumo
- Adiciona ou remove chaves de implantação para repositórios GitHub. Suporta autenticação usando nome de usuário e senha, nome de usuário e senha e código de autenticação de 2 fatores (OTP), token OAuth2 ou token de acesso pessoal. São necessários direitos de administrador no repositório.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
force | bolean | Escolhas: - false (default) - true | Se true, forçosamente adiciona a chave de implantação excluindo qualquer chave de implantação existente com a mesma chave pública ou título. |
github_url | string | Valor Padrão: "https://api.github.com" | O URL base da API GitHub |
key | string | | A chave pública SSH a ser adicionada ao repositório como uma chave de implantação. |
name - required
aliases: título, rótulo | string | | O nome da chave de implantação. |
otp aliases: 2fa_token | string | | A senha de uso único de 6 dígitos para autenticação de 2 fatores. Obrigatório junto com o nome de usuário e a senha . |
owner - required
aliases: conta, organização | string | | O nome da conta individual ou organização que possui o repositório GitHub. |
password | string | | A senha para autenticação. Como alternativa, um token de acesso pessoal pode ser usado em vez da combinação de nome de usuário e senha . |
read_only | boolean | Escolhas: - false - true (default) | Se true, a chave de implantação só será capaz de ler o conteúdo do repositório. Caso contrário, a chave de implantação será capaz de ler e gravar. |
repo - required aliases: repositório | string | | O nome do repositório GitHub. |
state | string | Escolhas: - present (default) - absent | O estado da chave de implantação. |
token | string | | |
username | string | | O nome de usuário para autenticação. Não deve ser definido ao usar token de acesso pessoal |
Exemplos
# Adicionar uma chave de implantação de projeto
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
title: "Jenkins CI"
state: present
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
# name: Atualize a chave de implantação acima para adicionar acesso por push
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
title: "Jenkins CI"
state: present
can_push: yes
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
# name: Remova a chave de implantação anterior do projeto
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
title: "Jenkins CI"
state: absent
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
Valores Retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
error | string | erro | A mensagem de erro retornada pela API GitHub |
http_status_code | integer | erro | O código de status HTTP retornado pela API GitHub |
id | integer | alterado | O identificador de chave atribuído pelo GitHub para a chave de implantação |
msg | string | sempre | A mensagem de status descrevendo o que ocorreu |