udate mng api and comments

j-fitas · j-fitas · commit 5b2aba3104dc · 2025-07-23T04:26:37.000+01:00
diff --git a/notebooks/migrate-virtual-workspace/notebook.ipynb b/notebooks/migrate-virtual-workspace/notebook.ipynb
@@ -25,7 +25,7 @@
         "    <b class=\"fa fa-solid fa-exclamation-circle\"></b>\n",
         "    <div>\n",
         "        <p><b>Note</b></p>\n",
-        "        <p>This notebook is in preview and requires your Organization to have access to the Migrate Virtual Workspace Feature. Please reach out to us if you'd like to request access.</p>\n",
+        "        <p>This notebook is in preview and requires your Organization to have access to the Migrate Shared Deployment Feature. Please reach out to us if you'd like to request access.</p>\n",
         "        <p>This notebook should be run on any shared deployment (including on a Free Starter Workspace) in an Organization whose plan allow for the creation of a new dedicated deployment.</p>\n",
         "        <p>To create a Free Starter Workspace navigate to <tt>Start</tt> using the left nav.</p>\n",
         "    </div>\n",
@@ -57,11 +57,11 @@
         "    <b class=\"fa fa-solid fa-exclamation-circle\"></b>\n",
         "    <div>\n",
         "        <p><b>Warning</b></p>\n",
-        "        <p>During the migration process data writen to the shared deployment may not be moved to the new Workspace in the dedicated deployment. The shared deployment will remain available during (and after) the migration process, however any writes to the shared deployment after the migration process begins may not be reflected on the new workspace.</p>\n",
-        "        <p>The migration process will copy your data to the new deployment and, by default, move any jobs you had scheduled for your shared deployemnt to the new deployment. If you do not wish to move your scheduled jobs, You will be prompeted to not do it. You can manually move them later from the Jobs page.</p>\n",
-        "        <p>While your migrated data will also remain available on your shared deployment, after the migration, the scheduled jobs will only be one the new deployment, please account for this when migrating.</p>\n",
+        "        <p>During the migration process data written to the shared deployment may not be moved to the new dedicated deployment. The shared deployment will remain available during (and after) the migration process, however any writes to the shared deployment after the migration process begins may not be reflected on the new deployment.</p>\n",
+        "        <p>The migration process will copy your data to the new deployment and, by default, move any jobs you had scheduled for your shared deployment to the new deployment. You can elect not to move your scheduled jobs. If You do so, You can manually move them later from the Jobs page.</p>\n",
+        "        <p>While your migrated data will also remain available on your shared deployment, after the migration, the scheduled jobs will only be one the new deployment.</p>\n",
         "        <p></p>\n",
-        "        <p>Please account for this behaviour when migrating.</p>\n",
+        "        <p>Please account for this behavior when migrating.</p>\n",
         "    </div>\n",
         "</div>"
       ]
@@ -72,8 +72,8 @@
       "id": "f3dfd325",
       "metadata": {},
       "source": [
-        "## Choose a Region for the new workspace group\n",
-        "Please select the Region you desire your new Workspace Group to be created on from the dropdown after the next cell."
+        "## Choose a Region for the new deployment\n",
+        "Please select the Region you desire your new deployment to be created on from the dropdown after the next cell."
       ]
     },
     {
@@ -87,8 +87,8 @@
         "from ipywidgets import widgets\n",
         "\n",
         "api_url = os.environ['SINGLESTOREDB_MANAGEMENT_BASE_URL']\n",
-        "region_response = requests.get('{}/v1/regions'.format(api_url), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
-        "regions = [[f\"{r['provider']}: {r['region']}\", r['regionID']] for r in region_response.json()]\n",
+        "region_response = requests.get('{}/v2/regions'.format(api_url), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
+        "regions = [[f\"{r['region']} : {r['provider']} - {r['regionName']}\", [r['provider'], ['regionName']]] for r in region_response.json()]\n",
         "region_dropdown = widgets.Dropdown(\n",
         "    options = regions,\n",
         "    value = regions[0][1],\n",
@@ -163,7 +163,7 @@
       "source": [
         "## Choose the size for the new workspace\n",
         "Please insert the size for your new Workspace in text box after the next cell.\n",
-        "If you are unsure which size to choose, visit the [docs](https://www.singlestore.com/cloud-pricing/)."
+        "If you are unsure which size to choose, you can check them [here](https://www.singlestore.com/cloud-pricing/)."
       ]
     },
     {
@@ -195,13 +195,9 @@
         "    <b class=\"fa fa-solid fa-exclamation-circle\"></b>\n",
         "    <div>\n",
         "        <p><b>Warning</b></p>\n",
-        "        <p>During the migration process data writen to the shared deployment may not be moved to the new Workspace in the dedicated deployment. The shared deployment will remain available during (and after) the migration process, however any writes to the shared deployment after the migration process begins may not be reflected on the new workspace.</p>\n",
-        "        <p>The migration process will copy your data to the new deployment and, by default, move any jobs you had scheduled for your shared deployemnt to the new deployment. If you do not wish to move your scheduled jobs, You will be prompeted to not do it. You can manually move them later from the Jobs page.</p>\n",
-        "        <p>While your migrated data will also remain available on your shared deployment, after the migration, the scheduled jobs will only be one the new deployment.</p>\n",
-        "        <p></p>\n",
-        "        <p>Please account for this behaviour when migrating.</p>\n",
+        "        <p>After runnig the next cell, data written to the shared deployment may not be moved to the new Workspace.</p>\n",
+        "        <p>If you do not wish to move your scheduled jobs, you should set \"migrateScheduledJobs\" to false on the request body bellow.</p>\n",
         "        <p></p>\n",
-        "        <p>If you do not wish to migrate your scheduled Jobs to the new deployment, please set the field \"migrateScheduledJobs\", in the cell bellow, to false.</p>\n",
         "    </div>\n",
         "</div>"
       ]
