mirror of https://github.com/actions/runner-container-hooks.git synced 2025-12-14 16:46:43 +00:00

Files

Nikola Jokic 4cdcf09c43 Implement yaml extensions overwriting the default pod/container spec (#75 )

* Implement yaml extensions overwriting the default pod/container spec

* format files

* Extend specs for container job and include docker and k8s tests in k8s

* Create table tests for docker tests

* included warnings and extracted append logic as generic

* updated merge to allow for file read

* reverted back examples and k8s/tests

* reverted back docker tests

* Tests for extension prepare-job

* Fix lint and format and merge error

* Added basic test for container step

* revert hooklib since new definition for container options is received from a file

* revert docker options since create options are a string

* Fix revert

* Update package locks and deps

* included example of extension.yaml. Added side-car container that was missing

* Ignore spec modification for the service containers, change selector to

* fix lint error

* Add missing image override

* Add comment explaining merge object meta with job and pod

* fix test

2023-09-25 11:49:03 +02:00

src

Implement yaml extensions overwriting the default pod/container spec (#75 )

2023-09-25 11:49:03 +02:00

tests

Implement yaml extensions overwriting the default pod/container spec (#75 )

2023-09-25 11:49:03 +02:00

jest.config.js

Initial Commit

2022-06-02 15:53:11 -04:00

jest.setup.js

fixed testing adding storage class and persistent volume and timeout to wait for cleanup

2022-06-06 12:56:50 +02:00

package-lock.json

Implement yaml extensions overwriting the default pod/container spec (#75 )

2023-09-25 11:49:03 +02:00

package.json

Implement yaml extensions overwriting the default pod/container spec (#75 )

2023-09-25 11:49:03 +02:00

README.md

Make K8s claim name optional (#18 )

2022-06-20 15:09:04 -04:00

tsconfig.json

Initial Commit

2022-06-02 15:53:11 -04:00

README.md

K8s Hooks

Description

This implementation provides a way to dynamically spin up jobs to run container workflows, rather then relying on the default docker implementation. It is meant to be used when the runner itself is running in k8s, for example when using the Actions Runner Controller

Pre-requisites

Some things are expected to be set when using these hooks

The runner itself should be running in a pod, with a service account with the following permissions

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  namespace: default
  name: runner-role
rules:
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["get", "list", "create", "delete"]
- apiGroups: [""]
  resources: ["pods/exec"]
  verbs: ["get", "create"]
- apiGroups: [""]
  resources: ["pods/log"]
  verbs: ["get", "list", "watch",]
- apiGroups: ["batch"]
  resources: ["jobs"]
  verbs: ["get", "list", "create", "delete"]
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get", "list", "create", "delete"]

The ACTIONS_RUNNER_POD_NAME env should be set to the name of the pod
The ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER env should be set to true to prevent the runner from running any jobs outside of a container
The runner pod should map a persistent volume claim into the _work directory
- The ACTIONS_RUNNER_CLAIM_NAME env should be set to the persistent volume claim that contains the runner's working directory, otherwise it defaults to ${ACTIONS_RUNNER_POD_NAME}-work
Some actions runner env's are expected to be set. These are set automatically by the runner.
- RUNNER_WORKSPACE is expected to be set to the workspace of the runner
- GITHUB_WORKSPACE is expected to be set to the workspace of the job

Limitations

A job containers will be required for all jobs
Building container actions from a dockerfile is not supported at this time
Container actions will not have access to the services network or job container network
Docker create options are not supported