pkg/

directory
v0.1.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2026 License: Apache-2.0

Directories

Path Synopsis
Package agent implements the faros agent that connects edges to the hub.
Package agent implements the faros agent that connects edges to the hub.
discovery
Package discovery detects HTTP services running on the edge host next to the agent (e.g.
Package discovery detects HTTP services running on the edge host next to the agent (e.g.
reconciler
Package reconciler reconciles workloads on the agent side: it watches the edge's Placements in the tenant workspace and materializes each as a local Deployment.
Package reconciler reconciles workloads on the agent side: it watches the edge's Placements in the tenant workspace and materializes each as a local Deployment.
status
Package status reports agent status back to the hub.
Package status reports agent status back to the hub.
tunnel
Package tunnel implements reverse-dial tunneling between agent and hub.
Package tunnel implements reverse-dial tunneling between agent and hub.
Package apiurl is the single source of truth for all faros service path construction and URL parsing.
Package apiurl is the single source of truth for all faros service path construction and URL parsing.
Package browsersession owns the hub's shared browser login session.
Package browsersession owns the hub's shared browser login session.
cli
auth
Package auth handles OIDC authentication for the CLI.
Package auth handles OIDC authentication for the CLI.
cmd
Package cmd implements the faros CLI commands.
Package cmd implements the faros CLI commands.
cmd/dev/cmd
Package cmd provides the faros dev command and its subcommands.
Package cmd provides the faros dev command and its subcommands.
cmd/dev/plugin
Package plugin provides the implementation for faros dev command plugins.
Package plugin provides the implementation for faros dev command plugins.
Package client provides dynamic Kubernetes client utilities.
Package client provides dynamic Kubernetes client utilities.
hub
Package hub implements the faros hub server.
Package hub implements the faros hub server.
admin
Package admin implements the platform-admin surface mounted at /api/admin/* and surfaced in the portal's gated /bonkers area.
Package admin implements the platform-admin surface mounted at /api/admin/* and surfaced in the portal's gated /bonkers area.
appauth
Package appauth is the hub's login-time authorization endpoint for published applications.
Package appauth is the hub's login-time authorization endpoint for published applications.
bootstrap
Package bootstrap embeds bootstrap resources for hub initialization.
Package bootstrap embeds bootstrap resources for hub initialization.
controllers/mcpserver
Package mcpserver reconciles MCPServer objects.
Package mcpserver reconciles MCPServer objects.
controllers/membershipindex
Package membershipindex implements the UMI invariant reconciler: a controller that watches UserMembershipIndex CRs in root:faros:users and repairs rows that strand a user.
Package membershipindex implements the UMI invariant reconciler: a controller that watches UserMembershipIndex CRs in root:faros:users and repairs rows that strand a user.
controllers/organization
Package organization implements the bootstrap controller that gives every User a personal Organization on creation (per docs/organizations.md §Personal Org).
Package organization implements the bootstrap controller that gives every User a personal Organization on creation (per docs/organizations.md §Personal Org).
controllers/softdelete
Package softdelete implements roadmap step 8: the soft-delete reconciler that honours the 30-day grace window from docs/organizations.md decisions O-8 (User delete) and O-13 (Org + Workspace delete).
Package softdelete implements roadmap step 8: the soft-delete reconciler that honours the 30-day grace window from docs/organizations.md decisions O-8 (User delete) and O-13 (Org + Workspace delete).
kcp
Package kcp bootstraps kcp API resources.
Package kcp bootstraps kcp API resources.
leaderelection
Package leaderelection gates the hub's singleton controllers so a hub scaled to multiple replicas still reconciles each object exactly once.
Package leaderelection gates the hub's singleton controllers so a hub scaled to multiple replicas still reconciles each object exactly once.
mcpaggregate
Package mcpaggregate serves the hub's always-on aggregate MCP endpoint.
Package mcpaggregate serves the hub's always-on aggregate MCP endpoint.
providers
Package providers backs the hub's pluggable-provider extension surface: an in-memory routing table, reverse proxies for /ui/providers/{name}/* and /services/providers/{name}/*, and the controller that keeps the table in sync with ProviderCatalogEntry resources.
Package providers backs the hub's pluggable-provider extension surface: an in-memory routing table, reverse proxies for /ui/providers/{name}/* and /services/providers/{name}/*, and the controller that keeps the table in sync with ProviderCatalogEntry resources.
quota
Package quota implements the quota checks pinned by decisions O-5 (Org quota = soft cap, admin-overridable per User; default 10) and O-6 (Workspace quota = soft cap, admin-overridable per Org; default 50) in docs/organizations.md.
Package quota implements the quota checks pinned by decisions O-5 (Org quota = soft cap, admin-overridable per User; default 10) and O-6 (Workspace quota = soft cap, admin-overridable per Org; default 50) in docs/organizations.md.
restapi
Package restapi implements roadmap step 10: the hub-mediated REST surface for Org / Workspace / Membership / User CRUD per docs/organizations.md decision O-10 ("Org workspaces are hub-mediated only"), plus the undelete actions wired to PR #212's soft-delete reconciler, the self-leave / role PATCH from O-12, and the ?cascade=true shortcut from O-9.
Package restapi implements roadmap step 10: the hub-mediated REST surface for Org / Workspace / Membership / User CRUD per docs/organizations.md decision O-10 ("Org workspaces are hub-mediated only"), plus the undelete actions wired to PR #212's soft-delete reconciler, the self-leave / role PATCH from O-12, and the ?cascade=true shortcut from O-9.
serviceaccounts
Package serviceaccounts implements roadmap step 9 (O-14): bot identity for child Workspaces via native kube `core/v1.ServiceAccount`s marked with faros annotations.
Package serviceaccounts implements roadmap step 9 (O-14): bot identity for child Workspaces via native kube `core/v1.ServiceAccount`s marked with faros annotations.
sharedstore
Package sharedstore is the hub's cross-replica key/value store for short-lived login state: browser sessions and published-app authorization codes.
Package sharedstore is the hub's cross-replica key/value store for short-lived login state: browser sessions and published-app authorization codes.
tenant
Package tenant implements the hub-side tenant middleware described in docs/organizations.md §Switch the active context.
Package tenant implements the hub-side tenant middleware described in docs/organizations.md §Switch the active context.
workloadidentity
Package workloadidentity owns the production provider-action workload capability exchange.
Package workloadidentity owns the production provider-action workload capability exchange.
Package kcppaths is the single source of truth for the faros kcp workspace topology.
Package kcppaths is the single source of truth for the faros kcp workspace topology.
server
auth
Package auth provides server-side OIDC token verification.
Package auth provides server-side OIDC token verification.
proxy
Package proxy reverse-proxies authenticated requests to kcp.
Package proxy reverse-proxies authenticated requests to kcp.
util
confighelpers
Package confighelpers provides bootstrap helpers inspired by github.com/kcp-dev/kcp/config/helpers.
Package confighelpers provides bootstrap helpers inspired by github.com/kcp-dev/kcp/config/helpers.
conncontext
Package conncontext stores and retrieves net.Conn from context.
Package conncontext stores and retrieves net.Conn from context.
identity
Package identity builds the cross-workspace ServiceAccount identity faros authorizes foreign SAs under.
Package identity builds the cross-workspace ServiceAccount identity faros authorizes foreign SAs under.
Package version holds build-time version information injected via ldflags.
Package version holds build-time version information injected via ldflags.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL