📖 Managed cluster migration (stolostron#1171)

* Managed cluster migration Signed-off-by: clyang82 <[email protected]> * Address review comments Signed-off-by: clyang82 <[email protected]> --------- Signed-off-by: clyang82 <[email protected]>
yanmxa · Oct 21, 2024 · 37e1124 · 37e1124
1 parent c98be62
commit 37e1124
Showing 1 changed file with 26 additions and 1 deletion.
diff --git a/doc/dev-preview.md b/doc/dev-preview.md
@@ -144,4 +144,29 @@ send it to the Global Hub Manager to populate the dashboard.
 
 ### Event Exporter(Standalone Agent)
 
-To unlock the potential of the global hub agent and integrate ACM into the event-driven ecosystem, we propose running the agent in standalone mode environment. This will enable it to function as an event exporter, reporting resources to the specified target. For more detail, please [visit](./event-exporter/README.md)
+To unlock the potential of the global hub agent and integrate ACM into the event-driven ecosystem, we propose running the agent in standalone mode environment. This will enable it to function as an event exporter, reporting resources to the specified target. For more detail, please [visit](./event-exporter/README.md)
+
+### Managed Cluster Migration
+
+This feature enables the customers to migrate the managed clusters from one hub to another. There is a new [API](https://github.com/stolostron/multicluster-global-hub/blob/main/operator/api/migration/v1alpha1/managedclustermigration_types.go) introduced for this purpose.
+
+Before migrating the managed clusters from one hub to another, you need to ensure that:
+1. Both managed hub clusters have the same ACM version installed.
+2. The managed-serviceaccount addon is enabled on both clusters.
+
+Then you can create a managedclustermigration CR in the **global hub namespace** (default to `multicluster-global-hub`). Here is a sample:
+```
+apiVersion: global-hub.open-cluster-management.io/v1alpha1
+kind: ManagedClusterMigration
+metadata:
+  name: migration-sample
+spec:
+  to: demo-hub-a
+  includedManagedClusters:
+  - demo-managed-b1
+```
+`to` points to the target cluster you want to migrate `demo-managed-b1` cluster to.
+
+Once the ManagedClusterMigration CR is created, `demo-managed-b1` will start migrating to the `demo-hub-a` hub cluster. The `demo-managed-b1` should be ready shortly. If you find that the cluster is not ready, it is likely due to `too many CSRs already created on the hub`. You will need to manually delete the CSRs to resolve this issue. This is an known issue in this release.
+
+The `demo-managed-b1` can be detached once its status changes to `Unknown` on the original managed hub cluster.