From f2e9a4dee778b2d06b5d2627347c035254a21740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hauke=20L=C3=B6ffler?= Date: Tue, 3 Feb 2026 16:56:02 +0100 Subject: [PATCH 1/2] docs: add Armada States documentation and Degraded state troubleshooting --- .../getting-started/armada-states.md | 60 +++++++++++++++++++ .../getting-started/glossary.md | 6 ++ .../getting-started/sidebar.json | 4 ++ 3 files changed, 70 insertions(+) create mode 100644 src/multiplayer-servers/getting-started/armada-states.md diff --git a/src/multiplayer-servers/getting-started/armada-states.md b/src/multiplayer-servers/getting-started/armada-states.md new file mode 100644 index 00000000..d0a8f91b --- /dev/null +++ b/src/multiplayer-servers/getting-started/armada-states.md @@ -0,0 +1,60 @@ +# Armada States + +## Overview + +Armadas in GameFabric can be in different states depending on their current condition. Understanding these states helps you identify and resolve issues with your game server deployments. + +## States + +### Running + +The Armada is operating normally. Game servers are being scheduled and running as expected according to your configured Min/Max Replicas and Buffer settings. + +### Degraded + +A **Degraded** Armada indicates that GameFabric cannot fulfill the requested game server capacity. This typically happens when an Armada is configured to use a Region that has no available Sites. + +Common causes: +- Sites were removed from a Location, but the ArmadaSet still references that Region +- A Location has been decommissioned +- All Sites in a Region are cordoned or unavailable + +::: tip +A Degraded state means "you asked for game servers here, but there's nowhere to place them." +::: + +## Resolving Degraded Armadas After Site Removal + +When Sites are removed from your setup (e.g., after decommissioning a Location), you may see Degraded Armadas in your Armada overview. This is expected behavior. + +### Why doesn't GameFabric clean this up automatically? + +GameFabric intentionally preserves your ArmadaSet region configuration (Min Replicas, Max Replicas, Buffer settings). This design choice ensures: + +- Your configuration is not lost if you plan to add those Locations back later +- No unexpected changes are made to your deployment configuration +- You maintain full control over your ArmadaSet settings + +### How to resolve + +To clear Degraded Armadas, you need to update each affected ArmadaSet to remove the decommissioned regions: + +1. Navigate to the affected ArmadaSet +2. Go to **Settings → Regions** +3. Click **"Clear"** on the regions that were removed +4. Press **Save** +5. Repeat for all affected ArmadaSets across your environments + +Once you've adjusted the region configuration, the Degraded Armadas will no longer appear in your overview. + +::: info +Before clearing the configuration, you may want to note down your current settings (Min/Max Replicas, Buffer) in case you need to restore them later when new Sites are provisioned. +::: + +## Related + +- [Glossary: ArmadaSet](/multiplayer-servers/getting-started/glossary#armadaset) +- [Glossary: Region](/multiplayer-servers/getting-started/glossary#region) +- [Glossary: Site](/multiplayer-servers/getting-started/glossary#site) +- [Setup your Environment](/multiplayer-servers/getting-started/setup-your-environment) +- [Terminating ArmadaSets](/multiplayer-servers/getting-started/terminating-armadasets) diff --git a/src/multiplayer-servers/getting-started/glossary.md b/src/multiplayer-servers/getting-started/glossary.md index 0e2e9da2..8c4fd128 100644 --- a/src/multiplayer-servers/getting-started/glossary.md +++ b/src/multiplayer-servers/getting-started/glossary.md @@ -61,6 +61,12 @@ While a "Cluster" refers to the physical or virtual grouping of servers, a "Site When a [Site](#site) is marked as cordoned, it becomes unschedulable. Allocated game servers continue to run until they shut down, but no new game servers get scheduled on that Site. +## Degraded + +An [Armada](#armada) is marked as Degraded when GameFabric cannot fulfill the requested game server capacity. This typically occurs when the Armada is configured to use a [Region](#region) that has no available [Sites](#site). + +See also [Armada States](/multiplayer-servers/getting-started/armada-states). + ## Environment Environments are a mechanism for isolating groups of resources. Resource names must be unique within each environment, but not across environments. diff --git a/src/multiplayer-servers/getting-started/sidebar.json b/src/multiplayer-servers/getting-started/sidebar.json index 759b7c9f..d16dea88 100644 --- a/src/multiplayer-servers/getting-started/sidebar.json +++ b/src/multiplayer-servers/getting-started/sidebar.json @@ -59,6 +59,10 @@ "text": "Running your Game Server", "link": "/getting-started/running-your-game-server" }, + { + "text": "Armada States", + "link": "/getting-started/armada-states" + }, { "text": "Terminating ArmadaSets", "link": "/getting-started/terminating-armadasets" From 49809f220c333bef44a578be5196335c7054dda5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hauke=20L=C3=B6ffler?= Date: Wed, 4 Feb 2026 10:02:28 +0100 Subject: [PATCH 2/2] docs: rename Armada States to Troubleshooting and fix Degraded state documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename page from "Armada States" to "Troubleshooting" for broader scope - Remove incorrect "Running" state (not a valid Armada state) - Rewrite Degraded definition: sync issue, not just capacity issue - Add three distinct scenarios with actionable steps: - No Sites in Region → clean up ArmadaSet config - Sites unavailable (incident) → check status page - Configuration deployment error → review changes or contact support - List all objects that can be Degraded (Armadas, ArmadaSets, Formations, etc.) - Reframe "Why doesn't GF clean up" to "Why manual cleanup is required" - Update glossary with accurate Degraded definition - Rename file: armada-states.md → troubleshooting.md --- .../getting-started/armada-states.md | 60 ----------------- .../getting-started/glossary.md | 6 +- .../getting-started/sidebar.json | 4 +- .../getting-started/troubleshooting.md | 67 +++++++++++++++++++ 4 files changed, 73 insertions(+), 64 deletions(-) delete mode 100644 src/multiplayer-servers/getting-started/armada-states.md create mode 100644 src/multiplayer-servers/getting-started/troubleshooting.md diff --git a/src/multiplayer-servers/getting-started/armada-states.md b/src/multiplayer-servers/getting-started/armada-states.md deleted file mode 100644 index d0a8f91b..00000000 --- a/src/multiplayer-servers/getting-started/armada-states.md +++ /dev/null @@ -1,60 +0,0 @@ -# Armada States - -## Overview - -Armadas in GameFabric can be in different states depending on their current condition. Understanding these states helps you identify and resolve issues with your game server deployments. - -## States - -### Running - -The Armada is operating normally. Game servers are being scheduled and running as expected according to your configured Min/Max Replicas and Buffer settings. - -### Degraded - -A **Degraded** Armada indicates that GameFabric cannot fulfill the requested game server capacity. This typically happens when an Armada is configured to use a Region that has no available Sites. - -Common causes: -- Sites were removed from a Location, but the ArmadaSet still references that Region -- A Location has been decommissioned -- All Sites in a Region are cordoned or unavailable - -::: tip -A Degraded state means "you asked for game servers here, but there's nowhere to place them." -::: - -## Resolving Degraded Armadas After Site Removal - -When Sites are removed from your setup (e.g., after decommissioning a Location), you may see Degraded Armadas in your Armada overview. This is expected behavior. - -### Why doesn't GameFabric clean this up automatically? - -GameFabric intentionally preserves your ArmadaSet region configuration (Min Replicas, Max Replicas, Buffer settings). This design choice ensures: - -- Your configuration is not lost if you plan to add those Locations back later -- No unexpected changes are made to your deployment configuration -- You maintain full control over your ArmadaSet settings - -### How to resolve - -To clear Degraded Armadas, you need to update each affected ArmadaSet to remove the decommissioned regions: - -1. Navigate to the affected ArmadaSet -2. Go to **Settings → Regions** -3. Click **"Clear"** on the regions that were removed -4. Press **Save** -5. Repeat for all affected ArmadaSets across your environments - -Once you've adjusted the region configuration, the Degraded Armadas will no longer appear in your overview. - -::: info -Before clearing the configuration, you may want to note down your current settings (Min/Max Replicas, Buffer) in case you need to restore them later when new Sites are provisioned. -::: - -## Related - -- [Glossary: ArmadaSet](/multiplayer-servers/getting-started/glossary#armadaset) -- [Glossary: Region](/multiplayer-servers/getting-started/glossary#region) -- [Glossary: Site](/multiplayer-servers/getting-started/glossary#site) -- [Setup your Environment](/multiplayer-servers/getting-started/setup-your-environment) -- [Terminating ArmadaSets](/multiplayer-servers/getting-started/terminating-armadasets) diff --git a/src/multiplayer-servers/getting-started/glossary.md b/src/multiplayer-servers/getting-started/glossary.md index 8c4fd128..5a4af41b 100644 --- a/src/multiplayer-servers/getting-started/glossary.md +++ b/src/multiplayer-servers/getting-started/glossary.md @@ -63,9 +63,11 @@ When a [Site](#site) is marked as cordoned, it becomes unschedulable. Allocated ## Degraded -An [Armada](#armada) is marked as Degraded when GameFabric cannot fulfill the requested game server capacity. This typically occurs when the Armada is configured to use a [Region](#region) that has no available [Sites](#site). +A synchronization state indicating that configuration could not be deployed to one or more [Sites](#site). This can occur when Sites are unavailable, experiencing connectivity issues, or when all capacity in a Location has been deprovisioned. -See also [Armada States](/multiplayer-servers/getting-started/armada-states). +Objects that can be Degraded: [Armada](#armada), [ArmadaSet](#armadaset), [Formation](#formation), Secret, ConfigFile, Protocol, Gateway Policy. + +See also [Troubleshooting](/multiplayer-servers/getting-started/troubleshooting). ## Environment diff --git a/src/multiplayer-servers/getting-started/sidebar.json b/src/multiplayer-servers/getting-started/sidebar.json index d16dea88..a9e1b2b1 100644 --- a/src/multiplayer-servers/getting-started/sidebar.json +++ b/src/multiplayer-servers/getting-started/sidebar.json @@ -60,8 +60,8 @@ "link": "/getting-started/running-your-game-server" }, { - "text": "Armada States", - "link": "/getting-started/armada-states" + "text": "Troubleshooting", + "link": "/getting-started/troubleshooting" }, { "text": "Terminating ArmadaSets", diff --git a/src/multiplayer-servers/getting-started/troubleshooting.md b/src/multiplayer-servers/getting-started/troubleshooting.md new file mode 100644 index 00000000..d851d326 --- /dev/null +++ b/src/multiplayer-servers/getting-started/troubleshooting.md @@ -0,0 +1,67 @@ +# Troubleshooting + +## Degraded state + +The **Degraded** state indicates that GameFabric encountered an issue deploying configuration to one or more Sites, or that no Sites exist for the requested capacity. + +### What can be Degraded? + +Multiple objects in GameFabric can enter a Degraded state: + +- Armadas and ArmadaSets +- Formations +- Secrets and ConfigFiles +- Protocols and Gateway Policies + +### Common causes + +- **No Sites in Region** — All Locations associated with a Region are no longer active or available + - This is most commonly the result of a cancellation request for the related clusters + - Check the Sites view: if Sites are missing or in `Terminating` state, this is likely the cause + - **Action:** Update your ArmadaSet configuration (see [Resolving Degraded Armadas after capacity removal](#resolving-degraded-armadas-after-capacity-removal)) + +- **Sites unavailable (incident)** — Sites exist but GameFabric cannot connect to them + - Sites will also show as Degraded in the Sites view + - This is often temporary and may resolve automatically + - **Action:** Check the [status page](https://status.gamefabric.com/) for ongoing incidents; no configuration change needed + +- **Configuration deployment error** — An issue occurred while deploying configuration to a Site + - **Action:** Review recent configuration changes or contact support + +::: tip +A Degraded state indicates that configuration could not be deployed to one or more Sites. This is often temporary and may resolve automatically when Sites become available again. +::: + +## Resolving Degraded Armadas after capacity removal + +When all Sites in a Location are removed, Armadas created by ArmadaSets referencing that Location will show as Degraded. + +### Why manual cleanup is required + +GameFabric preserves your configuration (Min Replicas, Max Replicas, Buffer settings) rather than automatically removing it. This ensures: + +- Your settings are retained if you plan to add capacity back later +- No unexpected changes are made to your deployment configuration +- You maintain full control over your ArmadaSet settings + +### How to resolve + +To clear Degraded Armadas, update each affected ArmadaSet to adjust the replica settings for regions without capacity: + +1. Navigate to the affected ArmadaSet +2. Go to **Settings → Regions** +3. Click **"Clear"** on the affected regions +4. Press **Save** +5. Repeat for all affected ArmadaSets across your environments + +Once you've adjusted the configuration, the Degraded state no longer appears. + +::: info +Before clearing configuration, you may want to note down your current settings (Min/Max Replicas, Buffer) in case you need to restore them later. +::: + +## Related + +- [Glossary](/multiplayer-servers/getting-started/glossary) +- [Setup your Environment](/multiplayer-servers/getting-started/setup-your-environment) +- [Terminating ArmadaSets](/multiplayer-servers/getting-started/terminating-armadasets)