feat: add notebook to upgrade shared tier (#136)

j-fitas · web-flow · commit c39547c842b8 · 2025-07-24T08:51:27.000-05:00
* feat: add notebook to upgrade shared tier

* Update nootebook

* update python-udf-template/notebook.ipynb according to commit hooks

* apply comments

* Extend notebook to also migrate scheduled jobs

* rename notebook

* update notebook to match new API spec

* update warnings

* udate mng api and comments

* minor fixes

* minor fixes
diff --git a/notebooks/migrate-virtual-workspace/meta.toml b/notebooks/migrate-virtual-workspace/meta.toml
@@ -0,0 +1,14 @@
+[meta]
+authors=["singlestore"]
+title="Migrate Your Virtual Workspace"
+description="""\
+    Learn how to migrate Your VirtualWorkspace\
+    to a fullfledged Workspace in a dedicated
+    Workspace Group.
+    """
+icon="browser"
+difficulty="intermediate"
+tags=["starter", "notebooks"]
+lesson_areas=[]
+destinations=["spaces"]
+minimum_tier="standard"
diff --git a/notebooks/migrate-virtual-workspace/notebook.ipynb b/notebooks/migrate-virtual-workspace/notebook.ipynb
@@ -0,0 +1,319 @@
+{
+  "cells": [
+    {
+      "id": "89f14efd",
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "<div id=\"singlestore-header\" style=\"display: flex; background-color: rgba(235, 249, 245, 0.25); padding: 5px;\">\n",
+        "    <div id=\"icon-image\" style=\"width: 90px; height: 90px;\">\n",
+        "        <img width=\"100%\" height=\"100%\" src=\"https://raw.githubusercontent.com/singlestore-labs/spaces-notebooks/master/common/images/header-icons/browser.png\" />\n",
+        "    </div>\n",
+        "    <div id=\"text\" style=\"padding: 5px; margin-left: 10px;\">\n",
+        "        <div id=\"badge\" style=\"display: inline-block; background-color: rgba(0, 0, 0, 0.15); border-radius: 4px; padding: 4px 8px; align-items: center; margin-top: 6px; margin-bottom: -2px; font-size: 80%\">SingleStore Notebooks</div>\n",
+        "        <h1 style=\"font-weight: 500; margin: 8px 0 0 4px;\">Migrate Your Virtual Workspace</h1>\n",
+        "    </div>\n",
+        "</div>"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "067bfdc9",
+      "metadata": {},
+      "source": [
+        "<div class=\"alert alert-block alert-warning\">\n",
+        "    <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 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",
+        "</div>"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "750ba802",
+      "metadata": {},
+      "source": [
+        "This notebook will show you how to migrate your shared deployment to a new dedicated deployment.\n",
+        "All the fields have default values set, but we encourage you to customize them.\n",
+        "The required information is:\n",
+        "- a new name for your new Workspace in the dedicated deployment\n",
+        "- the desired size of your new Workspace in the dedicated deployment (see: https://www.singlestore.com/cloud-pricing/)\n",
+        "- a custom name for your new workspace group\n",
+        "- the id of the region to create your new workspace group"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "d492e34d",
+      "metadata": {},
+      "source": [
+        "<div class=\"alert alert-block alert-warning\">\n",
+        "    <b class=\"fa fa-solid fa-exclamation-circle\"></b>\n",
+        "    <div>\n",
+        "        <p><b>Warning</b></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, if you decided to migrate your Jobs, they are going to be unavailable until the migration process is finished.</p>\n",
+        "        <p></p>\n",
+        "        <p>Please account for this behavior when migrating.</p>\n",
+        "    </div>\n",
+        "</div>"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "f3dfd325",
+      "metadata": {},
+      "source": [
+        "## 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."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 1,
+      "id": "91c80425",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import requests, os\n",
+        "from ipywidgets import widgets\n",
+        "\n",
+        "api_url = os.environ['SINGLESTOREDB_MANAGEMENT_BASE_URL']\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'], r['regionName']]] for r in region_response.json()]\n",
+        "region_dropdown = widgets.Dropdown(\n",
+        "    options = regions,\n",
+        "    value = regions[0][1],\n",
+        "    description = 'Region:',\n",
+        "    disabled = False,\n",
+        ")\n",
+        "\n",
+        "display(region_dropdown)"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "d612fde9",
+      "metadata": {},
+      "source": [
+        "## Choose a Name for the new workspace group\n",
+        "Please insert the name for your new Workspace Group in text box after the next cell."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 2,
+      "id": "1b2e37e2",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from ipywidgets import widgets\n",
+        "\n",
+        "workspace_group_name_text_box = widgets.Text(\n",
+        "    value='MigrationGroup',\n",
+        "    placeholder='Insert a name',\n",
+        "    description='Name:'\n",
+        ")\n",
+        "\n",
+        "display(workspace_group_name_text_box)"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "cfd310c0",
+      "metadata": {},
+      "source": [
+        "## Choose a Name for the new workspace\n",
+        "Please insert the name for your new Workspace in text box after the next cell."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 3,
+      "id": "3032d557",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from ipywidgets import widgets\n",
+        "\n",
+        "workspace_name_text_box = widgets.Text(\n",
+        "    value='migrated-workspace',\n",
+        "    placeholder='Insert a name',\n",
+        "    description='Name:'\n",
+        ")\n",
+        "\n",
+        "display(workspace_name_text_box)"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "2bcb9f24",
+      "metadata": {},
+      "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, you can check them [here](https://www.singlestore.com/cloud-pricing/)."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 4,
+      "id": "703ff15e",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from ipywidgets import widgets\n",
+        "\n",
+        "size_text_box = widgets.Text(\n",
+        "    value='S-00',\n",
+        "    placeholder='Insert a size',\n",
+        "    description='Size:',\n",
+        "    layout={'width': 'max-content'}\n",
+        ")\n",
+        "\n",
+        "display(size_text_box)"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "ad57d499",
+      "metadata": {},
+      "source": [
+        "<div class=\"alert alert-block alert-warning\">\n",
+        "    <b class=\"fa fa-solid fa-exclamation-circle\"></b>\n",
+        "    <div>\n",
+        "        <p><b>Warning</b></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 below.</p>\n",
+        "        <p></p>\n",
+        "    </div>\n",
+        "</div>"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "04adceb6",
+      "metadata": {},
+      "source": [
+        "## Begin the migration process\n",
+        "Runing the next cell will start the migration process"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 5,
+      "id": "edce432c",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import requests, os\n",
+        "from ipywidgets import widgets\n",
+        "\n",
+        "workspace_id = os.environ['SINGLESTOREDB_VIRTUAL_WORKSPACE']\n",
+        "api_url = os.environ['SINGLESTOREDB_MANAGEMENT_BASE_URL']\n",
+        "\n",
+        "migrate_response = requests.post('{}/v1/sharedtier/virtualWorkspaces/{}/migrate'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)}, json={\n",
+        "  \"migrateScheduledJobs\": True,\n",
+        "  \"destinationWorkspace\": {\n",
+        "    \"name\": workspace_name_text_box.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",
+        "\n",
+        "if migrate_response.status_code == 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>\"))"
+      ]
+    },
+    {
+      "attachments": {},
+      "cell_type": "markdown",
+      "id": "fb825bce",
+      "metadata": {},
+      "source": [
+        "## Check the progress of the migration\n",
+        "Running the next cell will give you progress on the migration"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 6,
+      "id": "9885c925",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import requests, os, time\n",
+        "from ipywidgets import widgets\n",
+        "\n",
+        "workspace_id = os.environ['SINGLESTOREDB_VIRTUAL_WORKSPACE']\n",
+        "organization_id = os.environ['SINGLESTOREDB_ORGANIZATION']\n",
+        "api_url = os.environ['SINGLESTOREDB_MANAGEMENT_BASE_URL']\n",
+        "\n",
+        "status_response = requests.get('{}/v1/sharedtier/virtualWorkspaces/{}/migrations'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
+        "\n",
+        "if status_response.json()[0][\"migrationStatus\"] == \"SUCCEEDED\":\n",
+        "    display(widgets.HTML('<div class=\"alert alert-block alert-success\"><b class=\"fa fa-solid fa-check-circle\"></b><div><p><b>Success</b></p><p>The migration has completed succesfully! you can now visit your new workpace in the deployments page. If you wish to do so, you can now terminate your shared deployment from the deployments page.</p></div></div>'))\n",
+        "\n",
+        "else:\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",
+        "\n",
+        "    while status_response.json()[0][\"migrationStatus\"] not in [\"SUCCEEDED\", \"FAILED\"]:\n",
+        "        time.sleep(30)\n",
+        "        status_response = requests.get('{}/v1/sharedtier/virtualWorkspaces/{}/migrations'.format(api_url, workspace_id), headers={'Authorization': 'Bearer {}'.format(connection_password)})\n",
+        "\n",
+        "\n",
+        "    if status_response.json()[0][\"migrationStatus\"] == \"SUCCEEDED\":\n",
+        "        display(widgets.HTML('<div class=\"alert alert-block alert-success\"><b class=\"fa fa-solid fa-check-circle\"></b><div><p><b>Success</b></p><p>The migration has completed succesfully! you can now visit your new workpace in the deployments page. If you wish to do so, you can now terminate your shared deployment from the deployments page.</p></div></div>'))\n",
+        "    else:\n",
+        "        display(widgets.HTML(\"<div class='alert alert-block alert-danger'><b class='fa fa-solid fa-exclamation-triangle'></b><div><p><b>Failed to Complete Migrate</b></p><p>The migration process failed, please contact support</p></div></div>\"))"
+      ]
+    },
+    {
+      "id": "33019b76",
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "<div id=\"singlestore-footer\" style=\"background-color: rgba(194, 193, 199, 0.25); height:2px; margin-bottom:10px\"></div>\n",
+        "<div><img src=\"https://raw.githubusercontent.com/singlestore-labs/spaces-notebooks/master/common/images/singlestore-logo-grey.png\" style=\"padding: 0px; margin: 0px; height: 24px\"/></div>"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": ".venv",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.12.3"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 5
+}
diff --git a/notebooks/notebook-style-guide/notebook.ipynb b/notebooks/notebook-style-guide/notebook.ipynb
@@ -502,7 +502,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
   },
@@ -516,7 +516,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,
diff --git a/notebooks/python-udf-template/notebook.ipynb b/notebooks/python-udf-template/notebook.ipynb
