kcppaths

package
v0.1.4 Latest Latest
Warning

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

Go to latest
Published: Aug 14, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package kcppaths is the single source of truth for the faros kcp workspace topology. It has no internal dependencies so every layer (bootstrap, provisioner, admin, controllers, proxy) can import it without cycles.

Topology:

root:faros
  providers:<provider>        provider sub-workspaces (parent stays universal)
  tenants:<uuid>:<ws>:<edge>  tenant fleet (org/team/edge workspaces)
  system
    controllers               ALL platform APIExports + APIResourceSchemas
    providers                 Provider + CatalogEntry OBJECTS
    tenants                   User/Organization/Membership CR OBJECTS

The naming is symmetric: `providers` + `system:providers` are the provider workspaces vs. their objects; `tenants` + `system:tenants` are the tenant workspaces vs. their objects.

Index

Constants

View Source
const (
	// Root is the faros root workspace.
	Root = "root:faros"

	// ProvidersParent is the parent of per-provider sub-workspaces. It is NOT
	// where APIExports or Provider/CatalogEntry objects live anymore — only the
	// sub-workspaces root:faros:providers:<name> hang off it.
	ProvidersParent = Root + ":providers"

	// TenantsParent is the parent of per-tenant (organization) workspaces. The
	// tenant *fleet* (org/team/edge workspaces) lives here.
	TenantsParent = Root + ":tenants"

	// System groups the platform-internal workspaces.
	System = Root + ":system"

	// SystemControllers holds ALL platform APIExports + APIResourceSchemas
	// (core / faros / tenancy / providers / admin .faros.sh). Every
	// consumer binds the exports from here.
	SystemControllers = System + ":controllers"

	// SystemProviders holds the Provider + CatalogEntry OBJECTS (and the
	// builtin CatalogEntries). The catalog + provisioning controllers target it.
	SystemProviders = System + ":providers"

	// SystemTenants holds the User / Organization / Membership CR OBJECTS
	// (replaces the former root:faros:users). NOT the tenant workspaces.
	SystemTenants = System + ":tenants"
)

Variables

This section is empty.

Functions

func OrgPath

func OrgPath(orgUUID string) string

OrgPath returns the tenant workspace path for an org by UUID: root:faros:tenants:<uuid>.

func ProviderPath

func ProviderPath(name string) string

ProviderPath returns the sub-workspace path for a provider by name: root:faros:providers:<name>.

func WorkspacePath

func WorkspacePath(orgUUID, wsUUID string) string

WorkspacePath returns the team workspace path within a tenant org: root:faros:tenants:<uuid>:<ws>.

Types

This section is empty.

Jump to

Keyboard shortcuts

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