Skip to content

Commit 68bfe7a

Browse files
committed
doc: replace self-hosted runner draft with private runner documentation
1 parent 19a52d8 commit 68bfe7a

File tree

3 files changed

+42
-3
lines changed

3 files changed

+42
-3
lines changed

docs/administration.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ per meshcloud installation.
5656
|   [Platform Notifications](administration.platforms.md#platform-notifications) | ✓ | ✓ | ✓ | | | | | |
5757
|   [Platform Restrictions](administration.platforms.md#restrict-platform-access) | ✓ | ✓ | ✓ | ✓ | | | | |
5858
|   [Landing Zones](administration.landing-zones.md) | ✓ | ✓ | ✓ | | | | | |
59-
|   [Usage Reports](meshcloud.project-metering.md#tenant-usage-reports.md) | ✓ | ✓ | | | ✓ | | | |
59+
|   [Usage Reports](meshcloud.project-metering.md#tenant-usage-reports) | ✓ | ✓ | | | ✓ | | | |
6060
|   [Tenants](administration.tenants.md) | ✓ | ✓ | ✓ | ✓ | | | | ✓ |
6161
|   View [Unmanaged Tenants](administration.unmanaged-tenants.md) | ✓ | ✓ | ✓ | | | | | ✓ |
6262
|   Assign [Unmanaged Tenants](administration.unmanaged-tenants.md#assigning-unmanaged-tenants) | ✓ | | | | | | | |
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
id: meshstack.building-blocks.private-runners
3+
title: Private Runners
4+
---
5+
6+
Private runners can be used to execute building blocks in your own cloud environment to enable access to resources that are not publicly accessible.
7+
8+
These runners are still operated by meshcloud but run outside of your meshStack.
9+
Otherwise private runners operate like regular runners and connects to meshStack via meshStack API.
10+
11+
When using a private runner it will run all building blocks from your meshStack.
12+
13+
## Requirements for private runners
14+
15+
To use private runners meshcloud operators need access to an environment with
16+
17+
- network access to your meshStack,
18+
- internet access for sourcing building block code and requirements (e.g. Terraform providers),
19+
- a way to run container based workloads (e.g. Kubernetes),
20+
- a way to facilitate automatic updates to the runner.
21+
22+
## Communication between private runners and meshStack
23+
24+
The private runner connects to the parent meshStack to receive building block executions.
25+
Since the private runner opens a connection to your meshStack, inbound connections to the runner are not needed.
26+
27+
```mermaid
28+
graph LR
29+
30+
subgraph meshStack
31+
API
32+
end
33+
34+
subgraph private network
35+
runner[private runner]
36+
end
37+
38+
runner --HTTPS via public internet--> API
39+
```

website/sidebars.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
],
7474
"Building Blocks": [
7575
"administration.building-blocks",
76-
"meshstack.building-blocks.self-hosted-runners",
76+
"meshstack.building-blocks.private-runners",
7777
"meshstack.building-blocks.meshStack-http-backend",
7878
"meshstack.building-blocks.permission-delegation-aws",
7979
"meshstack.building-pipeline-integration",
@@ -153,4 +153,4 @@
153153
"meshstack.how-to.get-started-building-blocks"
154154
]
155155
}
156-
}
156+
}

0 commit comments

Comments
 (0)