diff --git a/src/content/docs/air-gapped-installation.mdx b/src/content/docs/air-gapped-installation.mdx index 2a99b6a..94c31bd 100644 --- a/src/content/docs/air-gapped-installation.mdx +++ b/src/content/docs/air-gapped-installation.mdx @@ -13,11 +13,6 @@ covers: ["Mirrors", "Signatures", "Offline"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Mirror every required artifact and trust root, then install and upgrade without hidden public-network dependencies. An offline install is accepted only when rendered manifests contain no public endpoint or mutable tag. Render once and validate before disconnecting from the public internet. diff --git a/src/content/docs/api-crds.mdx b/src/content/docs/api-crds.mdx index 3c3f29a..9698c3e 100644 --- a/src/content/docs/api-crds.mdx +++ b/src/content/docs/api-crds.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Automate Gameplane through Kubernetes resources and scoped identities while keeping desired state, observed status, and audit history aligned. - Controllers own conditions and observed fields; automation should never patch them as desired state. diff --git a/src/content/docs/backup-repository-operations.mdx b/src/content/docs/backup-repository-operations.mdx index b1da73a..fffd2b2 100644 --- a/src/content/docs/backup-repository-operations.mdx +++ b/src/content/docs/backup-repository-operations.mdx @@ -14,9 +14,6 @@ next: production-observability import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - A Backup or BackupSchedule references a repository via a Kubernetes Secret containing the restic repository URI and password. This guide covers supported backends, credential management, operational monitoring, and restore validation drills. diff --git a/src/content/docs/backups-recovery.mdx b/src/content/docs/backups-recovery.mdx index 47b111d..d4972e2 100644 --- a/src/content/docs/backups-recovery.mdx +++ b/src/content/docs/backups-recovery.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Create recoverable snapshots, schedule retention-aware backups, and restore into a new or existing server with a verification plan. - A completed backup is only useful after you have verified its destination, metadata, and restore path. diff --git a/src/content/docs/ci-releases-signing.mdx b/src/content/docs/ci-releases-signing.mdx index deb908b..bde2e00 100644 --- a/src/content/docs/ci-releases-signing.mdx +++ b/src/content/docs/ci-releases-signing.mdx @@ -13,11 +13,6 @@ covers: ["CI", "OCI", "Cosign"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - -Understand the gates from pull request through edge images, tagged releases, Helm publication, and Cosign verification. - - The rolling `:edge` channel is test software; production installs should pin a tagged chart and immutable image digests. diff --git a/src/content/docs/cluster-nodes-kubeconfig.mdx b/src/content/docs/cluster-nodes-kubeconfig.mdx index 28bdd25..a826b0f 100644 --- a/src/content/docs/cluster-nodes-kubeconfig.mdx +++ b/src/content/docs/cluster-nodes-kubeconfig.mdx @@ -12,11 +12,6 @@ covers: ["Nodes", "Kubeconfig", "Join token"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Read node health and capacity, protect administrative access, and add workers only when cluster operations are enabled. Treat kubeconfig files and bootstrap tokens as secrets: keep them out of tickets, chat, logs, and shell history. Downloaded kubeconfigs expire after 1 hour and are bound to a read-only role, but the underlying cluster API access must still be guarded. diff --git a/src/content/docs/cluster-storage.mdx b/src/content/docs/cluster-storage.mdx index f88370c..67af590 100644 --- a/src/content/docs/cluster-storage.mdx +++ b/src/content/docs/cluster-storage.mdx @@ -11,15 +11,10 @@ covers: ["Nodes", "Storage", "Capacity"] next: users-auth-rbac --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; - - -Read Kubernetes health in Gameplane, plan capacity, and choose storage behavior that supports expansion, placement, and disaster recovery. - Node status, StorageClass capabilities, and capacity metrics come from the Kubernetes API. Gameplane surfaces observability; your cluster configuration, hardware, and storage drivers determine what is possible. diff --git a/src/content/docs/console-events-logs.mdx b/src/content/docs/console-events-logs.mdx index 42fb13b..3f65d50 100644 --- a/src/content/docs/console-events-logs.mdx +++ b/src/content/docs/console-events-logs.mdx @@ -13,8 +13,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Trace a server from Kubernetes scheduling through container startup and game readiness, then use the live console without losing diagnostic context. - Events explain why a workload could not start; logs explain what happened after a container started. diff --git a/src/content/docs/contributing.mdx b/src/content/docs/contributing.mdx index 0706ced..12ca801 100644 --- a/src/content/docs/contributing.mdx +++ b/src/content/docs/contributing.mdx @@ -7,11 +7,8 @@ order: 3 icon: users --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import CodeLabel from "../../components/docs/CodeLabel.astro"; - - ## Dev loop make dev-up spins up a local kind cluster with images and the Helm chart already installed. diff --git a/src/content/docs/crd-catalog.mdx b/src/content/docs/crd-catalog.mdx index 6488cc0..7e1f773 100644 --- a/src/content/docs/crd-catalog.mdx +++ b/src/content/docs/crd-catalog.mdx @@ -11,11 +11,8 @@ readTime: 4 MIN covers: ["GameServer", "GameTemplate", "Backup & Restore", "Cluster management", "Module resources"] --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; - - Every Gameplane custom resource lives in the `gameplane.local/v1alpha1` API group. This catalog lists each one, its scope (namespaced or cluster-wide), short name for use with `kubectl`, and its purpose within the platform. ## Workload and recovery resources diff --git a/src/content/docs/credential-rotation.mdx b/src/content/docs/credential-rotation.mdx index 65495b0..ac121ac 100644 --- a/src/content/docs/credential-rotation.mdx +++ b/src/content/docs/credential-rotation.mdx @@ -14,11 +14,6 @@ next: "kubernetes-maintenance" import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Rotate identity, database, registry, backup, signing, webhook, and mTLS material without breaking access or recovery. Do not destroy a backup or signing key until retained recovery points and verification requirements are resolved. diff --git a/src/content/docs/database-configuration.mdx b/src/content/docs/database-configuration.mdx index be543b8..9d34654 100644 --- a/src/content/docs/database-configuration.mdx +++ b/src/content/docs/database-configuration.mdx @@ -14,9 +14,6 @@ next: "multi-cluster" import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - The platform database holds users, roles, sessions, settings, and audit state — isolated from game-world backups. Select a supported topology, secure its connection, control schema migrations, and practice recovery steps independently of your game servers. diff --git a/src/content/docs/database-migrations.mdx b/src/content/docs/database-migrations.mdx index ee55cdc..f82c541 100644 --- a/src/content/docs/database-migrations.mdx +++ b/src/content/docs/database-migrations.mdx @@ -14,11 +14,6 @@ next: "testing-coverage-e2e" import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Change the API store without breaking SQLite-first installs, optional PostgreSQL builds, startup ordering, or rollback safety. Every schema change gets the next ordered transactional file. Never rewrite an already released migration. diff --git a/src/content/docs/executable-upgrades-rollback.mdx b/src/content/docs/executable-upgrades-rollback.mdx index 0aa4a51..a1127f4 100644 --- a/src/content/docs/executable-upgrades-rollback.mdx +++ b/src/content/docs/executable-upgrades-rollback.mdx @@ -11,15 +11,10 @@ covers: ["Migrations", "Canary", "Rollback"] next: uninstall-decommission --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Turn release notes into a staged change plan with compatibility gates, migration ownership, verification evidence, and a safe recovery boundary. - - - Use only the release-specific rollback window. diff --git a/src/content/docs/extension-services.mdx b/src/content/docs/extension-services.mdx index d47f01f..01ef8a3 100644 --- a/src/content/docs/extension-services.mdx +++ b/src/content/docs/extension-services.mdx @@ -14,12 +14,9 @@ next: public-website-development import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; Gameplane ships three optional deployable services plus one shared Go library, all opt-in and off by default. Each is independently deployable, testable, and packaged with its own Helm toggle. - - Optional services remain opt-in and require independent least-privilege RBAC, bounded I/O, health, metrics, and secret-safe logs. diff --git a/src/content/docs/faq.mdx b/src/content/docs/faq.mdx index e9fe646..dc3a73f 100644 --- a/src/content/docs/faq.mdx +++ b/src/content/docs/faq.mdx @@ -11,8 +11,6 @@ eyebrow: DOCUMENTATION import { VERSION } from "../../config"; import Icon from "../../components/Icon.astro"; -Common questions before you deploy Gameplane to your cluster. -
diff --git a/src/content/docs/file-manager.mdx b/src/content/docs/file-manager.mdx index 32e1bf6..1df4178 100644 --- a/src/content/docs/file-manager.mdx +++ b/src/content/docs/file-manager.mdx @@ -13,11 +13,6 @@ covers: ["Browse", "Upload", "Edit"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Browse, create, upload, and edit exposed files without racing the game process or damaging recoverable world data. Save or stop the game and create a fresh backup before changing files it owns at runtime. diff --git a/src/content/docs/files-players-mods.mdx b/src/content/docs/files-players-mods.mdx index 8df575d..00bfa95 100644 --- a/src/content/docs/files-players-mods.mdx +++ b/src/content/docs/files-players-mods.mdx @@ -10,15 +10,12 @@ covers: ["Files", "Players", "Mods"] next: server-configuration --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; The Files, Players & Mods hub guides you through the three core day-to-day administration tasks: managing server files and directories, moderating players online, and installing or updating game mods and modpacks. - - Back up world data before editing live files, changing a modpack, or running irreversible player actions. Use the Backup & Recovery tools to create snapshots before experiments. diff --git a/src/content/docs/gameserver-template-schema.mdx b/src/content/docs/gameserver-template-schema.mdx index 3f2b4f9..fd78edb 100644 --- a/src/content/docs/gameserver-template-schema.mdx +++ b/src/content/docs/gameserver-template-schema.mdx @@ -10,9 +10,6 @@ covers: ["CRD fields", "Server configuration", "Template blueprints"] --- import DocsCallout from "../../components/docs/DocsCallout.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - A **GameServer** is a single running game server instance. A **GameTemplate** is a cluster-scoped blueprint defining the container image, ports, console protocol, and configuration schema that servers instantiate. diff --git a/src/content/docs/general-server-settings.mdx b/src/content/docs/general-server-settings.mdx index 3b75c2a..b5e69f6 100644 --- a/src/content/docs/general-server-settings.mdx +++ b/src/content/docs/general-server-settings.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Manage stable identity, useful operator metadata, and image selection while understanding which values require replacement. - An image override bypasses the template default. Pin it only for a tested exception with a rollback path. diff --git a/src/content/docs/helm-values-reference.mdx b/src/content/docs/helm-values-reference.mdx index 392197f..9021b79 100644 --- a/src/content/docs/helm-values-reference.mdx +++ b/src/content/docs/helm-values-reference.mdx @@ -11,8 +11,6 @@ covers: ["Helm chart configuration", "Installation settings", "Production values import DocsCallout from "../../components/docs/DocsCallout.astro"; -Production-facing chart settings, accepted types, defaults, and the operational effect of each value. - Use `helm template` or `helm diff` to preview your values before applying them to production. Secret values should always be referenced from Kubernetes Secrets, never committed to version control. diff --git a/src/content/docs/high-availability.mdx b/src/content/docs/high-availability.mdx index 1a94c80..aa9505b 100644 --- a/src/content/docs/high-availability.mdx +++ b/src/content/docs/high-availability.mdx @@ -11,15 +11,10 @@ covers: ["Replicas", "Failure domains", "RTO"] next: executable-upgrades-rollback --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; - - -Replicate only supported components, remove avoidable single points of failure, and test disruption against explicit objectives. - Edge routing, database, storage, scheduling capacity, and leader behavior must survive the same failure. Merely running two copies without testing the loss of one domain leaves you with two identical failures, not redundancy. diff --git a/src/content/docs/ingress-tls-access.mdx b/src/content/docs/ingress-tls-access.mdx index 3d6e615..9e8eb3a 100644 --- a/src/content/docs/ingress-tls-access.mdx +++ b/src/content/docs/ingress-tls-access.mdx @@ -13,11 +13,6 @@ covers: ["Ingress", "TLS", "OIDC"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Publish the dashboard and API through a trusted HTTPS edge while separating game ports, management traffic, and identity redirects. Dashboard HTTPS and game TCP/UDP exposure are separate interfaces with different owners and security controls. diff --git a/src/content/docs/installation.mdx b/src/content/docs/installation.mdx index 2b27147..811d5ca 100644 --- a/src/content/docs/installation.mdx +++ b/src/content/docs/installation.mdx @@ -12,9 +12,6 @@ covers: ["Helm", "Ingress", "Bootstrap"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Gameplane runs on Kubernetes and deploys via Helm. This guide walks through preparing a cluster, configuring the Helm chart, installing Gameplane, and verifying a working control plane. diff --git a/src/content/docs/kubectl-gitops-recipes.mdx b/src/content/docs/kubectl-gitops-recipes.mdx index 556db69..7b8be69 100644 --- a/src/content/docs/kubectl-gitops-recipes.mdx +++ b/src/content/docs/kubectl-gitops-recipes.mdx @@ -15,8 +15,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Repeatable commands and declarative patterns for inspecting, applying, reconciling, and rolling back Gameplane resources. - Commit desired state, then wait for observedGeneration before declaring a rollout complete. diff --git a/src/content/docs/lifecycle-probes.mdx b/src/content/docs/lifecycle-probes.mdx index 75505fd..ba30d9a 100644 --- a/src/content/docs/lifecycle-probes.mdx +++ b/src/content/docs/lifecycle-probes.mdx @@ -13,11 +13,6 @@ covers: ["Suspend", "Graceful stop", "Health"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Control desired running state, graceful shutdown, and probe timing so slow games recover without restart loops or data loss. Disabling readiness/liveness probes masks underlying failures. If your game crashes frequently, investigate the root cause instead of loosening probe thresholds. diff --git a/src/content/docs/local-development-setup.mdx b/src/content/docs/local-development-setup.mdx index 2a738e4..c3f31ea 100644 --- a/src/content/docs/local-development-setup.mdx +++ b/src/content/docs/local-development-setup.mdx @@ -14,11 +14,6 @@ next: "repository-components" import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Build Gameplane on a host or devcontainer, then run the full stack against kind or a selected remote cluster. Desired state belongs in CRD spec; observed state and conditions belong to controllers. diff --git a/src/content/docs/mod-registry-credentials.mdx b/src/content/docs/mod-registry-credentials.mdx index a1ee50a..f832b53 100644 --- a/src/content/docs/mod-registry-credentials.mdx +++ b/src/content/docs/mod-registry-credentials.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Enable credentialed content registries without leaking keys and understand why a provider appears or remains hidden. - Registry visibility also depends on the game, loader version, and module capabilities you declare. diff --git a/src/content/docs/mods-modpacks.mdx b/src/content/docs/mods-modpacks.mdx index ea34623..6e56594 100644 --- a/src/content/docs/mods-modpacks.mdx +++ b/src/content/docs/mods-modpacks.mdx @@ -15,8 +15,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Install compatible content from registries, approved URLs, uploads, or IDs while keeping every change reproducible. - Validate loader, game version, dependencies, startup, and player joins after any mod install or update. diff --git a/src/content/docs/module-authoring-quickstart.mdx b/src/content/docs/module-authoring-quickstart.mdx index 91cd050..38cc6d4 100644 --- a/src/content/docs/module-authoring-quickstart.mdx +++ b/src/content/docs/module-authoring-quickstart.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Turn a game image into a validated, installable bundle with metadata, a GameTemplate, documentation, and reproducible OCI content. - The source directory is editable; the versioned OCI artifact is the immutable distribution unit. diff --git a/src/content/docs/module-authoring.mdx b/src/content/docs/module-authoring.mdx index 5e1b8eb..d39c8e6 100644 --- a/src/content/docs/module-authoring.mdx +++ b/src/content/docs/module-authoring.mdx @@ -10,15 +10,10 @@ readTime: 12 MIN covers: ["Module format", "OCI artifacts", "Distribution", "Versioning", "Signing"] --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import CodeLabel from "../../components/docs/CodeLabel.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; - - -Package game server templates as signed, versioned OCI artifacts with metadata, config schema, and capabilities. - A **module** is a reusable, versioned game-server blueprint distributed as an OCI artifact. Gameplane hosts modules in registries (official or self-hosted) and lets operators install them into the cluster as `GameTemplate` resources, so game servers on the platform inherit their console protocol, configuration schema, and operational capabilities — backup quiesce, player moderation, and lifecycle management — without any platform-code changes. - -Field-level reference for distributing signed modules, syncing sources, and registering remote Kubernetes clusters. ## Module & ModuleSource diff --git a/src/content/docs/modules-sources.mdx b/src/content/docs/modules-sources.mdx index 365ebc3..9e3fbfa 100644 --- a/src/content/docs/modules-sources.mdx +++ b/src/content/docs/modules-sources.mdx @@ -13,9 +13,6 @@ covers: ["Catalog", "Sources", "OCI"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Modules are the catalog's install unit — this page covers reading the merged catalog and configuring the sources it's built from. diff --git a/src/content/docs/multi-cluster.mdx b/src/content/docs/multi-cluster.mdx index b7bb89a..c5c2fa8 100644 --- a/src/content/docs/multi-cluster.mdx +++ b/src/content/docs/multi-cluster.mdx @@ -14,11 +14,6 @@ covers: ["Clusters", "GitOps", "Migration"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Make cluster boundaries explicit and operate independent environments without implying unsupported scheduling or automatic failover. Share policy through GitOps and SSO; do not share live databases, controller state, or repository credentials across boundaries. diff --git a/src/content/docs/network-automation.mdx b/src/content/docs/network-automation.mdx index bda2c45..f055a0e 100644 --- a/src/content/docs/network-automation.mdx +++ b/src/content/docs/network-automation.mdx @@ -10,15 +10,10 @@ readTime: "12 MIN" covers: ["Services", "CIDRs", "Schedules"] --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Expose game ports intentionally, restrict source networks, and automate recurring maintenance with schedules and health-aware recovery. - - - Review service type, ports, annotations, DNS, and CIDRs together. diff --git a/src/content/docs/notification-sinks.mdx b/src/content/docs/notification-sinks.mdx index a6ba53d..8315ce0 100644 --- a/src/content/docs/notification-sinks.mdx +++ b/src/content/docs/notification-sinks.mdx @@ -13,9 +13,6 @@ covers: ["Alerts", "Secrets", "Delivery"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Gameplane notifies you when servers become unhealthy, recover, or when backups and restores finish. Route these events to Discord, Slack, ntfy, email, or a custom webhook endpoint, then confirm delivery with a test that traverses the real path. diff --git a/src/content/docs/ownership-danger-zone.mdx b/src/content/docs/ownership-danger-zone.mdx index f1cbb07..c024bf7 100644 --- a/src/content/docs/ownership-danger-zone.mdx +++ b/src/content/docs/ownership-danger-zone.mdx @@ -13,9 +13,6 @@ covers: ["Ownership", "RBAC", "Deletion"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Ownership, collaborators, transfer, wipe, and delete are available in v0.2.0-beta.8, where operator-role users can also run them on servers they don't own. From v0.3.0, transferring ownership, editing collaborators, wiping data and deleting a server need the server's owner or an admin. Servers with no recorded owner (for example created with kubectl or GitOps) can then be transferred, wiped or deleted only by an admin. diff --git a/src/content/docs/permission-catalog.mdx b/src/content/docs/permission-catalog.mdx index 486cabe..e4c2051 100644 --- a/src/content/docs/permission-catalog.mdx +++ b/src/content/docs/permission-catalog.mdx @@ -12,8 +12,6 @@ covers: ["RBAC", "Permissions", "Role-based access control"] import DocsCallout from "../../components/docs/DocsCallout.astro"; -The closed permission vocabulary used by API middleware, scoped roles, ownership checks, and administrative surfaces. - ## Server & backup permissions These permissions govern individual game servers and their backups. They are namespaced, meaning they can be scoped to a specific namespace or cluster-wide (`*`). diff --git a/src/content/docs/platform-disaster-recovery.mdx b/src/content/docs/platform-disaster-recovery.mdx index bb598b0..d973fe6 100644 --- a/src/content/docs/platform-disaster-recovery.mdx +++ b/src/content/docs/platform-disaster-recovery.mdx @@ -11,15 +11,10 @@ covers: ["Platform state", "Worlds", "RPO/RTO"] next: "credential-rotation" --- -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; - - -Rebuild Gameplane on a clean cluster from a tested recovery set, then restore platform identity and worlds in a controlled sequence. - A world backup only captures game data. To recover from a platform-wide outage (cluster loss, database corruption, credential compromise), you must also capture and restore Gameplane's own state: release versions, configuration, CRDs, database, encryption keys, identity providers, repository credentials, DNS, TLS certificates, and ownership records. diff --git a/src/content/docs/platform-settings-telemetry.mdx b/src/content/docs/platform-settings-telemetry.mdx index 6c7974a..41e3212 100644 --- a/src/content/docs/platform-settings-telemetry.mdx +++ b/src/content/docs/platform-settings-telemetry.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Maintain instance identity and defaults, make an explicit telemetry choice, and capture exact build data for support. - Changing the canonical external URL updates OIDC redirect URIs, bookmark links, and API webhooks. Coordinate with dependent systems and your identity provider before saving changes. diff --git a/src/content/docs/production-installation.mdx b/src/content/docs/production-installation.mdx index 50b9a6a..bc897c8 100644 --- a/src/content/docs/production-installation.mdx +++ b/src/content/docs/production-installation.mdx @@ -12,11 +12,6 @@ covers: ["Helm", "Security", "Acceptance"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Build a pinned, reviewable release with explicit security, storage, database, access, backup, and telemetry choices. Archive the exact chart, image digests, values, and rendered manifests accepted for each environment. diff --git a/src/content/docs/production-observability.mdx b/src/content/docs/production-observability.mdx index e63061d..eb76dc4 100644 --- a/src/content/docs/production-observability.mdx +++ b/src/content/docs/production-observability.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Connect metrics, logs, events, audit records, and notifications into an actionable signal path with bounded retention. - Every alert needs an owner, duration, severity, notification route, and tested runbook—not just a threshold. diff --git a/src/content/docs/public-website-development.mdx b/src/content/docs/public-website-development.mdx index 19d7367..6b0a52f 100644 --- a/src/content/docs/public-website-development.mdx +++ b/src/content/docs/public-website-development.mdx @@ -14,9 +14,6 @@ next: module-authoring-quickstart import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - The website is a separately versioned submodule; merge there first, then bump the gitlink in the main repository. diff --git a/src/content/docs/remote-agent-gateway.mdx b/src/content/docs/remote-agent-gateway.mdx index 5ae6c02..91bbf17 100644 --- a/src/content/docs/remote-agent-gateway.mdx +++ b/src/content/docs/remote-agent-gateway.mdx @@ -14,9 +14,6 @@ covers: ["Gateway", "mTLS", "Cluster registration", "Troubleshooting"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Run one central Gameplane API and dashboard, plus an operator and an optional gateway in each remote cluster. The gateway proxies approved agent operations over mTLS so the central dashboard can reach consoles, files, players and captures in clusters it does not run in. diff --git a/src/content/docs/runtime-capabilities-actions.mdx b/src/content/docs/runtime-capabilities-actions.mdx index e10337a..f7d1669 100644 --- a/src/content/docs/runtime-capabilities-actions.mdx +++ b/src/content/docs/runtime-capabilities-actions.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Expose only the controls Gameplane can execute and observe reliably through console, logs, status, players, and providers. - - Changes that affect the pod template (image, resources, storage, environment, probes) trigger a rolling restart of the underlying StatefulSet pod. Schedule these updates like planned maintenance to avoid disrupting active player sessions. diff --git a/src/content/docs/server-networking-tunnels.mdx b/src/content/docs/server-networking-tunnels.mdx index 2b54153..c1e11a5 100644 --- a/src/content/docs/server-networking-tunnels.mdx +++ b/src/content/docs/server-networking-tunnels.mdx @@ -11,9 +11,6 @@ covers: ["Tunnels", "Relay", "NAT traversal"] --- import DocsCallout from "../../components/docs/DocsCallout.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Route player connections through an external relay when you lack a public IP, port-forwarding, or a cluster load balancer. A tunnel layers over the server's backing Service; it is not a fifth `expose` mode. Use it only when direct exposure is unavailable. diff --git a/src/content/docs/server-operations.mdx b/src/content/docs/server-operations.mdx index 7e004d8..62d100d 100644 --- a/src/content/docs/server-operations.mdx +++ b/src/content/docs/server-operations.mdx @@ -13,9 +13,6 @@ covers: ["Fleet", "Lifecycle", "Ownership"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - The server index is the fastest way to triage a large fleet by state, game, owner, node, or resource pressure. Learn how to read fleet states, trigger lifecycle actions safely, and trace an alert back to the exact event that caused it. diff --git a/src/content/docs/server-overview.mdx b/src/content/docs/server-overview.mdx index e005ba8..519e27c 100644 --- a/src/content/docs/server-overview.mdx +++ b/src/content/docs/server-overview.mdx @@ -14,11 +14,6 @@ next: "general-server-settings" import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Read desired state, health, capacity, connection endpoint, and live game context before taking an action. Every significant change (restart, scale, configuration update) touches the state machine. Read the phase, conditions, events, and live player count together to understand why a server is in its current state and what actions are safe. diff --git a/src/content/docs/sign-in-recovery.mdx b/src/content/docs/sign-in-recovery.mdx index 153fbfa..ee0f34d 100644 --- a/src/content/docs/sign-in-recovery.mdx +++ b/src/content/docs/sign-in-recovery.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Choose local or federated sign-in, diagnose authentication failures, and recover access without locking out every administrator. - Keep one tested administrative recovery path until SSO-only redirects, claims, and role mappings work end to end. diff --git a/src/content/docs/system-log-viewer.mdx b/src/content/docs/system-log-viewer.mdx index b96c148..4a6b4bb 100644 --- a/src/content/docs/system-log-viewer.mdx +++ b/src/content/docs/system-log-viewer.mdx @@ -15,8 +15,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Follow API and operator output separately, preserve raw evidence, and correlate platform errors with events and audit. - Download raw records before restarting a component or changing the stream filter. diff --git a/src/content/docs/test-publish-sign-modules.mdx b/src/content/docs/test-publish-sign-modules.mdx index b49860b..9335885 100644 --- a/src/content/docs/test-publish-sign-modules.mdx +++ b/src/content/docs/test-publish-sign-modules.mdx @@ -15,8 +15,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Prove a module locally, publish immutable OCI bundles, and use digest pinning and signatures for trustworthy upgrades. - A signature mismatch must leave the Module failed without replacing the last known-good GameTemplate. diff --git a/src/content/docs/testing-coverage-e2e.mdx b/src/content/docs/testing-coverage-e2e.mdx index d3b64b0..4dbdcd7 100644 --- a/src/content/docs/testing-coverage-e2e.mdx +++ b/src/content/docs/testing-coverage-e2e.mdx @@ -12,9 +12,6 @@ covers: ["Unit", "Envtest", "E2E"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Gameplane's test suite spans three tiers: unit tests and Vitest (cheapest), envtest for Kubernetes integration (moderate cost), and kind E2E for full-cluster validation (most expensive). Every real-cluster test lives in exactly one CI bucket to prevent login rate-limiter starvation. diff --git a/src/content/docs/troubleshooting.mdx b/src/content/docs/troubleshooting.mdx index 0836dc0..8fd1142 100644 --- a/src/content/docs/troubleshooting.mdx +++ b/src/content/docs/troubleshooting.mdx @@ -13,11 +13,6 @@ covers: ["Runbooks", "Diagnostics", "Support"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - -Triage failed starts, storage and network faults, login problems, backup failures, and module synchronization with one evidence-first workflow. - - Capture the resource UID, cluster, namespace, time range, events, conditions, and relevant logs before changing state. diff --git a/src/content/docs/uninstall-decommission.mdx b/src/content/docs/uninstall-decommission.mdx index ca9c7c0..aec6d15 100644 --- a/src/content/docs/uninstall-decommission.mdx +++ b/src/content/docs/uninstall-decommission.mdx @@ -14,9 +14,6 @@ next: platform-disaster-recovery import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Removing Gameplane requires careful inventory, explicit decisions on every retained resource, and an uninstall order that respects Kubernetes finalizers and state cleanup. This guide covers retention decisions, safe uninstall sequencing, and verification that no orphaned resources or costs remain. diff --git a/src/content/docs/upgrades-migrations.mdx b/src/content/docs/upgrades-migrations.mdx index eff8d8a..1ecddfa 100644 --- a/src/content/docs/upgrades-migrations.mdx +++ b/src/content/docs/upgrades-migrations.mdx @@ -14,12 +14,9 @@ next: troubleshooting import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; Gameplane releases are pinned with signed container images and strict Kubernetes compatibility. Every upgrade is reversible if planned carefully; every migration is documented in the release notes. - - Do not combine a platform upgrade with unrelated server, storage, authentication, or network changes. Each change introduces risk vectors; combining them makes root-cause analysis impossible when something breaks. diff --git a/src/content/docs/upload-a-module.mdx b/src/content/docs/upload-a-module.mdx index df74c79..9e6893f 100644 --- a/src/content/docs/upload-a-module.mdx +++ b/src/content/docs/upload-a-module.mdx @@ -14,11 +14,6 @@ next: mod-registry-credentials import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - - -Publish a local module bundle into an upload source, validate synchronization, and install the exact version safely. Reject an unexpected digest or policy state. Verify provenance before canary installation. diff --git a/src/content/docs/user-administration.mdx b/src/content/docs/user-administration.mdx index 0cf83cf..b0fe2b6 100644 --- a/src/content/docs/user-administration.mdx +++ b/src/content/docs/user-administration.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Invite and maintain local users, reset credentials, assign roles, and distinguish current capabilities from planned service accounts. - Gameplane has no service accounts or API tokens yet; machine-to-machine tokens are planned for v1.1. Until then, give automation its own local user with the narrowest role that works, and never share a person's login. diff --git a/src/content/docs/users-auth-rbac.mdx b/src/content/docs/users-auth-rbac.mdx index b15318f..3228b15 100644 --- a/src/content/docs/users-auth-rbac.mdx +++ b/src/content/docs/users-auth-rbac.mdx @@ -13,9 +13,6 @@ covers: ["Users", "RBAC", "OIDC"] import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -import DocsArticleMeta from "../../components/docs/DocsArticleMeta.astro"; - - Gameplane's authentication and authorization system combines local user accounts, optional OIDC single sign-on, built-in and custom roles, per-server ownership, and per-namespace role bindings. The model prevents lockout by requiring at least one tested administrative recovery path before enabling OIDC-only mode. diff --git a/src/content/docs/web-dashboard-development.mdx b/src/content/docs/web-dashboard-development.mdx index 12c4801..47a46f2 100644 --- a/src/content/docs/web-dashboard-development.mdx +++ b/src/content/docs/web-dashboard-development.mdx @@ -14,8 +14,6 @@ import DocsCallout from "../../components/docs/DocsCallout.astro"; import DocsSectionList from "../../components/docs/DocsSectionList.astro"; import DocsQuickReference from "../../components/docs/DocsQuickReference.astro"; -Extend the strict TypeScript dashboard without breaking query, routing, API, cluster, or design contracts. - Every cache and request that varies by cluster must include or clear cluster scope to prevent cross-cluster stale data. diff --git a/src/content/docs/websocket-event-streams.mdx b/src/content/docs/websocket-event-streams.mdx index 5c2d200..b26cd5f 100644 --- a/src/content/docs/websocket-event-streams.mdx +++ b/src/content/docs/websocket-event-streams.mdx @@ -12,8 +12,6 @@ covers: ["WebSocket", "Real-time streams", "SSE", "Reconnection", "Permissions"] import DocsCallout from "../../components/docs/DocsCallout.astro"; -Connect to console, logs, and invalidation events with the correct transport, framing, permission, and reconnect behavior. - ## Console and log sockets Game servers expose real-time console and log output via WebSocket. Both require a valid session (Bearer token in the `Authorization` header) and the appropriate permission on the target server.