Enterprise Server 3.20 está disponível no momento como versão candidata a lançamento.

Controlador de Ações Runner

Você pode hospedar seus próprios executores e personalizar o ambiente usado para realizar tarefas nos fluxos de trabalho do GitHub Actions.

Neste artigo

Sobre o Actions Runner Controller

O Actions Runner Controller (ARC) é um operador Kubernetes que orquestra e dimensiona executores auto-hospedados para o GitHub Actions. Para obter mais informações, confira Padrão do operador da documentação do Kubernetes.

Com o ARC, você pode criar conjuntos de dimensionamento de executores que são dimensionados automaticamente com base no número de fluxos de trabalho em execução em seu repositório, organização ou empresa. Como os executores controlados podem ser efêmeros e baseados em contêineres, novas instâncias do executor podem expandir ou reduzir rapidamente e de forma limpa. Para obter mais informações sobre o dimensionamento automático, confira Referência de executores auto-hospedados.

O diagrama a seguir ilustra a arquitetura do modo de conjunto de escalonamento automático do runner do ARC.

Observação

Para ver o diagrama a seguir em um tamanho maior, confira a documentação do Modo de Conjuntos de Escalonamento do Runner de Escalação Automática no repositório Actions Runner Controller.

Diagrama mostrando o modo ScaleSet do executor de Dimensionamento Automático do ARC.

  1. Actions Runner Controller é instalado usando os gráficos do Helm fornecidos e o pod de gerenciador de controlador é implantado no namespace especificado. Um novo recurso AutoScalingRunnerSet é implantado por meio dos gráficos do Helm fornecidos ou de um arquivo de manifesto personalizado. O Controlador AutoScalingRunnerSet chama as APIs do GitHub para buscar a ID do grupo de executores à qual o conjunto de dimensionamento do executor pertencerá.
  2. O Controlador AutoScalingRunnerSet chama as APIs mais uma vez para buscar ou criar um conjunto de dimensionamento de executores no serviço GitHub Actions antes de criar o recurso Listener do ScaleSet do Executor.
  3. Um pod Ouvinte de Runner ScaleSet é implantado pelo controlador AutoScalingListener. Nesse pod, o aplicativo de ouvinte se conecta ao serviço GitHub Actions para autenticar e estabelecer uma conexão de sondagem longa HTTPS. O ouvinte permanece ocioso até receber uma mensagem Job Available do serviço GitHub Actions.
  4. Quando uma execução de fluxo de trabalho é disparada de um repositório, o serviço GitHub Actions despacha execuções de trabalho individuais para os executores ou conjuntos de escalonamento de executores, onde a chave runs-on corresponde ao nome do conjunto de escalonamento ou aos rótulos dos executores auto-hospedados.
  5. Quando o ScaleSet Listener do Runner recebe a mensagem Job Available, verifica se pode escalar para cima até a contagem desejada. Se puder, o Listener ScaleSet do Runner reconhecerá a mensagem.
  6. O Listener do Runner ScaleSet usa uma Conta de Serviço e um Papel associado a essa conta para fazer uma chamada HTTPS por meio das APIs do Kubernetes para atualizar o recurso RunnerSet Efêmero com o número de réplicas desejadas.
  7. O Ephemeral RunnerSet tenta criar novos processadores, e o EphemeralRunner Controller solicita um token de configuração JIT (Just-In-Time) para registrar esses processadores. O controlador tenta criar pods de runner. Se o status do pod for failed, o controlador tentará novamente até 5 vezes. Após 24 horas, o serviço GitHub Actions cancelará a atribuição do trabalho se nenhum executor o aceitar.
  8. Depois que o pod do executor é criado, o aplicativo do executor no pod usa o token de configuração JIT para se registrar no serviço GitHub Actions. Em seguida, ele estabelece outra conexão de sondagem longa HTTPS para receber os detalhes do trabalho que precisa executar.
  9. O serviço GitHub Actions reconhece o registro do executor e envia os detalhes da execução do trabalho.
  10. Durante toda a execução do trabalho, o executor se comunica continuamente os logs e o status de execução do trabalho de volta ao serviço GitHub Actions.
  11. Quando o executor conclui o trabalho com êxito, o Controlador EphemeralRunner verifica com o serviço GitHub Actions para ver se o executor pode ser excluído. Se puder, o RunnerSet efêmero excluirá o runner.

