feat: add GitHub Actions runner greffon #12
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| version: "3" | ||
|
|
||
| services: | ||
| github_runner: | ||
| image: myoung34/github-runner:2.333.1-ubuntu-noble | ||
| restart: unless-stopped | ||
| depends_on: | ||
| - docker | ||
| environment: | ||
| DOCKER_HOST: tcp://docker:2375 | ||
| EPHEMERAL: "1" | ||
| DISABLE_AUTO_UPDATE: "1" | ||
| START_DOCKER_SERVICE: "false" | ||
| UNSET_CONFIG_VARS: "true" | ||
| RUN_AS_ROOT: "false" | ||
| RUNNER_WORKDIR: /runner/_work | ||
| RUNNER_SCOPE: repo | ||
| RUNNER_NAME_PREFIX: greffon-{{ instance_id }} | ||
| LABELS: greffon,self-hosted | ||
|
There was a problem hiding this comment.
When this runner completes a job, Useful? React with 👍 / 👎. |
||
| GITHUB_HOST: github.com | ||
| volumes: | ||
| - runner-work:/runner/_work | ||
|
|
||
| docker: | ||
| image: docker:29.4.0-dind | ||
| restart: unless-stopped | ||
| privileged: true | ||
| environment: | ||
| DOCKER_TLS_CERTDIR: "" | ||
| command: | ||
| - dockerd | ||
| - --host=tcp://0.0.0.0:2375 | ||
| - --host=unix:///var/run/docker.sock | ||
| - --tls=false | ||
| volumes: | ||
| - runner-work:/runner/_work | ||
| - docker-data:/var/lib/docker | ||
|
|
||
| volumes: | ||
| runner-work: | ||
| docker-data: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| { | ||
| "name": "GitHub Actions Runner", | ||
| "logo": "https://github.githubassets.com/favicons/favicon.svg", | ||
| "description": "Self-hosted GitHub Actions runner with Docker-in-Docker support", | ||
| "categories": [ | ||
| "ci", | ||
| "developer-tools" | ||
| ], | ||
| "images": [], | ||
| "configurations": [ | ||
| { | ||
| "title": "RUNNER_CONFIGURATION", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "auth_type": { | ||
| "type": "string", | ||
| "title": "Authentication method", | ||
| "description": "Choose a durable PAT-based setup or a short-lived GitHub runner registration token.", | ||
| "enum": [ | ||
| "access_token", | ||
| "runner_token" | ||
| ], | ||
| "enumNames": [ | ||
| "Personal access token (recommended)", | ||
| "Registration token" | ||
| ] | ||
| }, | ||
| "access_token": { | ||
| "type": "string", | ||
| "title": "GitHub PAT", | ||
| "description": "PAT used to request short-lived self-hosted runner registration tokens automatically.", | ||
| "writeOnly": true | ||
| }, | ||
| "runner_token": { | ||
| "type": "string", | ||
| "title": "GitHub runner registration token", | ||
| "description": "Short-lived registration token from GitHub's standard ./config.sh flow.", | ||
| "writeOnly": true | ||
| }, | ||
| "runner_scope": { | ||
| "type": "string", | ||
| "title": "Runner scope", | ||
| "description": "Use repo for one repository, or org for an organization-level runner.", | ||
| "enum": [ | ||
| "repo", | ||
| "org" | ||
| ] | ||
| }, | ||
| "repo_url": { | ||
| "type": "string", | ||
| "title": "Repository URL", | ||
| "description": "Required when runner scope is repo, for example https://github.com/owner/repo." | ||
| }, | ||
| "org_name": { | ||
| "type": "string", | ||
| "title": "Organization name", | ||
| "description": "Required when runner scope is org." | ||
| }, | ||
| "runner_name_prefix": { | ||
| "type": "string", | ||
| "title": "Runner name prefix", | ||
| "description": "Prefix for the generated GitHub runner name." | ||
| }, | ||
| "labels": { | ||
| "type": "string", | ||
| "title": "Runner labels", | ||
| "description": "Comma-separated labels added to this self-hosted runner." | ||
| }, | ||
| "runner_group": { | ||
| "type": "string", | ||
| "title": "Runner group", | ||
| "description": "Optional runner group name. Leave blank to use GitHub's default runner group." | ||
| }, | ||
| "github_host": { | ||
| "type": "string", | ||
| "title": "GitHub host", | ||
| "description": "GitHub host for GitHub Enterprise Server installations." | ||
| } | ||
| }, | ||
| "dependencies": { | ||
| "auth_type": { | ||
| "oneOf": [ | ||
| { | ||
| "properties": { | ||
| "auth_type": { | ||
| "enum": [ | ||
| "access_token" | ||
| ] | ||
| }, | ||
| "access_token": { | ||
| "minLength": 1 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "access_token" | ||
| ] | ||
| }, | ||
| { | ||
| "properties": { | ||
| "auth_type": { | ||
| "enum": [ | ||
| "runner_token" | ||
| ] | ||
| }, | ||
| "runner_token": { | ||
| "minLength": 1 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "runner_token" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "runner_scope": { | ||
| "oneOf": [ | ||
| { | ||
| "properties": { | ||
| "runner_scope": { | ||
| "enum": [ | ||
| "repo" | ||
| ] | ||
| }, | ||
| "repo_url": { | ||
| "minLength": 1 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "repo_url" | ||
| ] | ||
| }, | ||
| { | ||
| "properties": { | ||
| "runner_scope": { | ||
| "enum": [ | ||
| "org" | ||
| ] | ||
| }, | ||
| "org_name": { | ||
| "minLength": 1 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "org_name" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "default_value": { | ||
| "auth_type": "access_token", | ||
| "access_token": "", | ||
| "runner_token": "", | ||
| "runner_scope": "repo", | ||
| "repo_url": "", | ||
| "org_name": "", | ||
| "runner_name_prefix": "greffon-{{ instance_id }}", | ||
| "labels": "greffon,self-hosted", | ||
| "runner_group": "", | ||
| "github_host": "github.com" | ||
| }, | ||
| "destinations": [ | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "ACCESS_TOKEN", | ||
| "value_path": "access_token" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "RUNNER_TOKEN", | ||
| "value_path": "runner_token" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "RUNNER_SCOPE", | ||
| "value_path": "runner_scope" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "REPO_URL", | ||
| "value_path": "repo_url" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "ORG_NAME", | ||
| "value_path": "org_name" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "RUNNER_NAME_PREFIX", | ||
| "value_path": "runner_name_prefix" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "LABELS", | ||
| "value_path": "labels" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "RUNNER_GROUP", | ||
| "value_path": "runner_group" | ||
| }, | ||
| { | ||
| "type": "env", | ||
| "container": "github_runner", | ||
| "key": "GITHUB_HOST", | ||
| "value_path": "github_host" | ||
| } | ||
| ], | ||
| "x-greffon-allow-empty-secret": true | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the runner image pinned to
2.333.1-ubuntu-noble, settingDISABLE_AUTO_UPDATEleaves deployed instances permanently on that runner binary unless every deployment is manually recreated after each upstream release. GitHub's self-hosted runner reference states that when updates are disabled, the runner must be updated within 30 days of a new release and GitHub Actions stops queueing jobs afterward. Existing catalog installs will therefore become unusable after the next runner release ages past that window; allow automatic updates or add an actual image refresh mechanism.Useful? React with 👍 / 👎.