Skip to main content

Using larger runners

GitHub offers larger runners with more RAM and CPU.

O recurso de executor maiors está atualmente em versão beta para organizações e empresas usando os planos GitHub Team ou GitHub Enterprise Cloud, e está sujeito a alterações. Para solicitar acesso ao beta, visite a página de inscrição.

Overview of executor maiors

In addition to the standard GitHub-hosted runners, GitHub also offers customers on GitHub Team and GitHub Enterprise Cloud plans a range of executor maiors with more RAM and CPU. These runners are hosted by GitHub and have the runner application and other tools preinstalled.

When executor maiors are enabled for your organization, a default runner group is automatically created for you with a set of four pre-configured executor maiors.

When you add a executor maior to an organization, you are defining a type of machine from a selection of available hardware specifications and operating system images. GitHub will then create multiple instances of this runner that scale up and down to match the job demands of your organization, based on the autoscaling limits you define.

Machine specs for executor maiors

Size (vcpu)Memory (GB)Storage (SSD)
4 cores16 RAM150 GB
8 cores32 RAM300 GB
16 cores64 RAM600 GB
32 cores128 RAM1200 GB
64 cores256 RAM2040 GB

Architectural overview of executor maiors

The executor maiors are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target either the group name or the label assigned to the executor maior. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "Controlling access to executor maiors."

In the following diagram, a class of hosted runner named ubuntu-20.04-16core has been defined with customized hardware and operating system configuration.

Diagram explaining executor maior

  1. Instances of this runner are automatically created and added to a group called grp-ubuntu-20.04-16core.
  2. The runners have been assigned the label ubuntu-20.04-16core.
  3. Workflow jobs use the ubuntu-20.04-16core label in their runs-on key to indicate the type of runner they need to execute the job.
  4. GitHub Actions checks the runner group to see if your repository is authorized to send jobs to the runner.
  5. The job runs on the next available instance of the ubuntu-20.04-16core runner.

Autoscaling executor maiors

Your executor maiors can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently.

During the runner deployment process, you can configure the Max option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism.

Networking for executor maiors

By default, executor maiors receive a dynamic IP address that changes for each job run. Optionally, GitHub Enterprise Cloud customers can configure their executor maiors to receive a static IP address from GitHub's IP address pool. When enabled, instances of the executor maior will receive an address from a range that is unique to the runner, allowing you to use this range to configure a firewall allowlist. You can use up to 10 static IP address ranges in total across all your executor maiors.

Note: If runners are unused for more than 30 days, their IP address ranges are automatically removed and cannot be recovered.

Planning for executor maiors

Create a runner group

Runner groups are used to collect sets of virtual machines and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. During the executor maior deployment process, the runner can be added to an existing group, or otherwise it will join a default group. You can create a group by following the steps in "Controlling access to executor maiors."

Understanding billing

Note: The executor maiors do not use included entitlement minutes, and are not free for public repositories.

Compared to standard GitHub-hosted runners, executor maiors are billed differently. For more information, see "Per-minute rates".

Adding a executor maior to an enterprise

You can add executor maiors to an enterprise, where they can be assigned to multiple organizations. The organization admins can then control which repositories can use the runners. To add a executor maior to an enterprise, you must be an enterprise owner.

Você pode escolher um sistema operacional e uma configuração de hardware na lista de opções disponíveis. Quando novas instâncias desse executor forem implantadas por meio do dimensionamento automático, elas usarão o mesmo sistema operacional e a mesma configuração de hardware que você definiu aqui.

Você também pode definir os rótulos que identificam o executor, que é o modo como seus fluxos de trabalho poderão enviar trabalhos aos executores para processamento (usando runs-on). Novos executores são atribuídos automaticamente ao grupo padrão, ou você pode escolher em qual grupo os executores devem ingressar durante o processo de criação dos executores. Além disso, você pode modificar a associação ao grupo do executor depois de registrá-lo. Para obter mais informações, confira "Como controlar o acesso aos executor maiors".

  1. Na barra lateral da empresa, clique em Políticas. Guia Políticas na barra lateral da conta corporativa

  2. Em " Políticas", clique em Actions.

  3. Clique na guia Executores.

  4. Clique em Novo executor e clique em Novo executor hospedado no GitHub .

  5. Preencha os detalhes obrigatórios para configurar seu novo executor:

    • Nome: insira um nome para seu novo executor. Para facilitar a identificação, esse campo deve indicar o hardware e configuração operacional, como ubuntu-20.04-16core.
    • Imagem do executor: escolha um sistema operacional entre as opções disponíveis. Depois de selecionar um sistema operacional, você poderá escolher uma versão específica.
    • Tamanho do executor: escolha uma configuração de hardware na lista suspensa de opções disponíveis.
    • Dimensionamento automático: escolha o número máximo de executores que podem estar ativos a qualquer momento.
    • Grupo do executor: escolha o grupo do qual seu executor será membro. Esse grupo hospedará várias instâncias do seu executor, à medida que elas escalarem verticalmente para atender à demanda.
    • Rede: somente para dados GitHub Enterprise Cloud: escolha se um intervalo de endereços IP estáticos será atribuído a instâncias de executor maior. Você pode usar até 10 endereços IP estáticos no total.
  6. Clique em Criar executor.

  7. To allow organizations to access your executor maiors, you specify the list of organizations that can use it. For more information, see "Managing access to your runners."

