diff --git a/src/multiplayer-servers/getting-started/glossary.md b/src/multiplayer-servers/getting-started/glossary.md index 0e2e9da2..5a4af41b 100644 --- a/src/multiplayer-servers/getting-started/glossary.md +++ b/src/multiplayer-servers/getting-started/glossary.md @@ -61,6 +61,14 @@ 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 + +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. + +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 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..a9e1b2b1 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": "Troubleshooting", + "link": "/getting-started/troubleshooting" + }, { "text": "Terminating ArmadaSets", "link": "/getting-started/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)