Skip to content

Commit 1d8067a

Browse files
authored
docs/private runners (#1847)
* add documentation about private runners * fix
1 parent c36e2f7 commit 1d8067a

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

docs/ce/features/private-runners.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Private Runners"
3+
---
4+
5+
In many situations you wish to run digger with private runners. For example if you are provisioning resources in a private k8s cluster in this case you will not be able to use cloud runners.
6+
7+
While digger does not natively support k8s agents it is very easy to do it indirectly using github actions runners.
8+
In the typical digger flow you are using a workflow that looks like this:
9+
10+
```
11+
name: Digger Workflow
12+
on:
13+
# ....
14+
jobs:
15+
digger-job:
16+
runs-on: ubuntu-latest
17+
```
18+
19+
With github specifically there is good support for [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)
20+
which means that you can create agents for github actions in your private infrastructure's VPC and github will then run the jobs there.
21+
22+
The easiest way to achieve self-hosted runners is by running the agent in something like an EC2 instance. Alternatively if you already have a kubernetes cluster
23+
you could opt for using the [Actions runner controller](which will provide you with actions right in your cluster). Once you have set up and configured your controllers
24+
you can then reference the name of your self-hosted runners in the digger workflow:
25+
26+
```
27+
name: Digger Workflow
28+
on:
29+
# ....
30+
jobs:
31+
digger-job:
32+
runs-on: my-selfhosted-ubuntu
33+
```
34+
35+
In this way all of digger future jobs will run within your infrastructure.

docs/mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383
"ce/features/opa-policies",
8484
"ce/features/concurrency",
8585
"ce/features/pr-level-locks",
86-
"ce/features/plan-persistence"
86+
"ce/features/plan-persistence",
87+
"ce/features/private-runners"
8788
]
8889
},
8990
{

0 commit comments

Comments
 (0)