mirror of
https://github.com/actions/runner.git
synced 2025-12-10 12:36:23 +00:00
ce68f3b167
* Use flags in svc creation script * Refactor regex and add comments * Fix indentation and typo in user matching * Consistency use flags in automation scripts * Update documentation to reflect new usage * Make example more readable * Remove test echos from script * Remove test echo * Format scripts and remove test script * Remove tar * Use getopts and single letter flags * Update docs to show flag usage * Update usage of create svc * Revert svc to not use flags * Revert delete script * Update docs * Readd deleted comments
79 lines
2.8 KiB
Markdown
79 lines
2.8 KiB
Markdown
# Automate Configuring Self-Hosted Runners
|
|
|
|
|
|
## Export PAT
|
|
|
|
Before running any of these sample scripts, create a GitHub PAT and export it before running the script
|
|
|
|
```bash
|
|
export RUNNER_CFG_PAT=yourPAT
|
|
```
|
|
|
|
## Create running as a service
|
|
|
|
**Scenario**: Run on a machine or VM ([not container](#why-cant-i-use-a-container)) which automates:
|
|
|
|
- Resolving latest released runner
|
|
- Download and extract latest
|
|
- Acquire a registration token
|
|
- Configure the runner
|
|
- Run as a systemd (linux) or Launchd (osx) service
|
|
|
|
:point_right: [Sample script here](../scripts/create-latest-svc.sh) :point_left:
|
|
|
|
Run as a one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level)
|
|
```bash
|
|
curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | bash -s yourorg/yourrepo
|
|
```
|
|
|
|
You can call the script with additional arguments:
|
|
```bash
|
|
# Usage:
|
|
# export RUNNER_CFG_PAT=<yourPAT>
|
|
# ./create-latest-svc -s scope -g [ghe_domain] -n [name] -u [user] -l [labels]
|
|
# -s required scope: repo (:owner/:repo) or org (:organization)
|
|
# -g optional ghe_hostname: the fully qualified domain name of your GitHub Enterprise Server deployment
|
|
# -n optional name of the runner, defaults to hostname
|
|
# -u optional user svc will run as, defaults to current
|
|
# -l optional list of labels (split by comma) applied on the runner"
|
|
```
|
|
|
|
Use `--` to pass any number of optional named parameters:
|
|
|
|
```
|
|
curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | bash -s -- -s myorg/myrepo -n myname -l label1,label2
|
|
```
|
|
### Why can't I use a container?
|
|
|
|
The runner is installed as a service using `systemd` and `systemctl`. Docker does not support `systemd` for service configuration on a container.
|
|
|
|
## Uninstall running as service
|
|
|
|
**Scenario**: Run on a machine or VM ([not container](#why-cant-i-use-a-container)) which automates:
|
|
|
|
- Stops and uninstalls the systemd (linux) or Launchd (osx) service
|
|
- Acquires a removal token
|
|
- Removes the runner
|
|
|
|
:point_right: [Sample script here](../scripts/remove-svc.sh) :point_left:
|
|
|
|
Repo level one liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level)
|
|
```bash
|
|
curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/remove-svc.sh | bash -s yourorg/yourrepo
|
|
```
|
|
|
|
### Delete an offline runner
|
|
|
|
**Scenario**: Deletes a registered runner that is offline:
|
|
|
|
- Ensures the runner is offline
|
|
- Resolves id from name
|
|
- Deletes the runner
|
|
|
|
:point_right: [Sample script here](../scripts/delete.sh) :point_left:
|
|
|
|
Repo level one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) and replace runnername
|
|
```bash
|
|
curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/delete.sh | bash -s yourorg/yourrepo runnername
|
|
```
|