Document Task credential secret key format in reference.md

Merged
KE
5mo ago
+31-1

What type of PR is this?

/kind docs

What this PR does / why we need it:

The Task section of docs/reference.md documented spec.credentials.secretRef.name but did not state which key the referenced secret must contain. Users writing TaskSpawner YAML for non-Claude agents (Gemini, Codex, OpenCode, Cursor) had no way to know the expected key without reading internal/controller/job_builder.go or docs/agent-image-interface.md (which targets custom-image authors).

This PR adds a new ### Task Credential Secret Format subsection that mirrors the existing ### Workspace Authentication pattern, with:

  • A table mapping (agent type, credential type) → secret key name (sourced from apiKeyEnvVar / oauthEnvVar in internal/controller/job_builder.go).
  • kubectl create secret examples for claude-code and gemini.
  • A note about credentials.type: none deferring to podOverrides.env.
  • A cross-reference link from the spec.credentials.secretRef.name table row.

Which issue(s) this PR is related to:

Fixes #1160

Special notes for your reviewer:

The keys in the new table are mechanically derived from the existing code in internal/controller/job_builder.go (apiKeyEnvVar lines 138-159, oauthEnvVar lines 163-178); no code changes were needed.

Does this PR introduce a user-facing change?

docs: document the per-agent Kubernetes Secret key format expected by `Task.spec.credentials.secretRef`

Summary by cubic

Document the required Kubernetes Secret key for Task.spec.credentials.secretRef in docs/reference.md so users know which key to set per agent. Adds a new “Task Credential Secret Format” section with a per-agent key map, kubectl create secret examples for claude-code and gemini, a cross-link from the field table, and guidance for credentials.type: none via spec.podOverrides.env.