docs: document upgrade backup files (#2275)

* document backup files on upgrade Signed-off-by: Moritz Sanft <[email protected]> * reword TF backup * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <[email protected]> * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <[email protected]> * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <[email protected]> * Update upgrade.md Co-authored-by: Thomas Tendyck <[email protected]> --------- Signed-off-by: Moritz Sanft <[email protected]> Co-authored-by: Otto Bittner <[email protected]> Co-authored-by: Thomas Tendyck <[email protected]>
edgelesssys · Aug 23, 2023 · 49e5a17 · 49e5a17
1 parent abd5cdf
commit 49e5a17
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md
@@ -58,6 +58,10 @@ Image and Kubernetes upgrades take longer.
 For each node in your cluster, a new node has to be created and joined.
 The process usually takes up to ten minutes per node.
 
+When applying an upgrade, backup files of Constellation-managed Custom Resource Definitions, Custom Resources, and Terraform state are created.
+You can use the Terraform state backup to restore previous resources in case an upgrade misconfigured or erroneously deleted a resource.
+You can use the Custom Resource (Definition) backup files to restore Custom Resources and Definitions manually (e.g., via `kubectl apply`) if the automatic migration of those resources fails.
+
 ## Check the status
 
 Upgrades are asynchronous operations.