gha-runner-scale-set: support Google Cloud Secret Manager as a vault for GitHub credentials
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
Research direction
Start with vault/vault.go and vault/azurekeyvault/ to understand the provider interface and existing integration. Trace the secret resolver, listener configuration, and chart values and templates named in the issue, then add coverage for fetching and resolving credentials from Google Cloud Secret Manager. Done means both controller and listener can use the configured provider with ADC, and the chart and tests cover the proposed configuration.
Written by the indexing model from the issue text.
Description
What would you like added?
A second vault type for gha-runner-scale-set, gcp_secret_manager, next to the existing azure_key_vault from #4090. It would let the controller and listener read GitHub App or PAT credentials from Google Cloud Secret Manager, so they never have to be stored in a Kubernetes Secret.
Proposed chart values, mirroring azure_key_vault:
githubConfigSecret: gha-runners-app # lookup key = Secret Manager secret ID
keyVault:
type: gcp_secret_manager
gcp_secret_manager:
project_id: my-project
# optional, defaults to "latest"
# version: latest
Authentication would use Google Application Default Credentials. On GKE that means Workload Identity Federation: the controller and listener Kubernetes ServiceAccounts are granted roles/secretmanager.secretAccessor on the secret, with no key files or certificates mounted. That is simpler than the certificate-based Azure setup. Outside GKE, ADC still works with a mounted credentials file.
The existing design looks like it already supports this:
vault.Vaultis a single-method interface (GetSecret(ctx, name)), so a provider would be a small package next tovault/azurekeyvault.- The rest would be:
- a new
VaultTypeconstant; - a
GCPSecretManagerConfigfield inVaultConfig; - wiring in the secret resolver and the listener config;
- chart values and templates;
- tests.
- a new
- The secret value would use the same format as today. The resolver already parses it provider-independently with
appconfig.FromJSONString: a JSON document withgithub_app_id,github_app_installation_idandgithub_app_private_key, orgithub_token.
This is controller-side and opt-in, like Azure Key Vault. It doesn't add cloud tooling to the runner image.
Why is this needed?
On GKE today, the only way to give ARC GitHub App credentials is a Kubernetes Secret. With a Kubernetes Secret, the controller also copies the full App config, including the private key, into the listener config Secret. For teams that keep credentials in Secret Manager and don't want long-lived keys in etcd, the only options are workarounds:
- Sync the secret into Kubernetes (External Secrets Operator, or GKE Secret Sync). The private key still ends up in two Kubernetes Secrets.
- An additional cronjob: a CronJob reads the App key from Secret Manager through Workload Identity, mints a 1-hour installation token, and writes only that token into the ARC Secret. It keeps the key out of Kubernetes. However:
- the listener only picks up a new token when it restarts, so it fails and is recreated when its copy expires (at most once an hour);
- it is extra machinery that every GKE user would have to reinvent.
#4090 solved exactly this for Azure ("users who don't want to use Kubernetes secrets with GitHub PAT or App credentials"). GKE users have the same need.
Additional context
- Prior work: #4090 (Azure Key Vault integration),
vault/vault.go,vault/azurekeyvault/. - Same scope as #4090: proxy credentials, the listener configuration and runner JIT tokens stay in Kubernetes Secrets. Only the GitHub credentials move to the vault.
- I'm happy to contribute the implementation if maintainers agree with the approach and config shape.
- Dominant language
- Go
- Stars
- 6.7k
- Forks
- 1.5k
- Avg merge
- 1h 34m
- Merged PRs (30d)
- 5
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from actions/actions-runner-controller
-
community enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
actions/actions-runner-controller#3997 · 9 comments · 27 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
actions/actions-runner-controller#4739 · 1 comment · 4 reactions ·
Maintainers usually reply within 1 day
-
Controller upgrade cancels jobs that started shortly before their runner set is deletedMay be free again @ankit373 claimed this 9 days ago, and no pull request is open. Open
Difficulty 4/5 3-5 days Newbie friendliness 45/100
actions/actions-runner-controller#4736 · 2 comments ·
Maintainers usually reply within 1 day
-
EphemeralRunnerSet controller creates more runners than `spec.replicas` when its cache lags its own createsPossibly taken @jia-pylon claimed this 14 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 30/100
actions/actions-runner-controller#4734 · 1 comment ·
Maintainers usually reply within 1 day
-
EphemeralRunnerSet creates more EphemeralRunners than `spec.replicas` on scale up (stale cache, no create expectations)Possibly taken @yaronr claimed this 29 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 55/100
actions/actions-runner-controller#4722 · 1 comment ·
Maintainers usually reply within 1 day
All issues in actions/actions-runner-controller
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
mozilla-ai/cq#601 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day