Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/actions/concepts/runners/about-runner-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: About runner groups
shortTitle: Runner groups
intro: 'Learn about what a runner group is, and how to use them to control access to runners at the organization{% ifversion ghec or ghes %} and/or enterprise levels{% else %} level.{% endif %}'
versions:
fpt: '*'
ghec: '*'
ghes: '*'
type: overview
---

## About runner groups

{% data reusables.actions.about-runner-groups %}

## Next steps

{% ifversion fpt or ghec %}To learn how to use runner groups to control access to larger runners, see [AUTOTITLE](/actions/how-tos/using-larger-runners/controlling-access-to-larger-runners).{% endif %}

For information on how to route jobs to runners in a specific group, see [AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job#choosing-runners-in-a-group).
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can use self-hosted runners anywhere in the management hierarchy. Repository
{% ifversion ghec or ghes %}
To get hands-on experience with the policies and usage of self-hosted runners, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise)
{% else %}
To set up a self-hosted runner in your workspace, see [AUTOTITLE](/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners).
To set up a self-hosted runner in your workspace, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners/adding-self-hosted-runners).
{% endif %}

To find information about the requirements and supported software and hardware for self-hosted runners, see [AUTOTITLE](/actions/reference/self-hosted-runners-reference).
3 changes: 2 additions & 1 deletion content/actions/concepts/runners/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ versions:
children:
- /about-github-hosted-runners
- /about-larger-runners
- /about-private-networking-with-github-hosted-runners
- /about-self-hosted-runners
- /about-private-networking-with-github-hosted-runners
- /about-runner-groups
- /about-runner-scale-sets
- /about-actions-runner-controller
- /about-support-for-actions-runner-controller
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ A **runner** is a server that runs your workflows when they're triggered. Each r
If you need a different operating system or require a specific hardware configuration, you can host your own runners.
{% endif %}

For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see [AUTOTITLE](/actions/hosting-your-own-runners).
For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners).

## Next steps

Expand Down
23 changes: 0 additions & 23 deletions content/actions/how-tos/hosting-your-own-runners/index.md

This file was deleted.

3 changes: 2 additions & 1 deletion content/actions/how-tos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ children:
- /managing-workflow-runs-and-deployments
- /sharing-automations
- /using-github-hosted-runners
- /managing-self-hosted-runners
- /using-larger-runners
- /hosting-your-own-runners
- /security-for-github-actions
- /use-cases-and-examples
- /administering-github-actions
Expand All @@ -22,5 +22,6 @@ children:
redirect_from:
- /actions/how-tos/monitoring-and-troubleshooting-workflows
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners
---

Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
---
title: Adding self-hosted runners
shortTitle: Add runners
intro: 'You can add a self-hosted runner to a repository, an organization, or an enterprise.'
redirect_from:
- /github/automating-your-workflow-with-github-actions/adding-self-hosted-runners
- /actions/automating-your-workflow-with-github-actions/adding-self-hosted-runners
- /actions/hosting-your-own-runners/adding-self-hosted-runners
- /actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: Add self-hosted runners
---

> [!WARNING]
> {% data reusables.actions.self-hosted-runner-security %}
>
> For more information, see [AUTOTITLE](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions).

{% data reusables.actions.enterprise-github-hosted-runners %}

## Prerequisites

Before you add a self-hosted runner, you should understand what they are and how they work. See [AUTOTITLE](/actions/concepts/runners/about-self-hosted-runners).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Configuring the self-hosted runner application as a service
shortTitle: Run the runner app as a service
shortTitle: Configure the application
intro: You can configure the self-hosted runner application as a service to automatically start the runner application when the machine starts.
redirect_from:
- /actions/automating-your-workflow-with-github-actions/configuring-the-self-hosted-runner-application-as-a-service
- /actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service
- /actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
defaultPlatform: linux
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: Customizing the containers used by jobs
shortTitle: Customize containers
intro: You can customize how your self-hosted runner invokes a container for a job.
redirect_from:
- /actions/hosting-your-own-runners/customizing-the-containers-used-by-jobs
- /actions/hosting-your-own-runners/managing-self-hosted-runners/customizing-the-containers-used-by-jobs
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/customizing-the-containers-used-by-jobs
versions:
feature: container-hooks
type: reference
shortTitle: Customize containers used by jobs
---

> [!NOTE]
> This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.

{% data reusables.actions.enterprise-github-hosted-runners %}

## About container customization

{% data variables.product.prodname_actions %} allows you to run a job within a container, using the `container:` statement in your workflow file. For more information, see [AUTOTITLE](/actions/using-jobs/running-jobs-in-a-container). To process container-based jobs, the self-hosted runner creates a container for each job.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ children:
- /removing-self-hosted-runners
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
---
title: Managing access to self-hosted runners using groups
shortTitle: Manage access with runner groups
shortTitle: Manage access
intro: You can use policies to limit access to self-hosted runners that have been added to an organization{% ifversion ghec or ghes %} or enterprise{% endif %}.
permissions: 'Enterprise accounts, organizations owned by enterprise accounts, and organizations using {% data variables.product.prodname_team %} or {% data variables.product.prodname_free_user %} plans can create and manage additional runner groups using self-hosted runners.<br><br>{% ifversion custom-org-roles %}Users with the "Manage organization runners and runner groups" permission can manage runner groups at the organization level.{% endif %}'
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners
- /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners
- /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups
- /actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## About runner groups

{% data reusables.actions.about-runner-groups %}

## Creating a self-hosted runner group for an organization