Componentes do Actions Runner Controller

O ARC consiste em um conjunto de recursos, alguns dos quais criados especificamente para ele. A implantação do ARC aplica esses recursos a um cluster de Kubernetes. Uma vez aplicado, ele cria um conjunto de Pods que contêm os contêineres dos runners auto-hospedados. Com o ARC, a GitHub pode tratar esses contêineres de runner como runners auto-hospedados e alocar trabalhos a eles conforme necessário.

Cada recurso implantado pelo ARC recebe um nome formado por estes elementos:

  • Um nome da instalação, que é o nome que você especifica ao instalar o Helm chart.
  • Um sufixo de identificação do recurso, que é uma cadeia de caracteres que identifica o tipo de recurso. Este valor não é configurável.

Observação

Cada versão do Kubernetes têm limites de comprimento diferentes para os nomes dos recursos. O limite do comprimento do nome do recurso é calculado adicionando o comprimento do nome da instalação ao comprimento do sufixo de identificação do recurso. Se o nome do recurso for maior que o comprimento reservado, você receberá uma mensagem de erro.

Recursos implementados por gha-runner-scale-set-controller

ModeloTipo de recursoNomeComprimento reservadoDescriçãoObservações
deployment.yamlImplantaçãoINSTALLATION_NAME-gha-rs-controller18O recurso que executa o gerenciador de controladoresOs pods criados por esse recurso têm os sufixos ReplicaSet e Pod.
serviceaccount.yamlServiceAccountINSTALLATION_NAME-gha-rs-controller18Esse recurso será criado se serviceAccount.create em values.yaml estiver definido como verdadeiro.O nome pode ser personalizado em values.yaml
manager_cluster_role.yamlClusterRoleINSTALLATION_NAME-gha-rs-controller18ClusterRole para o Controller ManagerEsse recurso será criado se o valor de flags.watchSingleNamespace estiver vazio.
manager_cluster_role_binding.yamlClusterRoleBindingINSTALLATION_NAME-gha-rs-controller18ClusterRoleBinding do gerenciador de controladoresEsse recurso será criado se o valor de flags.watchSingleNamespace estiver vazio.
manager_single_namespace_controller_role.yamlFunçãoINSTALLATION_NAME-gha-rs-controller-single-namespace35Função do gerenciador do controladorEsse recurso será criado se for definido um valor para flags.watchSingleNamespace.
manager_single_namespace_controller_role_binding.yamlRoleBindingINSTALLATION_NAME-gha-rs-controller-single-namespace35RoleBinding para o controller managerEsse recurso será criado se for definido um valor para flags.watchSingleNamespace.
manager_single_namespace_watch_role.yamlFunçãoINSTALLATION_NAME-gha-rs-controller-single-namespace-watch41Função do gerenciador de controladores no namespace configuradoEsse recurso será criado se for definido um valor para flags.watchSingleNamespace.
manager_single_namespace_watch_role_binding.yamlRoleBindingINSTALLATION_NAME-gha-rs-controller-single-namespace-watch41RoleBinding para o gerente de controlador no namespace configuradoEsse recurso será criado se for definido um valor para flags.watchSingleNamespace.
manager_listener_role.yamlFunçãoINSTALLATION_NAME-gha-rs-controller-listener26Função do ouvinteIsso é sempre criado.
manager_listener_role_binding.yaml RoleBindingINSTALLATION_NAME-gha-rs-controller-listener26RoleBinding para o ouvinteEsse recurso é sempre criado e associa a função de ouvinte à conta de serviço, que é criada por serviceaccount.yaml ou configurada com values.yaml.

Recursos implementados por gha-runner-scale-set

