Primeiros passos com executores auto-hospedados da sua empresa

Sobre corredores auto-hospedados para GitHub Actions

O GitHub Actions permite que os usuários ba sua empresa melhorem a produtividade automatizando todas as fases do fluxo de trabalho de desenvolvimento de software. Para obter mais informações, consulte Sobre GitHub Actions para empresas.

Com GitHub Actions, os desenvolvedores podem escrever e combinar tarefas individuais chamadas ações para criar fluxos de trabalho personalizados.

Você pode hospedar seu próprio computador executor para executar trabalhos e esse computador é chamado de executor auto-hospedado. Seu computador executor conecta-se ao GitHub usando o aplicativo de executor auto-hospedado de GitHub Actions. Todos os podem executar Linux, Windows ou macOS. Para saber mais, confira Executores auto-hospedados.

Como alternativa, você pode usar máquinas runner hospedadas por GitHub. GitHub-runners hospedados estão fora do escopo deste guia. Para saber mais, confira Executores hospedados no GitHub.

Este guia mostra como aplicar uma abordagem centralizada de gerenciamento a executores hospedados por você para GitHub Actions na sua empresa. No guia, você realizará as seguintes tarefas.

Configurar uma política limitada para restringir as ações e fluxos de trabalho reutilizáveis que podem ser executados em sua empresa
Implantar um executor auto-hospedado para a sua empresa
Criar um grupo para gerenciar o acesso aos executores disponíveis para sua empresa
Opcionalmente, restringir ainda mais os repositórios que podem usar o executor
Opcionalmente, para criar e dimensionar automaticamente os executores auto-hospedados, use Actions Runner Controller (ARC). Para saber mais, confira Controlador de Ações Runner.

Você também encontrará informações adicionais sobre como monitorar e proteger seus runners auto-hospedados, e como personalizar o software nas suas máquinas de runner.

Depois de concluir o guia, os membros de seus usuários corporativos poderão executar trabalhos de fluxo de trabalho em GitHub Actions um computador executor auto-hospedado.

Pré-requisitos

Você precisa ter acesso à máquina que você usará como runner auto-hospedado no seu ambiente.
Sua empresa deve possuir pelo menos uma organização. Para saber mais, confira Sobre organizações e Criar uma organização do início.

1. Configurar políticas para GitHub Actions

Primeiro, habilite GitHub Actions para todas as organizações e configure uma política para restringir as ações e os fluxos de trabalho reutilizáveis que podem ser executadosem sua empresa. Opcionalmente, os proprietários da organização podem restringir ainda mais essas políticas para cada organização.

Navegue até sua empresa. Por exemplo, na página Enterprises em GitHub.com.
Na parte superior da página, clique em Políticas.
Em " Policies", clique em Actions.
Em "Políticas", selecione Habilitar para todas as organizações.
Para habilitar ações locais e fluxos de trabalho reutilizáveis e ações criadas por GitHub, selecione Permitir a empresa e fluxos de trabalho reutilizáveis e ações selecionados que não são empresae, em seguida, selecione Permitir ações criadas por GitHub.
Clique em Salvar.

Você pode configurar políticas adicionais para restringir as ações disponíveis para usuários membros Para saber mais, confira Impor políticas para GitHub Actions em sua empresa.

2. Implantar o executor auto-hospedado para sua empresa

Em seguida, adicione um executor auto-hospedado à sua empresa. GitHub vai orientar você na instalação do software necessário na máquina runner. Depois de implantar o executor, você pode verificar a conectividade entre o computador executor e sua empresa.

Adicionando o executor auto-hospedado

Navegue até sua empresa. Por exemplo, na página Enterprises em GitHub.com.
Na parte superior da página, clique em Políticas.
Em " Policies", clique em Actions.
Clique na guia Executores.
Clique em Novo executor, depois em Novo executor auto-hospedado. 1. Selecione a imagem e a arquitetura do sistema operacional do computador do executor auto-hospedado.
Você verá instruções mostrando como baixar o executor e instalá-lo em sua máquina de executor auto-hospedada.

Abra um shell em sua máquina de executor auto-hospedado e execute cada comando shell na ordem mostrada.

Observação

No Windows, se você quiser instalar o aplicativo do runner auto-hospedado como um serviço, é necessário abrir um terminal com privilégios de administrador. Também recomendamos que você use C:\actions-runner como diretório para o aplicativo do executor auto-hospedado para que as contas do sistema do Windows possam acessar o diretório do executor.

As instruções te ajudam a completar estas tarefas:
- Transferindo e extraindo o aplicativo do executor auto-hospedado.
- Executar o script config para configurar o aplicativo executor auto-hospedado e registrá-lo com GitHub Actions. O script config exige a URL de destino e um token de tempo limitado gerado automaticamente para autenticar a solicitação. O token expira após uma hora.
  - No Windows, o script config também pergunta se você deseja instalar o aplicativo do executor auto-hospedado como um serviço. Para Linux e macOS, você pode instalar um serviço depois de terminar de adicionar o executor. Para saber mais, confira Configurar o aplicativo do executor auto-hospedado como um serviço.