@@ -233,13 +229,14 @@
         "  \"migrateScheduledJobs\": true,\n",
         "  \"destinationWorkspace\": {\n",
         "    \"name\": workspace_name_text_box.value,\n",
-        "    \"regionID\": region_dropdown.value,\n",
+        "    \"provider\": region_dropdown.value[0],\n",
+        "    \"regionName\": region_dropdown.value[1],\n",
         "    \"size\": size_text_box.value,\n",
         "    \"workspaceGroupName\": workspace_group_name_text_box.value\n",
         "  }\n",
-        "})\n",
+        "}).status_code\n",
         "\n",
-        "if migrate_response.status_code == 200:\n",
+        "if migrate_response == 200:\n",
         "    display(widgets.HTML(f\"<div class='alert alert-block alert-success'><b class='fa fa-solid fa-check-circle'></b><div><p><b>Migration Started</b></p><p>See next cell for progress</p></div></div>\"))\n",
         "else:\n",
         "    display(widgets.HTML(f\"<div class='alert alert-block alert-danger'><b class='fa fa-solid fa-exclamation-triangle'></b><div><p><b>Failed to Start Migration</b></p><p>{migrate_response.status_code} - {migrate_response.text}</p></div></div>\"))"
@@ -251,7 +248,7 @@
       "id": "fb825bce",
       "metadata": {},
       "source": [
-        "## Check the progress of the migration:\n",
+        "## Check the progress of the migration\n",
         "Running the next cell will give you progress on the migration"
       ]
     },
@@ -269,16 +266,10 @@
         "organization_id = os.environ['SINGLESTOREDB_ORGANIZATION']\n",
         "api_url = os.environ['SINGLESTOREDB_MANAGEMENT_BASE_URL']\n",
         "\n",
-        "status_response = requests.get('{}/v1/sharedtier/virtualWorkspaces/{}/migrate'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
+        "status_response = requests.get('{}/v1/sharedtier/virtualWorkspaces/{}/migrations'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
         "\n",
-        "while status_response.json()[\"migrationStatus\"] not in [\"Completed\", \"Failed\"]:\n",
-        "    display(widgets.IntProgress(\n",
-        "        value=[\"Failed\", \"WaitingForWorkspaceGroup\", \"MigratingData\", \"MigratingJobs\", \"Completed\"].index(status_response.json()[\"migrationStatus\"]),\n",
-        "        min=0,\n",
-        "        max=4,\n",
-        "        description='Loading:',\n",
-        "        orientation='horizontal'\n",
-        "    ))\n",
+        "while status_response.json()[\"migrationStatus\"] not in [\"SUCCEEDED\", \"FAILED\"]:\n",
+        "    display(widgets.HTML('<div class=\"alert alert-block alert-info\"><b class=\"fa fa-solid fa-info-circle\"></b><div><p><b>In Progress</b></p><p>Your Shared Deployment is being migrated.</p></div></div>'))\n",
         "    time.sleep(15)\n",
         "    status_response = requests.get('{}/v1/sharedtier/virtualWorkspaces/{}/migrations'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
         "\n",