ModeloTipo de recursoNomeComprimento reservadoDescriçãoObservações
autoscalingrunnerset.yamlAutoscalingRunnerSetINSTALLATION_NAME0Recurso de nível mais alto aplicando conjuntos de escalamentoO comprimento do nome está limitado a 45 caracteres.
no_permission_service_account.yamlServiceAccountINSTALLATION_NAME-gha-rs-sem-permissão21Conta de serviço montada no contêiner do runnerEsse recurso será criado se o modo do contêiner não for "kubernetes" e template.spec.serviceAccountName não for especificado.
githubsecret.yamlSegredoINSTALLATION_NAME-gha-rs-github-secret20Segredo que contém valores necessários para autenticar na API de GitHubEste elemento é criado se githubConfigSecret for um objeto. Se for fornecida uma cadeia de caracteres, o segredo não será criado.
manager_role.yamlFunçãoINSTALLATION_NAME-gha-rs-manager15Função fornecida ao gerenciador para permitir a reconciliação de recursos no namespace do conjunto de executores de dimensionamento automáticoIsso é sempre criado.
manager_role_binding.yamlRoleBindingINSTALLATION_NAME-gha-rs-manager15Associa manager_role à conta de serviço do gerenciador.Isso é sempre criado.
kube_mode_role.yamlFunçãoINSTALLATION_NAME-gha-rs-kube-mode17Função que fornece as permissões necessárias para o ganchoEsse recurso é criado quando o modo do contêiner é definido como "kubernetes" e template.spec.serviceAccount não é fornecido.
kube_mode_serviceaccount.yamlServiceAccountINSTALLATION_NAME-gha-rs-kube-mode17Conta de serviço associada ao pod do runner.Esse recurso é criado quando o modo do contêiner é definido como "kubernetes" e template.spec.serviceAccount não é fornecido.

Sobre recursos personalizados

