{"id":13648981,"url":"https://github.com/itsksaurabh/kubeact","last_synced_at":"2025-07-01T12:39:12.868Z","repository":{"id":51256127,"uuid":"250758071","full_name":"itsksaurabh/kubeact","owner":"itsksaurabh","description":"A Helm chart for hosting your own runner on Kubernetes to run jobs in your GitHub Actions workflows.  ☸️ 🚀","archived":false,"fork":false,"pushed_at":"2020-09-25T15:37:05.000Z","size":54,"stargazers_count":53,"open_issues_count":4,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-30T16:22:55.374Z","etag":null,"topics":["ci-cd","cicd","devops","devops-tools","github","github-actions","helm","helm-chart","helm-charts","k8s","kubernetes","runner","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsksaurabh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://www.paypal.me/itsksaurabh"]}},"created_at":"2020-03-28T09:38:24.000Z","updated_at":"2025-01-19T18:17:28.000Z","dependencies_parsed_at":"2022-09-19T19:13:12.359Z","dependency_job_id":null,"html_url":"https://github.com/itsksaurabh/kubeact","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsksaurabh%2Fkubeact","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsksaurabh%2Fkubeact/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsksaurabh%2Fkubeact/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsksaurabh%2Fkubeact/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsksaurabh","download_url":"https://codeload.github.com/itsksaurabh/kubeact/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251711388,"owners_count":21631293,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci-cd","cicd","devops","devops-tools","github","github-actions","helm","helm-chart","helm-charts","k8s","kubernetes","runner","self-hosted"],"created_at":"2024-08-02T01:04:41.211Z","updated_at":"2025-04-30T13:13:00.273Z","avatar_url":"https://github.com/itsksaurabh.png","language":"Shell","funding_links":["https://www.paypal.me/itsksaurabh"],"categories":["Shell"],"sub_categories":[],"readme":"\u003cdiv style=\"text-align:center\"\u003e\u003cimg  width=\"250\" src=\"./assets/logo.png\" /\u003e\u003c/div\u003e\n\n# kubeact\n![Kubeact](https://github.com/itsksaurabh/kubeact/workflows/Kubeact/badge.svg)\n\nA Helm chart for hosting your own runner on Kubernetes to run jobs in your GitHub Actions workflows. ☸️ 🚀\n\n## What is Kubeact? ☸️ 🚀\n\n**Kubeact** is a [Helm](https://helm.sh/) Chart/Package for [Kubernetes (K8s)](https://kubernetes.io/) to deploy and host your own runners on the cluster to run jobs in your [GitHub Actions](https://github.com/features/actions) workflows. It makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. \n\n##  Why Kubeact? 🧐\n\nKubeact sets up a self-hosted runner on the cluster. Self-hosted runners offer more control of hardware, operating system, and software tools than GitHub-hosted runners provide. With self-hosted runners, you can choose to create a custom hardware configuration with more processing power or memory to run larger jobs, install software available on your local network, and choose an operating system not offered by GitHub-hosted runners.\nYou can read more about self-hosted runner [here](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners).\n\n\u003e **Note**: Currently kubeact supports machines with Linux X64 architecture.\n\n## Prerequisites ✅\n\n**Helm**\n\nEnsure you have [Helm](https://helm.sh/) installed. It is a package manager for Kubernetes which will be required to install the chart.\n\n**Docker**\n\nThis repository contains a [Dockerfile](Dockerfile) by which you can build your own personal runner image, which will be pulled while installing the helm chart. You can follow the official Docker installation guide [here](https://docs.docker.com/install/).\n\n**Github personal access token**\n\nThe [Dockerfile](Dockerfile) requires Github personal access token during build for the admin access to the repository and to configure the runner. You can create a personal access token by following this [tutorial](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).\n\n ## Usage ⚙️\n\n**Build your runner image**\n\nLogin into your docker account, Run:\n```sh\n$ docker login --username=yourUserName --email=yourUserName@example.com\n```\nRun the following command to build your own runner image:\n\n```sh\n$ docker build \\\n  -t yourUserName/kubeact:tagname \\\n  --build-arg GITHUB_ACCESS_TOKEN=XXXXXXXXXXXXXX \\\n  --build-arg GITHUB_USERNAME=\u003c Your Github Username \u003e \\\n  --build-arg GITHUB_REPO_NAME=\u003c Your target Github repo name \u003e  .\n```\n\nPush the image into your registry:\n\n```sh\n$ docker push yourUserName/kubeact:tagname\n```\n\n\u003e **Warning**: It is adviced to push the image into a private registry as it contains files that contains your sensitive informations.\n\n**Install the Helm chart**\n\nOpen [values.yaml](values.yaml) and update the following values :\n\n***Chart Values***\n\n| Key | Type | Default | Description |\n|-----|------|---------|-------------|\n| image.name | string | `\"kubeact\"` | Name of your image. |\n| image.username | string | `nil` | Your Docker registry username. |\n| image.password | string | `nil` | Your Docker registry password. |\n| image.pullPolicy | string | `\"IfNotPresent\"` | Image pull policy. |\n| image.registry | string | `\"https://index.docker.io/v1/\"` | Your registry server. |\n| image.tag | string | `\"latest\"` | Your Image tag. |\n\nRun the following command to install the chart to your kubernetes cluster:\n\n```sh\n$ helm install kubeact .\n```\n\u003e **Note**: You can also update the values using --set flag.\n\n# Contributing 🍻\n\nI welcome pull requests, bug fixes and issue reports. Before proposing a change, please discuss your change by raising an issue.\n\n# Maintainer 😎\n\n[Kumar Saurabh](https://in.linkedin.com/in/itsksaurabh)\n\n## License\n\n[Apache License 2.0](LICENSE) © Kumar Saurabh\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsksaurabh%2Fkubeact","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsksaurabh%2Fkubeact","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsksaurabh%2Fkubeact/lists"}