Adding a executor maior to an organization

You can add a executor maior to an organization, where the organization admins can control which repositories can use it.

Você pode escolher um sistema operacional e uma configuração de hardware na lista de opções disponíveis. Quando novas instâncias desse executor forem implantadas por meio do dimensionamento automático, elas usarão o mesmo sistema operacional e a mesma configuração de hardware que você definiu aqui.

Você também pode definir os rótulos que identificam o executor, que é o modo como seus fluxos de trabalho poderão enviar trabalhos aos executores para processamento (usando runs-on). Novos executores são atribuídos automaticamente ao grupo padrão, ou você pode escolher em qual grupo os executores devem ingressar durante o processo de criação dos executores. Além disso, você pode modificar a associação ao grupo do executor depois de registrá-lo. Para obter mais informações, confira "Como controlar o acesso aos executor maiors".

  1. On GitHub.com, navigate to the main page of the organization.

  2. No nome da sua organização, clique em Configurações. Botão Configurações da organização

  3. In the left sidebar, click Actions, then click Runners.

  4. Clique em Novo executor e clique em Novo executor hospedado no GitHub .

  5. Preencha os detalhes obrigatórios para configurar seu novo executor:

    • Nome: insira um nome para seu novo executor. Para facilitar a identificação, esse campo deve indicar o hardware e configuração operacional, como ubuntu-20.04-16core.
    • Imagem do executor: escolha um sistema operacional entre as opções disponíveis. Depois de selecionar um sistema operacional, você poderá escolher uma versão específica.
    • Tamanho do executor: escolha uma configuração de hardware na lista suspensa de opções disponíveis.
    • Dimensionamento automático: escolha o número máximo de executores que podem estar ativos a qualquer momento.
    • Grupo do executor: escolha o grupo do qual seu executor será membro. Esse grupo hospedará várias instâncias do seu executor, à medida que elas escalarem verticalmente para atender à demanda.
    • Rede: somente para dados GitHub Enterprise Cloud: escolha se um intervalo de endereços IP estáticos será atribuído a instâncias de executor maior. Você pode usar até 10 endereços IP estáticos no total.
  6. Clique em Criar executor.

  7. To allow repositories to access your executor maiors, add them to the list of repositories that can use it. For more information, see "Managing access to your runners."

Running jobs on your runner

Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. You can use runner groups or labels to define where your jobs run.

Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization administrator to find out which runners are enabled. Your organization administrator can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group.

Using groups to control where jobs are run

Neste exemplo, os executores de 16 núcleos do Ubuntu foram adicionados a um grupo chamado ubuntu-runners. A chave runs-on envia o trabalho para qualquer executor disponível no grupo ubuntu-runners:

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on: 
      group: ubuntu-runners
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

Using labels to control where jobs are run

In this example, a runner group is populated with Ubuntu 16-core runners, which have also been assigned the label ubuntu-20.04-16core. The runs-on key sends the job to any available runner with a matching label:

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on:
      labels: ubuntu-20.04-16core
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

Using labels and groups to control where jobs are run

Quando você combina grupos e rótulos, o executor deve atender aos dois requisitos para ser qualificado para executar o trabalho.

Neste exemplo, um grupo de executores chamado ubuntu-runners é preenchido com executores Ubuntu de 16 núcleos, que também receberam o rótulo ubuntu-20.04-16core. A chave runs-on combina group e labels para que o trabalho seja roteado para qualquer executor disponível dentro do grupo que também tenha um rótulo correspondente:

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on:
      group: ubuntu-runners
      labels: ubuntu-20.04-16core
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

Using multiple labels

You can specify multiple labels that need to be matched for a job to run on a runner. A runner will need to match all labels to be eligible to run the job.

In this example, a runner will need to match all three of the labels to run the job:

name: learn-github-actions
on: [push]
jobs:
  check-bats-version:
    runs-on:
      labels: [ ubuntu-20.04-16core, gpu, qa ]
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

Managing access to your runners

Note: Before your workflows can send jobs to executor maiors, you must first configure permissions for the runner group. See the following sections for more information.

Runner groups are used to control which repositories can run jobs on your executor maiors. You must grant access to the group from each level of the management hierarchy, depending on where you've defined the executor maior:

  • Runners at the enterprise level: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access.
  • Runners at the organization level: Configure the runner group by specifying which repositories are allowed access.

For example, the following diagram has a runner group named grp-ubuntu-20.04-16core at the enterprise level. Before the repository named octo-repo can use the runners in the group, you must first configure the group at the enterprise level to allow access from the octo-org organization; you must then configure the group at the organization level to allow access from octo-repo:

Diagram explaining executor maior groups

Allowing repositories to access a runner group

This procedure demonstrates how to configure group permissions at the enterprise and organization levels:

  1. Navigate to the main page of the repository or organization where your runner groups are located.

  2. Click Settings.

  3. In the left sidebar, click Actions, then click Runner groups.

  4. Na lista de grupos, clique no grupo de executores que deseja configurar.

  • For runner groups in an enterprise: under Organization access, modify which organizations can access the runner group.
  • For runner groups in an organization: under Repository access, modify which repositories can access the runner group.

Warning:

If you are using a Fixed IP range, we recommend that you only use executor maiors with private repositories. Forks of your repository can potentially run dangerous code on your executor maior by creating a pull request that executes the code in a workflow.

For more information, see "Controlling access to executor maiors."