diff --git a/docs/authenticating-to-the-github-api.md b/docs/authenticating-to-the-github-api.md index 80dcd301..61370335 100644 --- a/docs/authenticating-to-the-github-api.md +++ b/docs/authenticating-to-the-github-api.md @@ -22,7 +22,7 @@ _Note: Links are provided further down to create an app for your logged in user * Actions (read) * Administration (read / write) -* Checks (read) (if you are going to use [Webhook Driven Scaling](#webhook-driven-scaling)) +* Checks (read) (if you are going to use [Webhook Driven Scaling](automatically-scaling-runners.md#webhook-driven-scaling)) * Metadata (read) **Required Permissions for Organization Runners:**
@@ -39,7 +39,7 @@ _Note: All API routes mapped to their permissions can be found [here](https://do **Subscribe to events** -At this point you have a choice of configuring a webhook, a webhook is needed if you are going to use [webhook driven scaling](#webhook-driven-scaling). The webhook can be configured centrally in the GitHub app itself or separately. In either case you need to subscribe to the `Workflow Job` event. +At this point you have a choice of configuring a webhook, a webhook is needed if you are going to use [webhook driven scaling](automatically-scaling-runners.md#webhook-driven-scaling). The webhook can be configured centrally in the GitHub app itself or separately. In either case you need to subscribe to the `Workflow Job` event. --- diff --git a/docs/automatically-scaling-runners.md b/docs/automatically-scaling-runners.md index 1049e87a..4d7dc8fd 100644 --- a/docs/automatically-scaling-runners.md +++ b/docs/automatically-scaling-runners.md @@ -133,7 +133,7 @@ The `HorizontalRunnerAutoscaler` will poll GitHub for the number of runners in t **Benefits of this metric** 1. Supports named repositories server-side the same as the `TotalNumberOfQueuedAndInProgressWorkflowRuns` metric [#313](https://github.com/actions/actions-runner-controller/pull/313) 2. Supports GitHub organization wide scaling without maintaining an explicit list of repositories, this is especially useful for those that are working at a larger scale. [#223](https://github.com/actions/actions-runner-controller/pull/223) -3. Like all scaling metrics, you can manage workflow allocation to the RunnerDeployment through the use of [GitHub labels](#runner-labels) +3. Like all scaling metrics, you can manage workflow allocation to the RunnerDeployment through the use of [GitHub labels](using-arc-runners-in-a-workflow.md#runner-labels) 4. Supports scaling desired runner count on both a percentage increase / decrease basis as well as on a fixed increase / decrease count basis [#223](https://github.com/actions/actions-runner-controller/pull/223) [#315](https://github.com/actions/actions-runner-controller/pull/315) **Drawbacks of this metric** diff --git a/docs/using-arc-across-organizations.md b/docs/using-arc-across-organizations.md index 8b024331..4a676979 100644 --- a/docs/using-arc-across-organizations.md +++ b/docs/using-arc-across-organizations.md @@ -4,7 +4,7 @@ > This feature requires controller version => [v0.26.0](https://github.com/actions/actions-runner-controller/releases/tag/v0.26.0) -In a large enterprise, there might be many GitHub organizations that requires self-hosted runners. Previously, the only way to provide ARC-managed self-hosted runners in such environment was [Deploying Multiple Controllers](#deploying-multiple-controllers), which incurs overhead due to it requires one ARC installation per GitHub organization. +In a large enterprise, there might be many GitHub organizations that requires self-hosted runners. Previously, the only way to provide ARC-managed self-hosted runners in such environment was [Deploying Multiple Controllers](deploying-arc-runners.md#deploying-multiple-controllers), which incurs overhead due to it requires one ARC installation per GitHub organization. With multitenancy, you can let ARC manage self-hosted runners across organizations. It's enabled by default and the only thing you need to start using it is to set the `spec.githubAPICredentialsFrom.secretRef.name` fields for the following resources: @@ -58,4 +58,4 @@ spec: when and which varying ARC component(`horizontalrunnerautoscaler-controller`, `runnerdeployment-controller`, `runnerreplicaset-controller`, `runner-controller` or `runnerpod-controller`) makes specific API calls. > Just don't be surprised you have to repeat `githubAPICredentialsFrom.secretRef.name` settings among two resources! -Please refer to [Deploying Using GitHub App Authentication](#deploying-using-github-app-authentication) for how you could create the Kubernetes secret containing GitHub App credentials. \ No newline at end of file +Please refer to [Deploying Using GitHub App Authentication](authenticating-to-the-github-api.md#deploying-using-github-app-authentication) for how you could create the Kubernetes secret containing GitHub App credentials. \ No newline at end of file