Repository navigation
docs: localgateway and certserver designs describe the internal API for data-plane config - #1540
Merged
Merged
Conversation
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
requested changes
Nov 21, 2026
justinsb
left a comment
Collaborator
There was a problem hiding this comment.
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.
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.- 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". - Padding. Remove "utilizing GARI's authenticated internal API pipeline".
justinsb
approved these changes
Nov 22, 2026
justinsb
approved these changes
Nov 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1539