Update README, and use tag rather than sha for base image in Dockerfi…

…le. (#21)
ministryofjustice · Jan 17, 2025 · ff65de9 · ff65de9
1 parent cd9cbc4
commit ff65de9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 #checkov:skip=CKV_DOCKER_2:actions/runner does not provider a mechanism for checking the health of the service
-FROM public.ecr.aws/ubuntu/ubuntu@sha256:4f5ca1c8b7abe2bd1162e629cafbd824c303b98954b1a168526aca6021f8affe
+FROM public.ecr.aws/ubuntu/ubuntu:24.04_stable
 
 LABEL org.opencontainers.image.vendor="Ministry of Justice" \
       org.opencontainers.image.authors="HMPPS DPS" \

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # hmpps-github-actions-runner
-This deploys a self-hosted Github Runner to the github organisation.
+This project builds and deploys self-hosted Github Runners to the MinistryOfJustice github organisation. It's deployed to Cloud Platforms, using Helm.
 
-Documentation about it is [here](https://tech-docs.hmpps.service.justice.gov.uk/sreinternaldocs) 
+For teams wishing to **use these runners in your own pipelines**, the documentation is [here](https://tech-docs.hmpps.service.justice.gov.uk/sre-internal-docs/).
 
-It's deployed to Cloud Platforms, using Helm.
+# Building and Deploying
 
 ## Secrets/variables required:
 
@@ -24,3 +24,14 @@ It's deployed to Cloud Platforms, using Helm.
 - GH_APP_ID - the corresponding AppId for the Github App
 - RUNNER_LABEL - the label by which the runner is invoked
 - RUNNER_GROUP - the runner group to assign the new runners to.
+
+Note: the runner group needs to be be configured manually prior to deployment. The runner group can be configured to limit access to the runners, e.g. so only selected repositories can use them.
+
+### Updating the Actions Runner version
+
+Github requires that the Github Actions Runners versions are kept up-to-date; if an old version is deployed, there is a good chance it will be unable to register because it's too old. Update the Dockerfile with the latest version if needed:
+
+```Dockerfile
+ACTIONS_RUNNER_VERSION="xxxx"
+```
+Use the latest version of the runner and SHA from the [Github Actions Runner releases page](https://github.com/actions/runner/releases) - the checksum will be the one corresponding to `actions-runner-linux-x64`