gha-runner-scale-set: support Google Cloud Secret Manager as a vault for GitHub credentials

Đang mở
#4,737 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@mnacharov đang làm issue này rồi.

Từ ngày 18/11/2026.

  • #4748 của @mnacharov — đang mở

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, go, google-cloud, kubernetes
Lĩnh vực
cloud, security

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

community enhancement needs triage
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.Vault is a single-method interface (GetSecret(ctx, name)), so a provider would be a small package next to vault/azurekeyvault.
  • The rest would be:
    • a new VaultType constant;
    • a GCPSecretManagerConfig field in VaultConfig;
    • wiring in the secret resolver and the listener config;
    • chart values and templates;
    • tests.
  • The secret value would use the same format as today. The resolver already parses it provider-independently with appconfig.FromJSONString: a JSON document with github_app_id, github_app_installation_id and github_app_private_key, or github_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.
Ngôn ngữ chính
Go
Star
6.7k
Fork
1.5k
Merge trung bình
1 giờ 34 phút
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của actions/actions-runner-controller

Tất cả issue của actions/actions-runner-controller

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.