- Executar o aplicativo executor auto-hospedado para conectar o computador a GitHub Actions.

Verificando se o seu executor auto-hospedado foi adicionado com sucesso

Após concluir as etapas para adicionar um executor auto-hospedado, o executor e seu status agora estão listados em "Executores".

A aplicação dos executores auto-hospedados deve estar activa para que o executor aceite os trabalhos. Quando o aplicativo do executor estiver conectado ao GitHub e pronto para receber trabalhos, você verá a seguinte mensagem no terminal do computador.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

3. Gerenciar o acesso ao executor auto-hospedado usando um grupo

Você pode criar um grupo de executor para gerenciar o acesso ao executor que você adicionou à sua empresa. Você usará o grupo para escolher quais organizações podem executar trabalhos a partir de GitHub Actions no executor.

GitHub adiciona todos os novos corredores a um grupo. Os corredores podem estar em um grupo por vez. Por padrão, GitHub adiciona novos runners ao grupo "Default".

Navegue até sua empresa. Por exemplo, na página Enterprises em GitHub.com.
Na parte superior da página, clique em Políticas.
Em " Policies", clique em Actions.
Clique na guia Grupos de executores.
Clique em Novo grupo de executores.
Em "Nome do grupo", digite um nome para o grupo de executores.
Para escolher uma política de acesso à organização, em "Acesso à organização", selecione o menu suspenso Acesso à organização e clique em Organizações selecionadas.
À direita da lista suspensa com a política de acesso da organização, clique em .
Selecione as organizações às quais você gostaria de conceder acesso ao grupo de runners.
Opcionalmente, para permitir que repositórios públicos nas organizações selecionadas usem executores no grupo, selecione Permitir repositórios públicos.

Aviso

Recomendamos que você use apenas executores auto-hospedados com repositórios privados. Isso acontece porque as bifurcações do seu repositório público podem executar código perigoso em seu computador de executor auto-hospedado criando uma solicitação de pull que executa o código em um fluxo de trabalho.

Para saber mais, confira Referência de uso seguro.
Clique em Criar grupo para criar o grupo e aplicar a política.
Clique na aba "Executores".
Na lista de executores, clique no executor que você implantou na seção anterior.
Clique em Editar.
Clique em grupos de executores .
Na lista de grupos de runners, clique no nome do grupo que você criou anteriormente.
Clique em Salvar para mover o executor para o grupo.

Agora você implantou um executor auto-hospedado que pode executar trabalhos de GitHub Actions dentro das organizações especificadas.

4. Restringir ainda mais o acesso ao executor auto-hospedado

Opcionalmente, os proprietários da organização e os usuários com a permissão "Gerenciar executores da organização e grupos de executores" também podem restringir ainda mais a política de acesso do grupo de executores que você criou. Por exemplo, um proprietário da organização pode permitir que apenas certos repositórios na organização usem o grupo de executores.

Para saber mais, confira Gerenciar o acesso a executores auto-hospedados usando grupos.

Para obter mais informações sobre funções de organização personalizadas, consulte Permissões de funções de organização personalizadas.

5. Escalar automaticamente os executores auto-hospedados

Opcionalmente, você pode usar Actions Runner Controller (ARC) para dimensionar automaticamente os executores auto-hospedados. Actions Runner Controller (ARC) é um operador de Kubernetes que orquestra e dimensiona executores auto-hospedados para 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, consulte Referência de executores auto-hospedados.

Próximas etapas

Você pode monitorar executores auto-hospedados e resolver problemas comuns. Para saber mais, confira Monitorar e solucionar problemas de executores auto-hospedados.
GitHub recomenda que você examine as considerações de segurança para computadores executores auto-hospedados. Para saber mais, confira Referência de uso seguro.
Se você usar GitHub Enterprise Server, você pode sincronizar manualmente repositórios no GitHub.com que contêm ações na sua empresa no GitHub Enterprise Server. Como alternativa, você pode permitir que os membros da sua empresa acessem automaticamente as ações GitHub.com usando GitHub Connect. Para obter mais informações, consulte o seguinte.
- Sincronizar ações manualmente de GitHub.com na GitHub Enterprise Server documentação
- Habilitar o acesso automático a ações de GitHub.com usando GitHub Connect na GitHub Enterprise Server documentação
Você pode personalizar o software disponível em seus computadores executores auto-hospedados ou configurar seus executores para executar software semelhante a executores hospedadosGitHub disponíveis para clientes que usam O software que alimenta as máquinas runner para GitHub Actions é de código aberto. Para obter mais informações, confira os repositórios actions/runner e actions/runner-images.