Directories
¶
| Path | Synopsis |
|---|---|
|
Package api serves the read-only JSON API (design §7), the probes and the SPA.
|
Package api serves the read-only JSON API (design §7), the probes and the SPA. |
|
Package app wires the backend together.
|
Package app wires the backend together. |
|
Package audit writes Snellius audit records as JSON lines and tags each request with an ID.
|
Package audit writes Snellius audit records as JSON lines and tags each request with an ID. |
|
auth
|
|
|
oidc
Package oidc holds the OpenID Connect settings and discovery for secure-mode sign-in.
|
Package oidc holds the OpenID Connect settings and discovery for secure-mode sign-in. |
|
sar
Package sar authorises each signed-in user's view by asking the API server SubjectAccessReviews, through a per-identity cache (design §6, D-091, D-100).
|
Package sar authorises each signed-in user's view by asking the API server SubjectAccessReviews, through a per-identity cache (design §6, D-091, D-100). |
|
session
Package session holds secure-mode sessions: the server side of a signed-in browser, its identity refresh, and the /auth/me and /auth/logout routes.
|
Package session holds secure-mode sessions: the server side of a signed-in browser, its identity refresh, and the /auth/me and /auth/logout routes. |
|
Package cache keeps a shared, read-only informer cache of the kinds the UI watches and exposes it as immutable snapshots.
|
Package cache keeps a shared, read-only informer cache of the kinds the UI watches and exposes it as immutable snapshots. |
|
Package cli parses the flags the snellius binaries share, so the default, core-only and downstream binaries cannot drift apart.
|
Package cli parses the flags the snellius binaries share, so the default, core-only and downstream binaries cannot drift apart. |
|
Package collect holds the values long-running collectors publish between recomputes (design §4.1 gap 2).
|
Package collect holds the values long-running collectors publish between recomputes (design §4.1 gap 2). |
|
Package computed is the seam for the UI's computed views (D-020): the rule interface, its inputs and results, and the states a cross-check reports.
|
Package computed is the seam for the UI's computed views (D-020): the rule interface, its inputs and results, and the states a cross-check reports. |
|
kgw23
Package kgw23 is the rule set for kgateway 2.3 controllers (rules §2).
|
Package kgw23 is the rule set for kgateway 2.3 controllers (rules §2). |
|
kgw24
Package kgw24 is the rule set for kgateway 2.4 controllers (rules §2).
|
Package kgw24 is the rule set for kgateway 2.4 controllers (rules §2). |
|
kgw25
Package kgw25 is the rule set for kgateway 2.5 controllers (rules §2).
|
Package kgw25 is the rule set for kgateway 2.5 controllers (rules §2). |
|
kgwbackend
Package kgwbackend is the kgateway pack's judgement of a kgateway Backend from its Accepted condition (Phase 6 design §11).
|
Package kgwbackend is the kgateway pack's judgement of a kgateway Backend from its Accepted condition (Phase 6 design §11). |
|
rulesets
Package rulesets selects the computed rule set for a controller version (rules §2).
|
Package rulesets selects the computed rule set for a controller version (rules §2). |
|
viewa
Package viewa computes view A, spec-level Gateway API attachment (D-020 (A), rules §4): sectionName and port, allowedRoutes namespaces and kinds, and hostname intersection.
|
Package viewa computes view A, spec-level Gateway API attachment (D-020 (A), rules §4): sectionName and port, allowedRoutes namespaces and kinds, and hostname intersection. |
|
Package ctrllogs reads controller logs when the user opts in, and keeps only fixed fields (design §8.9, D-037).
|
Package ctrllogs reads controller logs when the user opts in, and keeps only fixed fields (design §8.9, D-037). |
|
ctrllogstest
Package ctrllogstest serves controller logs for benchmarks and scale tests: a ctrllogs.Source whose follow streams write marked lines at a fixed rate.
|
Package ctrllogstest serves controller logs for benchmarks and scale tests: a ctrllogs.Source whose follow streams write marked lines at a fixed rate. |
|
Package ctrlmetrics scrapes and interprets the kgateway controller's Prometheus metrics.
|
Package ctrlmetrics scrapes and interprets the kgateway controller's Prometheus metrics. |
|
Package diagnose groups an install's findings by shared cause and ranks the groups, so the worst and widest problem comes first (design §5.2, §5.3).
|
Package diagnose groups an install's findings by shared cause and ranks the groups, so the worst and widest problem comes first (design §5.2, §5.3). |
|
Package endpoints reads one Service's endpoints on request (design §9.3).
|
Package endpoints reads one Service's endpoints on request (design §9.3). |
|
Package engine computes the UI's model from the cache, the collected values and the registered checks, when triggers or deadlines call for it (D-019).
|
Package engine computes the UI's model from the cache, the collected values and the registered checks, when triggers or deadlines call for it (D-019). |
|
Package explore builds the per-install index of routes, Gateways and ListenerSets that the explorer serves (design §3.2, §3.5).
|
Package explore builds the per-install index of routes, Gateways and ListenerSets that the explorer serves (design §3.2, §3.5). |
|
Package extension is the public seam through which downstream distributions extend the UI backend without forking it (D-003).
|
Package extension is the public seam through which downstream distributions extend the UI backend without forking it (D-003). |
|
Package health turns cluster state and controller signals into findings and a health state per install (design §5).
|
Package health turns cluster state and controller signals into findings and a health state per install (design §5). |
|
internal/twin/health
Package health holds a type whose short name matches one in the health package's tests, so deepPrint's type identity can be tested.
|
Package health holds a type whose short name matches one in the health package's tests, so deepPrint's type identity can be tested. |
|
own
Package own produces own-object findings (D-106): findings decided only by their resource and the objects it names, given the install context.
|
Package own produces own-object findings (D-106): findings decided only by their resource and the objects it names, given the install context. |
|
Package install discovers kgateway controller installs, resolves the namespace scope each one watches, and assigns resources to installs.
|
Package install discovers kgateway controller installs, resolves the namespace scope each one watches, and assigns resources to installs. |
|
Package kgateway holds the parts of the kgateway pack: its kinds, detector, checks and per-install hooks.
|
Package kgateway holds the parts of the kgateway pack: its kinds, detector, checks and per-install hooks. |
|
Package kinds describes the Kubernetes resource kinds the UI understands and resolves which of them the cluster actually serves.
|
Package kinds describes the Kubernetes resource kinds the UI understands and resolves which of them the cluster actually serves. |
|
Package limits counts hits on Snellius's own size limits and logs them, rate-limited, so operators can spot capacity problems or abuse (D-100, D-112).
|
Package limits counts hits on Snellius's own size limits and logs them, rate-limited, so operators can spot capacity problems or abuse (D-100, D-112). |
|
Package objects provides typed, read-only views over unstructured Gateway API and kgateway objects.
|
Package objects provides typed, read-only views over unstructured Gateway API and kgateway objects. |
|
Package obs is a dependency-free metrics registry that serves the Prometheus text exposition format 0.0.4.
|
Package obs is a dependency-free metrics registry that serves the Prometheus text exposition format 0.0.4. |
|
Package overview builds the install page's header, count tiles and gateway list.
|
Package overview builds the install page's header, count tiles and gateway list. |
|
Package paths builds the path model of Phase 6 (design §4): one row per way traffic can flow from a Gateway listener through a route rule to a backend.
|
Package paths builds the path model of Phase 6 (design §4): one row per way traffic can flow from a Gateway listener through a route rule to a backend. |
|
Package platform names the platform a provider runs on and the capabilities it offers.
|
Package platform names the platform a provider runs on and the capabilities it offers. |
|
Package process is the process seam (D-016, D-029): providers report an install's controller and proxy processes; Kube is the Kubernetes one.
|
Package process is the process seam (D-016, D-029): providers report an install's controller and proxy processes; Kube is the Kubernetes one. |
|
Package proxymode decides whether the controller runs a Gateway's proxy as a Deployment or the Gateway is self-managed (design §14.3 H5).
|
Package proxymode decides whether the controller runs a Gateway's proxy as a Deployment or the Gateway is self-managed (design §14.3 H5). |
|
Package proxystats reads Envoy stats from each Gateway proxy's stats listener (design §8.8, D-037).
|
Package proxystats reads Envoy stats from each Gateway proxy's stats listener (design §8.8, D-037). |
|
Package scopeverify checks that the UI's view of an install's scope matches what the controller itself reports (D-009 §3).
|
Package scopeverify checks that the UI's view of an install's scope matches what the controller itself reports (D-009 §3). |
|
Package setup builds the cache and engine configuration the UI runs on, for callers that run the engine themselves, such as a one-shot CLI (D-053).
|
Package setup builds the cache and engine configuration the UI runs on, for callers that run the engine themselves, such as a one-shot CLI (D-053). |
|
Package trigger carries coalescing "something changed" notifications from event sources to the recompute scheduler (D-019).
|
Package trigger carries coalescing "something changed" notifications from event sources to the recompute scheduler (D-019). |
|
Package version holds the build version of the binary.
|
Package version holds the build version of the binary. |
Click to show internal directories.
Click to hide internal directories.