Gitlab Runner
Resumo
- Registrar, atualizar e excluir runners com a API GitLab.
Parâmetros
Parâmetros | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
access_level | string | Escolhas: - ref_protected (default) - not_protected | Determina se um runner pode apanhar postos de trabalho em ramos protegidos. |
active | boolean | Escolhas: - false - true (default) | Definir se os runners serão imediatamente ativos após a criação. |
api_token | string | | Token GitLab para login. |
api_url | string | | O caminho da API em formato URL. |
description - required aliases: name | string | | O nome exclusivo do runner.
|
locked | boolean | Escolhas: - false (default) - true | Determina se o runner será ou não trancado. |
maximum_timeout | integer | Default: 3600 | O tempo máximo de espera que um runner tem para apanhar um trabalho específico. |
registration_token | string | | O código de registo é utilizado para registar novos runners. |
run_untagged | boolean | Escolhas: - false - true (default) | Executar ou não trabalhos não marcados. |
state | string | Escolhas: - present (default) - absent | Certifique-se de que o runner com o mesmo nome existe com a mesma configuração ou elimine o runner com o mesmo nome. |
tag_list | list / elements=string | Default: [] | As etiquetas que se aplicam ao runner. |
validate_certs | boolean | Escolhas: - false - true (default) | Validar ou não os certificados SSL ao fornecer uma url https. |
Notas
- Para criar um novo runner, são necessárias pelo menos as opções api_token, descrição e api_url.
- Os runners precisam ter descrições únicas.
Exemplos
# Exemplo: Registrar runner
- gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
registration_token: 4gfdsg345
description: Docker Machine t1
state: present
active: True
tag_list: ['docker']
run_untagged: False
locked: False
# Exemplo: Deletar runner
- gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
description: Docker Machine t1
registration_token: 4gfdsg345
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
error | string | Falhar | A mensagem de erro devolvida pelo GitLab API |
msg | string | Sempre | Mensagem de sucesso ou falha. |
result | dictionary | Sempre | Resposta json do servidor. |
runner | dictionary | Sempre | Objeto API. |