Creating and Using Workspaces

Workloads with unique configurations (for example production or developer environments) should be deployed in separate workspace groups. You can create a workspace through the UI or the Management API. To create a workspace through the UI, perform the following tasks:

  1. Log into the Cloud Portal.

  2. To create a workspace in an existing workspace group, select the (+) icon next to the workspace group name in the left navigation pane, and skip to step 4. To create a new workspace group, on the left navigation pane, under Cloud, select + Group.

  3. On the Create Workspace Group page, enter or select the following configuration settings for the workspace group, and then select Next.

    • Workspace Group Name: Enter a name for your workspace group. Workspace group names must be 1-255 characters in length.

    • Cloud Provider: Select the cloud provider in which the workspace group is to be deployed.

    • Region: Select the availability region for the cloud provider. Regions are data centre geographies in which a workspace is deployed. While any region can be selected, select the region that corresponds to the same region in which your target application is running. Note that regions vary in price.

    Note: To use the Enable SmartDR and Database Branching under the Advance Settings, refer to Smart Disaster Recovery (DR): SmartDR.

  4. On the Create Workspace page, enter or select the following:

    • Workspace Name: Enter a name for the workspace. A workspace's name must be 1-32 characters in length and can consist of digits, lowercase letters, and hyphens (-).

    • Size: Select a size for the workspace. Consideration should be given to the needed compute, memory, and storage requirements when selecting workspace size. Refer to SingleStore Helios Sizing Guidelines for more information. A workspace can be scaled up or down as required.

    • Settings:

      • SingleStore Kai (Optional): Enables the MongoDB® API and mongodb:// endpoint for your deployment. Refer to SingleStore Kai for more information.

      • Deployment Type: Updates roll out to non-production deployments prior to production.

      • Auto Suspend: Suspends the deployment after inactivity or a set duration.

    • Sample Datasets

      • MarTech Application: Attach a database for a demo applicaiton.

  5. Select Create Workspace.

Each workspace provides a connection endpoint which you can use to connect from a client, IDE, or application. You can also use the workspace's SQL Editor in the Cloud Portal to connect and run queries directly.

SingleStore Helios provides a Classless Inter-Domain Routing (CIDR) allowlist (whitelist) to restrict the networks that can access a workspace. This can be defined by editing the IP Allowlist for a workspace group.

Creating and managing workspaces can be done through the Cloud Portal user interface (UI), Management API, or SQL commands. The following functions are available via these management interfaces.

  • Create or terminate a workspace group

  • Create or terminate a workspace

  • Connect to a workspace

  • Create or delete a database

  • Attach or detach a database

  • Configure firewall

  • Configure users

If a database is detached, it can be dropped from the UI or Management API. The DROP DATABASE command can only be run on a workspace with R/W access to the database, and it drops the specified database from all the workspaces, including the read-only copies.

For more information on using workspaces, refer to the following:

Last modified: January 30, 2024

Was this article helpful?