O ARC consiste em várias CRDs (definições de recursos personalizados). Para obter mais informações sobre recursos personalizados, confira Recursos personalizados na documentação do Kubernetes. Você pode encontrar a lista de definições de recursos personalizados usadas para ARC nas definições de esquema de API a seguir.

  •         [actions.github.com/v1alpha1](https://pkg.go.dev/github.com/actions/actions-runner-controller/apis/actions.github.com/v1alpha1)

  •         [actions.summerwind.net/v1alpha1](https://pkg.go.dev/github.com/actions/actions-runner-controller/apis/actions.summerwind.net/v1alpha1)

Como os recursos personalizados são extensões da API do Kubernetes, eles não estarão disponíveis em uma instalação do Kubernetes padrão. Você precisará instalar esses recursos personalizados para usar o ARC. Para obter mais informações sobre como instalar recursos personalizados, confira Guia de início rápido do Actions Runner Controller.

Depois que os recursos personalizados forem instalados, você poderá implantar o ARC no cluster do Kubernetes. Para saber mais sobre como implantar o ARC, confira Como implantar conjuntos de dimensionamento de executores com o Actions Runner Controller.

Sobre a imagem de contêiner runner

O GitHub mantém uma imagem mínima de contêiner runner. Uma nova imagem será publicada com cada lançamento de binários do runner. A imagem mais recente terá a versão de binários do runner e latest como tags.

Essa imagem contém a menor quantidade de pacotes necessários para o tempo de execução do contêiner e os binários do executor. Para instalar software adicional, você pode criar sua própria imagem de runner. Você pode usar a imagem de execução do ARC como base ou usar as ações de configuração correspondentes. Por exemplo, actions/setup-java para Java ou actions/setup-node para Node.js.

Você pode encontrar a definição da imagem do executor ARC no Dockerfile. Para exibir a imagem base atual, confira a linha FROM no Dockerfile da imagem do runner e pesquise essa tag no repositório dotnet/dotnet-docker.

Por exemplo, se a linha FROM no Dockerfile da imagem do executor for mcr.microsoft.com/dotnet/runtime-deps:8.0-jammy AS build, você poderá encontrar a imagem base em https://github.com/dotnet/dotnet-docker/blob/main/src/runtime-deps/8.0/jammy/amd64/Dockerfile.

Criando sua própria imagem de runner

Você pode criar sua própria imagem do runner que atenda às suas necessidades. A imagem do executor deve atender às condições a seguir.

Você pode usar o seguinte Dockerfile de exemplo para começar a criar sua própria imagem de runner.

Dockerfile
FROM mcr.microsoft.com/dotnet/runtime-deps:6.0 as build

# Replace value with the latest runner release version
# source: https://github.com/actions/runner/releases
# ex: 2.303.0
ARG RUNNER_VERSION=""
ARG RUNNER_ARCH="x64"
# Replace value with the latest runner-container-hooks release version
# source: https://github.com/actions/runner-container-hooks/releases
# ex: 0.3.1
ARG RUNNER_CONTAINER_HOOKS_VERSION=""

ENV DEBIAN_FRONTEND=noninteractive
ENV RUNNER_MANUALLY_TRAP_SIG=1
ENV ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT=1

RUN apt update -y && apt install curl unzip -y

RUN adduser --disabled-password --gecos "" --uid 1001 runner \
    && groupadd docker --gid 123 \
    && usermod -aG sudo runner \
    && usermod -aG docker runner \
    && echo "%sudo ALL=(ALL:ALL) NOPASSWD:ALL" > /etc/sudoers \
    && echo "Defaults env_keep += \"DEBIAN_FRONTEND\"" >> /etc/sudoers

WORKDIR /home/runner

RUN curl -f -L -o runner.tar.gz https://github.com/actions/runner/releases/download/v${RUNNER_VERSION}/actions-runner-linux-${RUNNER_ARCH}-${RUNNER_VERSION}.tar.gz \
    && tar xzf ./runner.tar.gz \
    && rm runner.tar.gz

RUN curl -f -L -o runner-container-hooks.zip https://github.com/actions/runner-container-hooks/releases/download/v${RUNNER_CONTAINER_HOOKS_VERSION}/actions-runner-hooks-k8s-${RUNNER_CONTAINER_HOOKS_VERSION}.zip \
    && unzip ./runner-container-hooks.zip -d ./k8s \
    && rm runner-container-hooks.zip

USER runner

Software instalado na imagem do ARC runner

A imagem do executor ARC é agrupada com o seguinte software:

  •         [Binários do executor](https://github.com/actions/runner)

  •         [Ganchos de contêiner do executor](https://github.com/actions/runner-container-hooks)
  • Docker (necessário para o modo Docker-in-Docker)

Para obter mais informações, confira o Dockerfile da imagem do executor do ARC no repositório de Ações.

Ativos e lançamentos

O ARC é lançado como dois gráficos do Helm e uma imagem de contêiner. Os gráficos do Helm são publicados apenas como pacotes do Open Container Initiative (OCI). O ARC não fornece tarballs ou repositórios do Helm em GitHub Pages.

Você pode encontrar as versões mais recentes dos gráficos do Helm e da imagem do contêiner do ARC em GitHub Packages:

  •         [Helm chart `gha-runner-scale-set-controller`](https://github.com/actions/actions-runner-controller/pkgs/container/actions-runner-controller-charts%2Fgha-runner-scale-set-controller).

  •         [Helm chart `gha-runner-scale-set`](https://github.com/actions/actions-runner-controller/pkgs/container/actions-runner-controller-charts%2Fgha-runner-scale-set).

  •         [Imagem do contêiner `gha-runner-scale-set-controller`](https://github.com/actions/actions-runner-controller/pkgs/container/gha-runner-scale-set-controller)

A imagem de execução compatível é disponibilizada como uma imagem de contêiner separada, que você pode encontrar em actions-runner no GitHub Packages.

Partes foram adaptadas do https://github.com/actions/actions-runner-controller/ de acordo com a licença Apache-2.0:

Copyright 2019 Moto Ishizawa

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Próximas etapas

Quando estiver pronto para usar o ARC para executar fluxos de trabalho, consulte Usar executores do Controlador do Executor de Ações em um fluxo de trabalho.

Você não pode usar rótulos adicionais para direcionar executores criados pelo ARC. Você só pode usar o nome da instalação do conjunto de dimensionamento do executor especificado durante a instalação ou definindo o valor do campo runnerScaleSetName em seu arquivo values.yaml. Estes são usados como o "rótulo único" para usar como seu destino runs-on. Consulte Usar os executores auto-hospedados em um fluxo de trabalho.

Você pode dimensionar os executores de forma estática ou dinâmica, conforme suas necessidades. Confira Como implantar conjuntos de dimensionamento de executores com o Actions Runner Controller.