Sobre executores auto-hospedados para GitHub Actions
GitHub Actions permite que pessoas que utilizam your GitHub Enterprise Server instance 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 denominadas ações para criar fluxos de trabalho personalizados. Para habilitar GitHub Actions para your GitHub Enterprise Server instance, você deverá hospedar pelo menos uma máquina para executar trabalhos. Esta máquina é denominada um executor auto-hospedado. Os executores auto-hospedados podem ser físicos, virtuais, estar em um container, 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 obter mais informações, consulte "Sobre os 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.
- Configure uma política limitada para restringir as ações reutilizáveis que podem ser executados dentro da 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
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 de terminar o guia, usuários de your GitHub Enterprise Server instance poderão executar trabalhos do fluxo de trabalho de GitHub Actions na máquina de um executor auto-hospedado.
Pré-requisitos
-
GitHub Actions deve ser habilitado para GitHub Enterprise Server. Um administrador do site pode habilitar e configurar GitHub Actions na sua instância. Para obter mais informações, consulte "Primeiros passos com GitHub Actions for GitHub Enterprise Server".
-
Você precisa ter acesso � máquina que você usará como um executor auto-hospedado em seu ambiente.
-
A conexão entre runners auto-hospedados e GitHub Enterprise Server é por meio de HTTP (porta 80) ou HTTPS (porta 443). Para garantir conectividade por meio de HTTPS, configure TLS para your GitHub Enterprise Server instance. Para obter mais informações, consulte "Configurando TLS". Para obter mais informações, consulte "Sobre executores auto-hospedados."
-
Sua empresa deve possuir pelo menos uma organização. Para obter mais informações, consulte "Sobre as organizações" eCriando uma nova organização do zero".
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 que podem executar em your GitHub Enterprise Server instance. Opcionalmente, os proprietários da organização podem restringir ainda mais essas políticas para cada organização.
-
No canto superior direito de GitHub Enterprise Server, clique na sua foto de perfil e, em seguida, clique em Configurações da empresa.
-
Na barra lateral da conta corporativa, clique em Policies.
-
Em " Policies (Políticas)", clique em Actions (Ações).
-
Em "Políticas", selecione Habilitar para todas as organizações.
-
Selecione Allow select actions e Permitir ações criadas pelo GitHub para permitir ações locais, e ações criadas por GitHub.
-
Clique em Salvar.
Você pode configurar políticas adicionais para restringir as ações disponíveis para os usuários de your GitHub Enterprise Server instance. Para obter mais informações, consulte "Aplicar políticas para GitHub Actions na sua empresa".
2. Implantar o executor auto-hospedado para a 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. Após implantar o executor, você poderá verificar a conectividade entre a máquina do executor e your GitHub Enterprise Server instance.
Adicionando o executor auto-hospedado
Para adicionar um executor auto-hospedado a uma empresa, você deve ser um proprietário corporativo.
-
No canto superior direito de GitHub Enterprise Server, clique na sua foto de perfil e, em seguida, clique em Configurações da empresa.
-
Na barra lateral da conta corporativa, clique em Policies.
-
Em " Policies (Políticas)", clique em Actions (Ações).
-
Clique na aba Executores auto-hospedados .
-
Clique em Adicionar novo e depois clique em Novo executor.
-
Select the operating system image and architecture of your self-hosted runner machine.
-
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.
Nota: No Windows, se você quiser instalar a aplicação de executor auto-hospedada como um serviço, você deve abrir um shell com privilégios de administrador. Também recomendamos que você use
C:\actions-runner
como diretório para o aplicativo runner auto-hospedado para que as contas de sistema 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.
- Executando o script
config
para configurar a aplicação de executor auto-hospedada e registrá-lo no GitHub Actions. O scriptconfig
requer 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ê gostaria de instalar o aplicativo de execução 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, consulte "Configuring the self-hosted runner application as a service."
- No Windows, o script
- 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
Depois de completar as etapas para adicionar um executor auto-hospedado, o executor e seu status serã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 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".
-
No canto superior direito de GitHub Enterprise Server, clique na sua foto de perfil e, em seguida, clique em Configurações da empresa.
-
Na barra lateral da conta corporativa, clique em Policies.
-
Em " Policies (Políticas)", clique em Actions (Ações).
-
Clique na aba Executores auto-hospedados .
-
Use o menu suspenso Adicionar novo e selecione Novo grupo.
-
Em "Nome do Grupo, digite um nome para o grupo do seu executor.
-
Para escolher uma política para o acesso da organização, em "Acesso da organização", selecione a lista suspensa Organização e clique Organizações selecionadas.
-
À direita da lista suspensa com a política de acesso da organização, clique em .
-
Selecione as organizações que você gostaria de conceder acesso ao grupo do executor.
-
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 podem potencialmente executar código perigoso na sua máquina de executor auto-hospedada criando um pull request que executa o código em um fluxo de trabalho.
Para obter mais informações, consulte "Sobre os executores auto-hospedados."
-
Clique em Salvar grupo para criar o grupo e aplicar a política.
-
À direita do "Padrão", clique no número de executores no grupo para mostrar os executores.
-
Selecione o executor que você implantou.
-
À direita de "Grupos de executores", selecione a lista suspensa Mover para o grupo e clique no grupo que você criou anteriormente.
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, consulte "Gerenciando acesso a runners auto-hospedados usando grupos".
Próximas etapas
-
Você pode monitorar executores auto-hospedados e resolver problemas comuns. Para obter mais informações, consulte "Monitoring and troubleshooting self-hosted runners."
-
GitHub recomenda que você revise considerações de segurança para máquinas de executores auto-hospedados. Para obter mais informações, consulte "Fortalecimento da segurança para GitHub Actions".
-
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 disponíveis para os clientes que usam GitHub.com. O software que alimenta máquinas de executores para GitHub Actions é de código aberto. Para obter mais informações, consulte
ações/runner
e reposit[orios deações/ambientes virtuais
.