garm-provider-k8s

• ✨ What is the garm-provider-k8s?
• 🔀 Versioning
  • Kubernetes Version
• 🚀 Installation
  • Prerequisites
  • Installation
• 💻 Development
• Contributing
• Code of Conduct
• License
• Provider Information

✨ What is the garm-provider-k8s?

garm-provider-k8s is a Kubernetes® a plugin for garm which enables garm to spin up Pod based GitHub® Action runners on a Kubernetes cluster.

🔀 Versioning

Kubernetes Version

garm-provider-k8s uses client-go to talk with Kubernetes clusters. The supported Kubernetes cluster version is determined by client-go. The compatibility matrix for client-go and Kubernetes cluster can be found here.

🚀 Installation

Prerequisites

1. A Kubernetes cluster to spin up runners with the garm-provider-k8s plugin.
2. A working garm installation.

Installation

garm-provider-k8s

We are releasing the garm-provider-k8s as a simple go binary. You can find the latest release here. Adjust your existing garm config, so garm can register to provider plugin at runtime. Make sure garm has access to the binary and provider specific config path like so:

[[provider]]
name = "kubernetes_external"
description = "kubernetes provider"
provider_type = "external"
[provider.external]
config_file = "/path/to/garm-provider-k8s-config.yaml"
provider_executable = "/path/to/provider/binary/garm-provider-k8s"
environment_variables = ["KUBERNETES_"] # this must be set if the runner-pods should run in the same cluster as garm itself is running and the attached serviceaccount should be used to create pods and the runner namespace

The provider specific config file should look like this:

kubeConfigPath: "" # path to a kubernetes config file - if empty the in cluster config will be used
runnerNamespace: "runner" # namespace to create the runner pods in
podTemplate: # pod template to use for the runner pods / helpful to add sidecar containers
  spec:
    volumes:
      - name: my-additional-volume
        emptyDir: {}
flavors: # configure different flavors which will be set as `ResourceRequirements` at runner container and can be targeted from a pool via its `flavor` property
  micro:
    requests:
      cpu: 50m
      memory: 50Mi
    limits:
      memory: 200Mi
  ultra:
    requests:
      cpu: 500m
      memory: 500Mi
    limits:
      memory: 1Gi

💻 Development

For local development, please read the development guide.

Contributing

We welcome any contributions. If you want to contribute to this project, please read the contributing guide.

Code of Conduct

Please read our Code of Conduct as it is our base for interaction.

License

This project is licensed under the MIT LICENSE.

Provider Information

Please visit https://www.mercedes-benz-techinnovation.com/en/imprint/ for information on the provider.

Notice: Before you use the program in productive use, please take all necessary precautions, e.g. testing and verifying the program with regard to your specific use. The source code has been tested solely for our own use cases, which might differ from yours.