From 3361a6b37483f48743525f8cddfc81640a5c9d18 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:11:01 +0200 Subject: [PATCH 1/6] document backup files on upgrade Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> --- docs/docs/workflows/upgrade.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index 7c68340c31..a06fb7a81e 100644 --- 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 the Terraform state and certain Custom Resources are created. +The Terraform state backup can be used as a reference to the possible Terraform resource migration of an upgrade. +The Custom Resource backup files can be used to restore those Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. + ## Check the status Upgrades are asynchronous operations. From 3ac07a9843589f578ec1202f1ceee79fbadf1c12 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:14:57 +0200 Subject: [PATCH 2/6] reword TF backup --- docs/docs/workflows/upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index a06fb7a81e..778c35fcf5 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -59,8 +59,8 @@ 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 the Terraform state and certain Custom Resources are created. -The Terraform state backup can be used as a reference to the possible Terraform resource migration of an upgrade. -The Custom Resource backup files can be used to restore those Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. +The Terraform state backup can be used as a reference to the possible Terraform resource migration performed within an upgrade. +The Custom Resource backup files can be used to restore Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. ## Check the status From ef78557e0c83797d7a09cf1c216d882cf42cb162 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:36:55 +0200 Subject: [PATCH 3/6] Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner --- docs/docs/workflows/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index 778c35fcf5..e82a3487a8 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -58,7 +58,7 @@ 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 the Terraform state and certain Custom Resources are created. +When applying an upgrade, backup files of Constellation-managed Custom Resource Definitions, Custom Resources, and Terraform state are created. The Terraform state backup can be used as a reference to the possible Terraform resource migration performed within an upgrade. The Custom Resource backup files can be used to restore Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. From 337445c2bc28d3c3d9e793bde8ef87e64d239805 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:37:10 +0200 Subject: [PATCH 4/6] Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner --- docs/docs/workflows/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index e82a3487a8..7a916c6f7e 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -59,7 +59,7 @@ 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. -The Terraform state backup can be used as a reference to the possible Terraform resource migration performed within an upgrade. +The Terraform state backup can be used to restore previous resources in case an upgrade misconfigured or erroneously deleted a resource. The Custom Resource backup files can be used to restore Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. ## Check the status From 8386b54ce3074bd56d426b5fe92d7eed4601ad71 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:37:25 +0200 Subject: [PATCH 5/6] Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner --- docs/docs/workflows/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index 7a916c6f7e..b5ffbe7307 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -60,7 +60,7 @@ 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. The Terraform state backup can be used to restore previous resources in case an upgrade misconfigured or erroneously deleted a resource. -The Custom Resource backup files can be used to restore Custom Resources manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. +The Custom Resource (Definition) backup files can be used to restore Custom Resources and Definitions manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. ## Check the status From 4ffb74ef82f3be51e0386b8ff004f946bfa5c74b Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Wed, 23 Aug 2023 10:11:39 +0200 Subject: [PATCH 6/6] Update upgrade.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> --- docs/docs/workflows/upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index b5ffbe7307..bd7a40e636 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -59,8 +59,8 @@ 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. -The Terraform state backup can be used to restore previous resources in case an upgrade misconfigured or erroneously deleted a resource. -The Custom Resource (Definition) backup files can be used to restore Custom Resources and Definitions manually (e.g. via `kubectl apply`) if the automatic migration of those resources fails. +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