Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.
Sobre o dimensionamento automático
Você pode aumentar ou diminuir automaticamente o número de executores auto-hospedados no seu ambiente em resposta aos eventos do webhook que você recebe com uma determinada etiqueta. Por exemplo, você poderá criar uma automação que adiciona um novo executor auto-hospedado sempre que receber um evento de webhook workflow_job com a atividade queued, o que notifica você de que um novo trabalho está pronto para processamento. A carga do webhook inclui dados da etiqueta. Portanto, você pode identificar o tipo de executor que a tarefa está solicitando. Depois que o trabalho for concluído, crie uma automação que remove o executor em resposta à atividade workflow_job completed.
Soluções de dimensionamento automático recomendadas
GitHub recomenda e faz parcerias estreitas com dois projetos de código aberto que você pode usar para dimensionar automaticamente os seus executores. Uma ou ambas as soluções podem ser adequadas, com base nas suas necessidades.
Os repositórios a seguir possuem instruções detalhadas para configurar esses dimensionadores automáticos:
- actions/actions-runner-controller – Um controlador do Kubernetes para os executores auto-hospedados do GitHub Actions.
- philips-labs/terraform-aws-github-runner – Um módulo do Terraform para os executores escalonáveis do GitHub Actions na Amazon Web Services.
Cada solução tem certas especificações que podem ser importantes para considerar.
| actions-runner-controller | terraform-aws-github-runner | |
|---|---|---|
| Runtime | Kubernetes | VMs do Linux e do Windows |
| Nuvens compatíveis | Azure, Amazon Web Services, Google Cloud Platform, nos locais | Amazon Web Services |
| Onde os executores podem ser dimensionados | Níveis de empresa, organização e repositório. Por etiqueta do executor e grupo de executores. | Níveis de organização e repositório. Por etiqueta do executor e grupo de executores. |
| Como os executores podem ser dimensionados | Eventos de webhook, Programados, Baseados em extrações | Eventos de Webhook, Programados (únicamente executores a nível de organização) |
Usaar executores efêmeros para dimensionamento automático
GitHub recomenda implementar o dimensionamento automático com executores auto-hospedados efêmeros. Nãose recomenda o dimensionamento automático com executores auto-hospedados persistentes. Em certos casos, GitHub não pode garantir que os trabalhos não sejam atribuídos a executores persistentes enquanto eles são desativados. Com executores efêmeros, é possível garantir iss, porque GitHub só atribui um trabalho a um executor.
Esta abordagem permite que você gerencie os seus executores como sistemas efêmeros, já que você pode usar automação para fornecer um ambiente limpo para cada trabalho. Isso ajuda a limitar a exposição de quaisquer recursos sensíveis de trabalhos anteriores e também ajuda a mitigar o risco de um executor comprometido receber novos trabalhos.
Para adicionar um executor efêmero ao seu ambiente, inclua o parâmetro --ephemeral ao registrar o executor usando config.sh. Por exemplo:
./config.sh --url https://github.com/octo-org --token example-token --ephemeralO serviço GitHub Actions irá cancelar o resgistro do runner automaticamente depois de ter processado um trabalho. Em seguida, você poderá criar a sua própria automação que limpa o runner depois que ele tiver seu registro cancelado.
Observação: se um trabalho estiver rotulado para certo tipo de executor, mas nenhuma correspondência desse tipo estiver disponível, o trabalho não falhará imediatamente no momento da colocação na fila. Em vez disso, o trabalho permanecerá na fila até que o período de tempo limite de 24 horas expire.
Usando webhooks para dimensionamento automático
Você pode criar seu ambiente de dimensionamento automático usando cargas recebidas do webhook workflow_job. Esse webhook está disponível nos níveis do repositório, da organização e da empresa, e a carga desse evento contém uma chave action que corresponde às fases do ciclo de vida de um trabalho de fluxo de trabalho, por exemplo, quando os trabalhos são queued, in_progress e completed. Você deverá criar a sua própria automação de dimensionamento em resposta a estas cargas de webhook.
- Para saber mais sobre o webhook
workflow_job, confira "Eventos e cargas de webhook". - Para saber como trabalhar com webhooks, confira "Criar webhooks".
Requisitos de autenticação
Você pode registrar e excluir os executores auto-hospedados da organização e do repositório usando a API. Para efetuar a autenticação na API, a implementação do seu dimensionamento automático pode usar um token de acesso ou um aplicativo de GitHub.
Seu token de acesso exigirá o seguinte escopo:
- Para repositórios privados, use um token de acesso com o escopo
repo. - Para repositórios públicos, use um token de acesso com o escopo
public_repo. - Para organizações, use um token de acesso com o escopo
admin:org.
Para efetuar a autenticação usando um aplicativo de GitHub, este deverá ter as seguintes permissões:
- Para repositórios, atribua a permissão
administration. - Para organizações, atribua a permissão
organization_self_hosted_runners.
Você pode registrar e excluir os executores auto-hospedados da empresa usando a API. Para efetuar a autenticação na API, sua implementação de dimensionamento automático pode usar um token de acesso.
Seu token de acesso exigirá o escopo manage_runners:enterprise.