gameplane / docs
ADMINISTRATION

Platform settings, telemetry, and build info

Maintain instance identity and defaults, review the telemetry tiers and opt-out, and capture exact build data for support.

Audit & Observabilityv0.212 MIN
External URL changes affect OIDC and integrations

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.

General instance settings

Keep instance name, canonical external URL, and default namespace stable and environment-specific.

Use a name that distinguishes environments and clusters (optional)The instance name is optional. When set, it names this install on the Cluster page and in notifications, so admins running several installs can tell them apart. When blank, notifications say "Gameplane" and the Cluster page shows the cluster ID.
Coordinate redirect URLs before changing the canonical external URLOIDC and webhook integrations depend on exact URL matching. Update your identity provider, integrations, and browser bookmarks before saving a new external URL.
Verify RBAC, quota, storage, and network policy in the default namespaceThe default namespace holds the control plane and game server resources. Ensure it has correct access policies, resource limits, and networking configuration before production.

Telemetry and privacy

Usage telemetry is on by default for new installs and is not a substitute for operational metrics and logs. Reports go to the project’s provider at telemetry.gameplane.net unless the operator chose another destination or disabled telemetry. The project’s data-handling statement lists exactly what is collected and how long it is kept.

On a new install the first admin to sign in sees a notice naming the destination and both tiers; nothing is sent until an admin has seen it. Admin Settings > Telemetry then shows the destination, a preview of the next report, the last attempt, separate switches for the basic and extended tiers, and an install-ID reset. Turning basic off turns extended off with it.

Basic sends only the Gameplane version, the GameServer count and the GameTemplate count. Extended adds a random install ID, the Kubernetes minor version, a distribution category, CPU architectures and a node-count band, server counts per official module (custom modules are one combined count), feature adoption flags and bands, the database kind, the UI language, a public signing key and the send time. Every value comes from a fixed set or is a number; names, namespaces, hostnames, addresses and player data are never sent.

Choose the tiers deliberatelyBasic and extended have separate switches. Turn extended off to keep only the version and the two counts, or turn both off to send nothing. Resetting the install ID gives the install a new, unlinkable ID and signing key.
Operators can disable or redirect telemetry at install timeSet `api.telemetry.enabled=false` for a hard off that no admin switch can override (the switches are shown as unavailable and no notice appears). Set `api.telemetry.endpoint` to send reports to your own receiver instead of the project's. See the Helm values reference and the air-gapped guide.
Recheck the saved choice after upgradesInstalls that never saved a choice stay off after an upgrade; installs that had basic on keep basic and get extended only when an admin turns it on. After updating, confirm the setting matches your policy.
Document any required organizational privacy reviewIf your organization requires a privacy review, use the data-handling statement and the field list above; the provider keeps daily aggregates for 24 months and per-install activity records for 90 days.

Updates and About

Update channel comes from Helm; record version, Kubernetes version, and license before troubleshooting or upgrading.

The Dashboard’s Settings → About card displays the current Gameplane version (from the container image tag, set via Helm image.tag), the Kubernetes cluster version, and a fixed license identifier (AGPL-3.0). This information is useful for support diagnostics and version-specific feature eligibility.

  • Version: The image tag set at install time or on upgrade. Leave empty in Helm values to use the chart’s appVersion.
  • Kubernetes version: Your cluster’s API server version, visible in Dashboard Settings → About and via kubectl version.

Before opening a support ticket or upgrading:

  1. Record your Helm chart version, image.tag, and any custom values.yaml overrides
  2. Confirm the Kubernetes version your cluster is running
  3. Note the exact Gameplane version and license shown in Dashboard Settings → About
  4. If filing an issue, include these details to help narrow down version-specific bugs

PLATFORM RECORD

01   Stable instance name + canonical URL + intentional namespace
02   Telemetry tiers chosen on purpose (or disabled at install); operational monitoring remains separate
03   Record chart/image-tag/Kubernetes/values before support or upgrade
NEXT GUIDETelemetry provider on Kubernetes