Skip to content

docs: localgateway and certserver designs describe the internal API for data-plane config - #1540

Merged
justinsb merged 4 commits into
gke-labs:mainfrom
codebot-robot:issue_1539
Nov 22, 2026
Merged

justinsb merged 4 commits into
gke-labs:mainfrom
codebot-robot:issue_1539

Conversation

@codebot-robot

@codebot-robot codebot-robot commented Nov 21, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes #1539

Update localgateway/docs/design.md to reflect that data planes receive their configuration over a TLS stream from the controller's internal API rather than from a per-Gateway Secret. Update the controller and data-plane RBAC permissions accordingly, and update the description of singlepod provisioning.

Issue gke-labs#1539
Update certserver/docs/design.md to describe how certificates and private keys travel to data planes over the internal API's TLS stream in phase 1, held solely in process memory without being written to etcd or Kubernetes Secrets.

Fixes gke-labs#1539

@justinsb justinsb left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The facts check out against the code: the controller's certserver source holds keys in memory, the data plane has no local cache, and the token audience is gari-controller. Three things to change.

  1. certserver/docs/design.md, end-state target. This change reorders the two mechanisms and calls direct data-plane retrieval "an alternative release architecture". Which mechanism the end state uses is the maintainer's open decision, and this issue does not make it. Keep the two mechanisms in the order they had, with their wording, and add for each what it gives beyond phase 1: with direct retrieval the controller does not hold keys, and with keyless signing no process in the cluster holds them. The sentence "certserver keeps private keys out of cluster memory entirely" is true of keyless signing only; say that in both places it appears.
  2. Absolutes. "never written to etcd or Secrets" and "held only in process memory" appear four times. Say what the code does and why the claim holds: GARI does not write these keys to etcd, a Secret or disk, because the controller keeps them in memory and sends them on the internal API's stream, and the data plane keeps no local cache. Say it once, in the phase 1 decision, and refer to it elsewhere. In localgateway/docs/design.md, remove the bold from "no Kubernetes RBAC permissions".
  3. Padding. Remove "utilizing GARI's authenticated internal API pipeline".

@codebot-robot codebot-robot removed their assignment Nov 21, 2026
@justinsb justinsb self-assigned this Nov 22, 2026
@justinsb
justinsb merged commit dd980ec into gke-labs:main Nov 22, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: localgateway and certserver designs describe the internal API for data-plane config

2 participants