GitHub AE is currently under limited release. Please contact our Sales Team to find out more.

Adding AE hosted runners

You can add an AE hosted runner to an organization or an enterprise.

In this article

Note: GitHub Actions is currently in beta for GitHub AE.

Note: To add AE hosted runners to GitHub AE, you will need to contact GitHub support. This article describes the information that support will need in order to complete this process.

AE hosted runners can use the base Azure operating system images, or you can create your own custom images.

Adding an AE hosted runner from the base Azure image

You can add AE hosted runners that use the base Azure operating system images. To add AE hosted runners to your organization or enterprise, contact GitHub support and have the following information ready:

  • Required operating system: Available options are listed at "Software specifications."
  • Choose a name for each pool of AE hosted runners. These names are created as labels, allowing you to route your workflows to these runners. For more information, see "Using AE hosted runners in a workflow."
  • Where to add the AE hosted runner: Identify the names of the organizations and enterprises that will receive the runners.

Adding an AE hosted runner with a custom image

To create a custom operating system image, see the steps at "Creating custom images".

Once you've created a custom image using the above steps, contact GitHub support and provide the following details:

  • The SAS URI you generated when following the custom image creation steps.
  • Type of operating system used by the image: This can be Linux or Windows.
  • Image name.
  • Version.
  • VM SKU for the new pool.
  • Choose a name for each pool of AE hosted runners. These names are created as labels, allowing you to route your workflows to these runners. For more information, see "Using AE hosted runners in a workflow."
  • Where to add the AE hosted runner: Identify the names of the organizations and enterprises that will receive the runners.

Reviewing your AE hosted runners

Once your runners have been added by GitHub support, you'll be able to find them in your list of runners:

  1. Navigate to where your AE hosted runner is registered:

    • In an organization or repository: navigate to the main page and click Settings.

    • If using an enterprise-level runner:

      1. In the upper-right corner of any page, click .
      2. In the left sidebar, click Enterprise overview.
      3. In the enterprise sidebar, click Policies.
  2. Navigate to the GitHub Actions settings:

    • In an organization or repository: Click Actions in the left sidebar.

      Actions setting

    • If using an enterprise-level runner: Under " Policies", click Actions.

      Actions setting

  3. Click the "Self-hosted runners" tab, and locate the list of runners.

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.