Skip to main content

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 can configure policies for GitHub Actions and add self-hosted runners to the enterprise.

Sobre os executores auto-hospedados do GitHub Actions

O GitHub Actions permite que os membros da 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. Você pode hospedar seu próprio computador de executor para executar esses trabalhos e 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 Cloud usando o aplicativo do executor auto-hospedado de GitHub Actions. Todos auto-hospedados podem ser executados no Linux, Windows ou macOS. Para obter mais informações, confira "Sobre executores auto-hospedados".

Como alternativa, você pode usar máquinas de executores que GitHub hospeda. Os executores hospedados em GitHub estão fora do escopo deste guia. Para obter mais informações, confira "Usar executores hospedados no GitHub".

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 e os fluxos de trabalho reutilizáveis 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 obter mais informações, consulte "Sobe o Controlador de Executores de Ação".

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

Depois que você terminar o guia, os membros da sua empresa poderão executar tarefas do fluxo de trabalho do GitHub Actions no computador de um executor auto-hospedado.

Pré-requisitos

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 e os fluxos de trabalho reutilizáveis que têm permissão de execução na sua empresa no GitHub Enterprise Cloud. Opcionalmente, os proprietários da organização podem restringir ainda mais essas políticas para cada organização.

  1. No canto superior direito do GitHub.com, clique na foto do seu perfil e em Suas empresas.

  2. Na lista de empresas, clique na empresa que você deseja visualizar.

  3. Na barra lateral da empresa, clique em Políticas.

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

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

  6. Para habilitar ações locais e fluxos de trabalho reutilizáveis e ações criadas pelo GitHub, selecione Permitir a empresa e fluxos de trabalho reutilizáveis e ações selecionados que não são empresa e Permitir ações criadas pelo GitHub .

  7. Clique em Save (Salvar).

Você pode configurar políticas adicionais para restringir as ações disponíveis para os membros da empresa. Para obter mais informações, 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 Cloud 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 a sua empresa.

Adicionando o executor auto-hospedado

  1. No canto superior direito do GitHub.com, clique na foto do seu perfil e em Suas empresas.

  2. Na lista de empresas, clique na empresa que você deseja visualizar.

  3. Na barra lateral da empresa, clique em Políticas.

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

  5. Clique na guia Executores.

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

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

  7. 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, 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.
      • 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".

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

  1. No canto superior direito do GitHub.com, clique na foto do seu perfil e em Suas empresas.

  2. Na lista de empresas, clique na empresa que você deseja visualizar.

  3. Na barra lateral da empresa, clique em Políticas.

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

  5. Clique na guia Grupos de executores.

  6. Clique em Novo grupo de executores.

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

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

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

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

  11. 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 obter mais informações, confira "Sobre executores auto-hospedados".

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

  13. Clique na aba "Executores".

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

  15. Clique em Editar.

  16. Clique em Grupos de executores .

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

  18. 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 podem restringir ainda mais a política de acesso do grupo p executor 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 obter mais informações, confira "Gerenciar o acesso a executores auto-hospedados usando grupos".

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

  • Você pode monitorar executores auto-hospedados e resolver problemas comuns. Para obter mais informações, confira "Monitorar e solucionar problemas de executores auto-hospedados".

  • GitHub recomenda que você revise considerações de segurança para máquinas de executores auto-hospedados. Para obter mais informações, confira "Fortalecimento de segurança para o GitHub Actions".

  • Caso use o GitHub Enterprise Server, você poderá sincronizar manualmente os repositórios em GitHub.com que contêm ações para a sua empresa em GitHub Enterprise Server. Como alternativa, você pode permitir que os integrantes da sua empresa acessem automaticamente as ações de GitHub.com usando GitHub Connect. Para obter mais informações, consulte o seguinte.

  • Você pode personalizar o software disponível nas suas máquinas de executores auto-hospedados ou configurar seus executores para executar softwares similares a executores hospedados em GitHub. O software que alimenta máquinas de executores para GitHub Actions é de código aberto. Para obter mais informações, confira os repositórios actions/runner e actions/runner-images.

Leitura adicional