From dda4721d6eb6c7112c863655544626b8d7fc3137 Mon Sep 17 00:00:00 2001 From: Robert Kielty Date: Tue, 4 Mar 2025 08:56:32 +0000 Subject: [PATCH] adds initial documentatin for custom runners Signed-off-by: Robert Kielty --- ci/README.MD | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/ci/README.MD b/ci/README.MD index 3e10832..b898b80 100644 --- a/ci/README.MD +++ b/ci/README.MD @@ -1,7 +1,32 @@ -# External GitHub Action Runners +# External GitHub Action Runners -** WORK IN PROGRESS ** +Maintained by the CNCF Projects Team, cncf/automation/ci orchestrates external +GitHub Action Runners to run on resources donated to the CNCF. -Maintained by the CNCF Projects Team, cncf/automation/ci orchestrates external GitHub Action Runners. +CNCF Projects can make use of the External GitHub Action Runners that are +defined here for CI jobs. -CNCF Projects can make use of the External GitHub Action Runners that are defined here for CI jobs. \ No newline at end of file +## Custom runners + +We have created two custom runners that allow us to run any containerizable CI +job on both x86_64/amd64 and arm63 Architechtures. + +In a Github Action workflow, you can define multiple jobs and for each of those +jobs you choose a runner. + +We have defined two 16CPU/64GB runners that can used by adding either of the +following statements to your job definitions: + +**For an amd64/x86_64 runner use:** + +`runs-on: oracle-16cpu-64gb-x86-64` + +**For an arm64 runner** + +`runs-on: oracle-16cpu-64gb-arm64` + +## Runner definition + +The above runners are defined in this repo <./gha-runner-image/Dockerfile> + +You can review the Dockerfile to see what tools have been added to the runner image.