Primeiros passos vom executores auto-hospedados da sua empresa

Você pode configurar a máquina de um exeucutor para sua empresa para que seus desenvolvedores possam começar a automatizar fluxos de trabalho com GitHub Actions.

Quem pode usar esse recurso?

Enterprise owners and users with permissions can configure policies for GitHub Actions and add self-hosted runners to the enterprise.

Neste artigo

Sobre os executores auto-hospedados do 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, confira Sobre o GitHub Actions para empresas.

Com GitHub Actions, os desenvolvedores podem escrever e combinar tarefas individuais denominadas ações para criar fluxos de trabalho personalizados. Para habilitar GitHub Actions para sua instância do GitHub Enterprise Server, hospede pelo menos um computador para executar trabalhos. Esse computador será chamado de executor auto-hospedado. Os executores auto-hospedados podem ser físicos, virtuais, em um contêiner, no local ou em uma nuvem. A sua máquina do executor conecta-se ao GitHub Enterprise Server usando o aplicativo do executor auto-hospedado de GitHub Actions. os executores auto-hospedados podem ser executados no Linux, Windows ou macOS. Para saber mais, confira Sobre executores auto-hospedados.

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

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

Você também encontrará informações adicionais sobre como monitorar e proteger seus executores auto-hospedados, como acessar ações de GitHub.com e como personalizar o software nas máquinas dos seus executores.

Depois que você terminar o guia, usuários de sua instância do GitHub Enterprise Server poderão executar tarefas do fluxo de trabalho do GitHub Actions no computador de um executor auto-hospedado.

Pré-requisitos

  • O GitHub Actions precisa ser habilitado para o GitHub Enterprise Server. Um administrador de site pode habilitar e configurar o GitHub Actions para sua instância. Para obter mais informações, confira "Primeiros passos com o GitHub Actions para o GitHub Enterprise Server".

  • Você precisa ter acesso ao computador que usará como um executor auto-hospedado no seu ambiente.

  • A conexão entre os executores auto-hospedados e o GitHub Enterprise Server é feita por HTTP (porta 80) ou HTTPS (porta 443). Para garantir a conectividade por HTTPS, configure o TLS para o GitHub Enterprise Server. Para obter mais informações, confira "Configurar o TLS".

1. Configurar políticas para o GitHub Actions

Primeiro, habilite o GitHub Actions para todas as organizações e configure uma política para restringir as ações que têm permissão de execução em sua instância do GitHub Enterprise Server. Opcionalmente, os proprietários da organização podem restringir ainda mais essas políticas para cada organização.

  1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  2. Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Políticas.

  3. Em " Políticas", clique em Ações.

  4. Em "Políticas", selecione Habilitar para todas as organizações.

  5. Para habilitar ações locais e ações criadas pelo GitHub, selecione Permitir ações selecionadas e Permitir ações criadas pelo GitHub .

  6. Clique em Save (Salvar).

Você pode configurar políticas adicionais para restringir as ações disponíveis para os usuários de sua instância do GitHub Enterprise Server. Para saber mais, confira Aplicando políticas para o GitHub Actions na sua empresa.

2. Implantar o executor auto-hospedado para sua empresa

Em seguida, adicione um executor auto-hospedado à sua empresa. O GitHub Enterprise Server irá guiar você pela instalação do software necessário na máquina do executor. Depois de implantar o executor, você poderá verificar a conectividade entre o computador do executor e sua instância do GitHub Enterprise Server.

Adicionando o executor auto-hospedado

  1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  2. Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Políticas.

  3. Em " Políticas", clique em Ações.

  4. Clique na guia Executores.

  5. Clique em Novo executor. 1. Selecione a imagem e a arquitetura do sistema operacional do computador do executor auto-hospedado.

    Captura de tela da escolha do sistema operacional e da arquitetura. Essas opções são realçadas com um contorno laranja escuro.

  6. 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.

    Note

    No Windows, caso você deseje instalar o aplicativo do executor auto-hospedado como um serviço, abra um shell 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 do executor auto-hospedado e registrá-lo no 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 obter mais informações, confira "Configurar o aplicativo do executor auto-hospedado como um serviço".
    • Executando o aplicativo do executor auto-hospedado para conectar a máquina ao 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 auto-hospedados".

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

√ 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 Enterprise Server adiciona todos os novos executores a um grupo. Os executores podem estar em um grupo por vez. Por padrão, o GitHub Enterprise Server adiciona novos executores ao grupo "padrão".

  1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  2. Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Políticas.

  3. Em " Políticas", clique em Ações.

  4. Clique na guia Grupos de executores.

  5. Clique em Novo grupo de executores.

  6. Em "Nome do grupo", digite um nome para o grupo de executores.

  7. 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.

  8. À direita da lista suspensa com a política de acesso da organização, clique em .

  9. Selecione as organizações que você gostaria de conceder acesso ao grupo do executor.

  10. Opcionalmente, para permitir que repositórios públicos nas organizações selecionadas usem executores no grupo, selecione Permitir repositórios públicos.

    Warning

    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 Sobre executores auto-hospedados.

  11. Clique em Criar grupo para criar o grupo e aplicar a política.

  12. Clique na aba "Executores".

  13. Na lista de executores, clique no executor que você implantou na seção anterior.

  14. Clique em Editar.

  15. Clique em Grupos de executores .

  16. Na lista de grupos de executores, clique no nome do grupo que você criou anteriormente.

  17. Clique em Salvar para mover o executor para o grupo.

Você já implantou um executor auto-hospedado que pode executar trabalhos de GitHub Actions dentro das organizações que você especificou.

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 e conjuntos de executores da organização" 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, confira Sobre as funções da organização personalizadas.

5. Escalar automaticamente os executores auto-hospedados

Como opção, é possível usar o Actions Runner Controller (ARC) para dimensionar automaticamente os executores auto-hospedados. 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 "Redimensionamento automático com executores auto-hospedados".

Próximas etapas

Leitura adicional