Skip to content

docs: fixes in Actions runner documentation #38685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sharra-writes merged 3 commits into from
Jun 4, 2025
Merged

docs: fixes in Actions runner documentation #38685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2643036
docs: fix typos and improve consistency for 'binary/binaries' & 'Scal…
Rahul-Lashkari Jun 2, 2025
0a7711a
Update content/actions/hosting-your-own-runners/managing-self-hosted-…
Sharra-writes Jun 4, 2025
6ba053e
Merge branch 'main' into fix-docs-actions-runner-typos
Sharra-writes Jun 4, 2025
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
4 changes: 2 additions & 2 deletions ...osted-runners-with-actions-runner-controller/about-actions-runner-controller.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ topics:

{% data reusables.actions.actions-runner-controller-about-arc %}

The following diagram illustrates the architecture of ARC's autoscaling runner scaleset mode.
The following diagram illustrates the architecture of ARC's autoscaling runner scale set mode.
Copy link
Contributor

@Sharra-writes Sharra-writes Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, this is also complicated. I think "ScaleSet" is correct, even though it's written as "Scale Sets" in one place, because I see names like "AutoScalingRunnerSet" and "RunnerSet" that follow the same format. The "scaleset" is more ambiguous, though, because "scale set" is used in the reusable on line 19. Lowercase "scaleset" might be the name of the mode, but it's not used that way consistently.

Here's what I would recommend: "ScaleSet" should always be one word, because it matches the other capitalized terms. Lowercase "scaleset" should always actually be "scale set." That should (🤞) make it consistent and more readable.

Copy link
Contributor Author

@Rahul-Lashkari Rahul-Lashkari Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the recommendation, please review~~


> [!NOTE]
> To view the following diagram in a larger size, see the [Autoscaling Runner Scale Sets mode](https://github.com/actions/actions-runner-controller/blob/master/docs/gha-runner-scale-set-controller/README.md#how-it-works) documentation in the Actions Runner Controller repository.
Expand All @@ -30,7 +30,7 @@ The following diagram illustrates the architecture of ARC's autoscaling runner s
1. {% data variables.product.prodname_actions_runner_controller %} is installed using the supplied Helm charts, and the controller manager pod is deployed in the specified namespace. A new AutoScalingRunnerSet resource is deployed via the supplied Helm charts or a customized manifest file. The AutoScalingRunnerSet Controller calls GitHub's APIs to fetch the runner group ID that the runner scale set will belong to.
1. The AutoScalingRunnerSet Controller calls the APIs one more time to either fetch or create a runner scale set in the {% data variables.product.prodname_actions %} service before creating the Runner ScaleSet Listener resource.
1. A Runner ScaleSet Listener pod is deployed by the AutoScalingListener Controller. In this pod, the listener application connects to the {% data variables.product.prodname_actions %} Service to authenticate and establish an HTTPS long poll connection. The listener stays idle until it receives a `Job Available` message from the {% data variables.product.prodname_actions %} Service.
1. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scalesets where the `runs-on` key matches the name of the runner scaleset or labels of self-hosted runners.
1. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scale sets where the `runs-on` key matches the name of the runner scale set or labels of self-hosted runners.
1. When the Runner ScaleSet Listener receives the `Job Available` message, it checks whether it can scale up to the desired count. If it can, the Runner ScaleSet Listener acknowledges the message.
1. The Runner ScaleSet Listener uses a Service Account and a Role bound to that account to make an HTTPS call through the Kubernetes APIs to patch the Ephemeral RunnerSet resource with the number of desired replicas count.
1. The Ephemeral RunnerSet attempts to create new runners and the EphemeralRunner Controller requests a Just-in-Time (JIT) configuration token to register these runners. The controller attempts to create runner pods. If the pod's status is `failed`, the controller retries up to 5 times. After 24 hours the {% data variables.product.prodname_actions %} Service unassigns the job if no runner accepts it.
Expand Down
2 changes: 1 addition & 1 deletion ...runners/managing-self-hosted-runners/customizing-the-containers-used-by-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ No output is expected for `run_script_step`.
npm install && npm run bootstrap && npm run build-all
```

When the resulting `index.js` is triggered by {% data variables.product.prodname_actions %}, it will run the customization commands defined in the JSON files. To trigger the `index.js`, you will need to add it your `ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER` environment variable, as described in the next section.
When the resulting `index.js` is triggered by {% data variables.product.prodname_actions %}, it will run the customization commands defined in the JSON files. To trigger the `index.js`, you will need to add it to your `ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER` environment variable, as described in the next section.

## Triggering the customization script

Expand Down
Loading