diff --git a/docs/production-deployment/cloud/migrate/automated.mdx b/docs/production-deployment/cloud/migrate/automated.mdx index e8038e0c58..8638e45936 100644 --- a/docs/production-deployment/cloud/migrate/automated.mdx +++ b/docs/production-deployment/cloud/migrate/automated.mdx @@ -81,7 +81,7 @@ Submit a support ticket with the following details: - A list of your Temporal accounts - Target Temporal Cloud service regions -- For each cluster, provide the server configuration by running `temporal operator cluster describe --address ` +- For each cluster, provide the server configuration by running `temporal operator cluster describe --address --output json` (see [notes](#alternative-commands-for-versions-1281-and-prior) for Temporal server version 1.28.1 and prior). - Metrics for the namespaces to be migrated: - number of open/closed workflows - storage used @@ -192,14 +192,18 @@ There are two options for switching Temporal clients to the cloud: automatically forward from your server to the cloud. 4. Complete migration. Your self-hosted Temporal clients will no longer receive any tasks from your server, allowing you to stop these clients. -- Option 2 (not recommended)- Deploy one set of Temporal clients and switch the namespace endpoint during migration. With this option, your workflows will stop making progress. +- Option 2 - Deploy one set of Temporal clients and switch the namespace endpoint during migration. With this option, if your workers are misconfigured during the switch, then it is + possible that workflows can stop making progress. It is important to ensure that all workers maintain connectivity to cloud to avoid this scenario. The process is as follows: 1. Start migration. - 2. Switch your Temporal clients to point to the cloud namespace endpoint. Requests from your Temporal clients will automatically forward from the cloud to your server. - 3. Hand over namespace to the cloud. Requests from your Temporal clients will now be served by the cloud and will not be forwarded to your server. Alternatively, you may + 2. Switch your Temporal clients to point to the cloud namespace endpoint. Requests from your Temporal clients will automatically forward from the cloud to your server. Alternatively, you may switch Temporal clients to the cloud namespace endpoint after handover. + 3. Hand over namespace to the cloud. Requests from your Temporal clients will now be served by the cloud and will not be forwarded to your server. 4. Confirm migration completion. + + + #### Final Validation Before failing over your namespace to Temporal Cloud, review the following production readiness checklist. These steps help ensure a smooth transition and minimize surprises in production. @@ -209,3 +213,17 @@ Before failing over your namespace to Temporal Cloud, review the following produ - Learn how capacity management works in Temporal Cloud, including how to request capacity increases. - Plan for a worker tuning session - performance change between Temporal Cloud v.s. self-hosted cluster, which could lead to unexpected symptoms and optimizations. - Know how to reach out to your Temporal Solutions Architect (SA) and Account Executive (AE) for assistance. + + +### Additional Notes + +#### Alternative Commands for Versions 1.28.1 and Prior +Version 1.28.1 and older do not provide the details necessary for setting up migration. If you are running an older version of Temporal, then substitute the below +commands for the "temporal operator cluster describe" command cited in this document. + +If you are using tctl, then substitute the following command: `tctl --address admin cluster describe` + +If you are not a tctl user, then use the following alternative: +`grpcurl -v -plaintext temporal.server.api.adminservice.v1.AdminService.DescribeCluster` + +