CREATE WORKSPACE GROUP

Creates a new workspace group.

Syntax

CREATE WORKSPACE GROUP [ IF NOT EXISTS ] '<group_name>' 
    IN REGION { ID '<region_ID>' | '<region_name>' }
    [ WITH PASSWORD '<password>' ]
    [ EXPIRES AT '<expiry_time>' ]
    [ WITH FIREWALL RANGES '<ip_range>',... ]
    [ WITH BACKUP BUCKET KMS KEY ID '<backup_key_ID>' ]
    [ WITH DATA BUCKET KMS KEY ID '<data_key_ID>' ]
    [ WITH SMART DR ]
    [ ALLOW ALL TRAFFIC ]
    [ WITH UPDATE WINDOW '<day>:<hour>' ]

Arguments

  • group_name: Name of the workspace group.

  • region_ID, region_name: The ID or name of the region in which the workspace group is created.

  • password: The admin password for the workspace group. The password must contain the following:

    • At least 8 characters

    • At least one uppercase character

    • At least one lowercase character

    • At least one number or special character

  • expiry_time: The timestamp or the time interval at which the workspace group automatically expires (terminates).

  • ip_range: A list of allowed IP addresses or CIDR block.

  • backup_key_ID: The KMS key ID associated with the backup bucket.

  • data_key_ID: The KMS key ID associated with the data bucket.

  • day:hour: The day of the week (0-6 starting on a Sunday) and the hours of the day (0-23 UTC) when the updates are applied to the workspace group.

Remarks

  • Specify the IF NOT EXISTS clause to create a new workspace group only when a workspace group with the specified name does not exist already. If a workspace group with the specified name already exists and the IF NOT EXISTS clause is not specified, the CREATE WORKSPACE GROUP command returns an error.

  • If the WITH BACKUP BUCKET KMS KEY ID clause is specified, it enables Customer-Managed Encryption Keys (CMEK) encryption for the backup bucket of the workspace group. This feature is only supported in workspace groups deployed in AWS.

  • If the WITH DATA BUCKET KMS KEY ID clause is specified, it enables Customer-Managed Encryption Keys (CMEK) encryption for the data bucket and Amazon Elastic Block Store (EBS) volumes of the workspace group. This feature is only supported in workspace groups deployed in AWS.

  • Specify the WITH SMART DR clause to enable Smart Disaster Recovery (DR): SmartDR for the workspace group.

  • Specify the ALLOW ALL TRAFFIC clause to allow access to the workspace group from any IP address.

Examples

  • The following command creates a workspace group in the specified region:

    CREATE WORKSPACE GROUP 's2wsg' IN REGION 'US East 2 (Ohio)';
  • The following command creates a workspace group with additional configurations:

    CREATE WORKSPACE GROUP IF NOT EXISTS 's2wsg'
    IN REGION ID '93b61160-0000-1000-9000-977b8e2e3ee5'
    WITH FIREWALL RANGES '0.0.0.0/0'
    WITH SMART DR;

Last modified: February 13, 2025

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined
  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined
  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
    cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
    --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
    --bundle undefined \
    --new-bundle-format -
    Verified OK