package platform // Identity constants and the Params that parameterise the install bundle. // // The label and SA-name constants are PINNED here because three independent // things must agree on them and there is no cluster to catch a disagreement at // runtime: (1) the control-plane Deployments that carry the pod labels and run // as these SAs, (2) the NetworkPolicy peers that select the RCON callers by those // labels, and (3) the RoleBindings whose subjects name those SAs. Changing a // value here is a deliberate, test-guarded act. // Recommended-label keys (the app.kubernetes.io/* set) applied to control-plane // objects. We select on Component + PartOf in the RCON NetworkPolicy, so these // must stay stable: a NetworkPolicy peer match is a plain string compare, and a // renamed value silently stops matching the pods it is meant to admit. const ( LabelName = "app.kubernetes.io/name" LabelComponent = "app.kubernetes.io/component" LabelPartOf = "app.kubernetes.io/part-of" appName = "felis" controlPlanePartOf = "felis-control-plane" // Component values distinguish the three control-plane workloads. The RCON // policy admits only {api, operator}; reaper never opens an RCON connection, // so it is deliberately excluded. ComponentAPI = "api" ComponentOperator = "operator" ComponentReaper = "reaper" // ComponentRegistry labels the in-cluster image registry. It is deliberately // NOT part-of=felis-control-plane: the registry is a supporting workload, not // a control-plane identity, so the RCON NetworkPolicy peer (which requires // part-of=felis-control-plane) can never select it. ComponentRegistry = "registry" ) // Service-account names. The control-plane SAs (api/operator/reaper) are bound to // the namespaced Roles in this package; the weak Job SAs (build/restore) have NO // Role anywhere — their isolation is the absence of any binding (spec §16, §21). const ( SAAPI = "felis-api" SAOperator = "felis-operator" SAReaper = "felis-reaper" SABuild = "felis-build" SARestore = "felis-restore" ) // Default namespaces. They match the defaults used elsewhere in the tree // (config.defaultNamespace = "minecraft", build/restore package defaults) so an // unconfigured deployment is internally consistent. const ( DefaultControlNamespace = "felis" DefaultMinecraftNamespace = "minecraft" DefaultBuildNamespace = "felis-build" DefaultPanelNodePort = int32(30443) defaultRegistryPort int32 = 5000 // defaultRegistryImage is the upstream CNCF Distribution registry. It is an // official, stable image and the only registry implementation the build/restore // subsystems are exercised against (registry..svc:5000). defaultRegistryImage = "registry:2" ) // Params parameterises the install bundle. Namespaces and the registry location // have safe defaults; VelocityCIDRs has none — see the field comment. type Params struct { // ControlNamespace is where felis-api/operator run; their SAs live here and the // RoleBindings' subjects reference them here, even though the Roles they bind to // live in the minecraft (and build) namespaces. The reaper alone runs — CronJob // and SA — in the Minecraft namespace, because a Pod can only mount a PVC and // use a ServiceAccount from its own namespace, and its backup PVC is there. ControlNamespace string // MinecraftNamespace is where MinecraftServer workloads, their RCON Secrets, // and their world PVCs live. All three identities' minecraft-scoped Roles, and // every server NetworkPolicy, are installed here. MinecraftNamespace string // BuildNamespace is where image-build Jobs run under the weak felis-build SA, // with the egress-locked NetworkPolicy. BuildNamespace string // VelocityCIDRs are the Velocity proxy source addresses permitted to reach // server game ports (25565) as ipBlock peers. The bootstrap proxy runs on the // k3s node; other deployments may use a separate host. Kubernetes always permits // resident-node traffic independently of NetworkPolicy, so this list constrains // non-node sources. It has NO default, and the `felis manifests` generator // refuses to emit a bundle without an explicit proxy placement. VelocityCIDRs []string // RegistryNamespace / RegistryPort locate the in-cluster image registry the // build egress policy may reach (spec §16). RegistryNamespace defaults to the // control namespace (registry co-located with the control plane). RegistryNamespace string RegistryPort int32 // PanelNodePort exposes the built-in HTTPS panel/API origin from the node. // It defaults to 30443 so a fresh setup can finish with a concrete browser URL. PanelNodePort int32 // PackageSourceCIDRs is the explicit package-mirror egress allowlist for build // Pods (spec §16). Empty means no internet egress at all — the locked-down // default the build subsystem already enforces. PackageSourceCIDRs []string // FelisImage is the container image the felis-api and felis-operator // Deployments run (the multi-call `felis` binary). It has NO default and no // safe guess: `felis manifests` REQUIRES --felis-image and refuses to render // without it, the same fail-loud contract as --velocity-cidr. The api pod also // passes this value through as FELIS_IMAGE so the restore executor launches its // `felis restore` Job using the very same image. FelisImage string // RegistryImage is the in-cluster registry image. Defaults to registry:2. RegistryImage string // BackupPVC is the name of the backup PersistentVolumeClaim the felis-api pod // advertises to its restore executor via FELIS_BACKUP_PVC. It is OPTIONAL: with // no backup PVC the restore endpoint degrades to 503 (cmd/felis/api.go), so the // env var is rendered only when this is set. It must name the same PVC that the // felis.toml archive.local_path is the mount path for, but that agreement lives // in the out-of-band config Secret and cannot be enforced by the manifest. The // reaper CronJob (when rendered) mounts this same PVC read-write to write // archives into it — see WorldsHostPath / ArchiveLocalPath. BackupPVC string // WorldsHostPath is the node directory under which each server's world PVC is // visible as / — the on-disk root the reaper CronJob mounts // (read-only) at /worlds to archive idle worlds before reclaiming them (spec §18, // §19 tarLocal-on-local-path starter). It has NO default and is the master switch // for retention: empty ⇒ the reaper CronJob is NOT rendered (fail-safe — no // CronJob is far safer than one that deletes PVCs while reading worlds from the // wrong place). A hostPath ties the reaper to a single node, which is exactly the // §19 starter topology (the operator provisions per-server ReadWriteOnce world // PVCs, so a shared RWX worlds mount would contradict it); multi-node retention is // a later storage evolution. Setting it REQUIRES BackupPVC and ArchiveLocalPath // too — `felis manifests` enforces the trio (fail-loud). // // SHAPE-ASSERTED, runtime-unverified, and ARRANGEMENT-DEPENDENT: the reaper's // resolver looks for /. Stock local-path-provisioner lays volumes out // under PV-name paths (…/pvc-__/), NOT /, so this mount // only finds worlds if the operator/storage is deliberately arranged to expose // them as /. The rendered CronJob is the correct K8s object; whether // the tar finds a world on a given cluster is not provable without one. WorldsHostPath string // ArchiveLocalPath is the path the backup PVC is mounted at inside the reaper // CronJob's pod, and MUST equal felis.toml's [archive] local_path. tarLocal writes // archive refs as absolute paths under [archive] local_path (internal/backup), and // the restore Job mounts the backup PVC at that same path so the stored ref // resolves (cmd/felis/api.go restoreConfig). `felis manifests` cannot read the // out-of-band config Secret, so this path is supplied explicitly and documented as // must-match. It is reaper-only and has no default; empty (with WorldsHostPath set) // is rejected fail-loud by the generator. ArchiveLocalPath string } // withDefaults returns a copy of p with zero namespace/registry fields filled. // VelocityCIDRs and PackageSourceCIDRs are intentionally left as-is: their empty // states are meaningful (fail-closed game policy, no-internet build policy). func (p Params) withDefaults() Params { if p.ControlNamespace == "" { p.ControlNamespace = DefaultControlNamespace } if p.MinecraftNamespace == "" { p.MinecraftNamespace = DefaultMinecraftNamespace } if p.BuildNamespace == "" { p.BuildNamespace = DefaultBuildNamespace } if p.RegistryNamespace == "" { p.RegistryNamespace = p.ControlNamespace } if p.RegistryPort == 0 { p.RegistryPort = defaultRegistryPort } if p.PanelNodePort == 0 { p.PanelNodePort = DefaultPanelNodePort } if p.RegistryImage == "" { p.RegistryImage = defaultRegistryImage } return p } // controlPlanePodLabels is the recommended-label set stamped on a control-plane // workload of the given component. The NetworkPolicy RCON peer selects on the // PartOf + Component subset, so the labels here and the selector there are one // source of truth. func controlPlanePodLabels(component string) map[string]string { return map[string]string{ LabelName: appName, LabelComponent: component, LabelPartOf: controlPlanePartOf, } }