{% data reusables.actions.self-hosted-runner-security-admonition %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: Monitoring and troubleshooting self-hosted runners
shortTitle: Monitor and troubleshoot
intro: You can monitor your self-hosted runners to view their activity and diagnose common issues.
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners/checking-the-status-of-self-hosted-runners
- /github/automating-your-workflow-with-github-actions/checking-the-status-of-self-hosted-runners
- /actions/automating-your-workflow-with-github-actions/checking-the-status-of-self-hosted-runners
- /actions/hosting-your-own-runners/checking-the-status-of-self-hosted-runners
- /actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
defaultPlatform: linux
shortTitle: Monitor & troubleshoot
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Removing self-hosted runners
shortTitle: Remove runners
intro: 'You can permanently remove a self-hosted runner from a repository{% ifversion fpt %} or organization{% elsif ghec or ghes %}, an organization, or an enterprise{% endif %}.'
redirect_from:
- /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners
- /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners
- /actions/hosting-your-own-runners/removing-self-hosted-runners
- /actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
shortTitle: Remove self-hosted runners
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
---
title: Running scripts before or after a job
shortTitle: Run scripts
intro: 'Scripts can automatically execute on a self-hosted runner, directly before or after a job.'
redirect_from:
- /actions/hosting-your-own-runners/running-scripts-before-or-after-a-job
- /actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
shortTitle: Run a script before or after a job
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## About pre- and post-job scripts

You can automatically execute scripts on a self-hosted runner, either before a job runs, or after a job finishes running. You could use these scripts to support the job's requirements, such as building or tearing down a runner environment, or cleaning out directories. You could also use these scripts to track telemetry of how your runners are used.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Using a proxy server with self-hosted runners
shortTitle: Use proxy servers
intro: 'You can configure self-hosted runners to use a proxy server to communicate with {% data variables.product.github %}.'
redirect_from:
- /actions/automating-your-workflow-with-github-actions/using-a-proxy-server-with-self-hosted-runners
- /actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners
- /actions/hosting-your-own-runners/managing-self-hosted-runners/using-a-proxy-server-with-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/using-a-proxy-server-with-self-hosted-runners
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
shortTitle: Proxy servers
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Using labels with self-hosted runners
shortTitle: Apply labels
intro: You can use labels to organize your self-hosted runners based on their characteristics.
redirect_from:
- /actions/hosting-your-own-runners/using-labels-with-self-hosted-runners
- /actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
shortTitle: Label runners
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
---
title: Using self-hosted runners in a workflow
shortTitle: Use in a workflow
intro: 'To use self-hosted runners in a workflow, you can use labels or groups to specify the runner for a job.'
redirect_from:
- /github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow
- /actions/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow
- /actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
- /actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow
- /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: tutorial
shortTitle: Use runners in a workflow
---

{% data reusables.actions.enterprise-github-hosted-runners %}

{% ifversion repository-actions-runners %}

## Viewing available runners for a repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@ redirect_from:
> [!NOTE]
> {% data reusables.actions.windows-linux-larger-runners-note %}

## About runner groups

{% data reusables.actions.about-runner-groups %}

### Managing access to your runners
## Managing access to larger runners

> [!NOTE]
> Before your workflows can send jobs to {% data variables.actions.hosted_runner %}s, you must first configure permissions for the runner group. See the following sections for more information.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ When migrating from Travis CI, consider the following key features in {% data va

### Hosting your own runners

If your jobs require specific hardware or software, {% data variables.product.prodname_actions %} allows you to host your own runners and send your jobs to them for processing. {% data variables.product.prodname_actions %} also lets you use policies to control how these runners are accessed, granting access at the organization or repository level. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners).
If your jobs require specific hardware or software, {% data variables.product.prodname_actions %} allows you to host your own runners and send your jobs to them for processing. {% data variables.product.prodname_actions %} also lets you use policies to control how these runners are accessed, granting access at the organization or repository level. For more information, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners).

{% ifversion fpt or ghec %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ A **runner** is a server that runs your workflows when they're triggered. Each r

If you need a different operating system or require a specific hardware configuration, you can host your own runners.

For more information about self-hosted runners, see [AUTOTITLE](/actions/hosting-your-own-runners).
For more information about self-hosted runners, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners).

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion content/rest/actions/self-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ autogenerated: rest

## About self-hosted runners in {% data variables.product.prodname_actions %}

You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see [AUTOTITLE](/actions/hosting-your-own-runners).
You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners).

<!-- Content after this section is automatically generated -->
4 changes: 1 addition & 3 deletions data/reusables/actions/about-runner-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@ To control access to runners at the organization{% ifversion ghec or ghes %} and

When you grant access to a runner group, you can see the runner group listed in the organization's runner settings. Optionally, you can assign additional granular repository{% ifversion ghec or ghes %} and workflow{% endif %} access policies to the runner group.

When new runners are created, they are automatically assigned to the default group unless otherwise specified. Runners can only be in one group at a time. You can move runners from one runner group to another. For more information, see [Moving a runner to a group](#moving-a-runner-to-a-group).

For information on how to route jobs to runners in a specific group, see [AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job#choosing-runners-in-a-group).
When new runners are created, they are automatically assigned to the default group unless otherwise specified. Runners can only be in one group at a time. You can move runners from one runner group to another.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Always include a security admonition above this procedure. This is either one of

Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion ghec or ghes %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion ghec or ghes %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions#self-hosted-runner-groups).

If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group. For more information, see [Moving a runner to a group](#moving-a-runner-to-a-group).
If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group.

When creating a group, you must choose a policy that defines which organizations have access to the runner group.

Expand Down
Loading
Loading