Skip to content

Create Workspace

The platform supports multi-tenancy by the use of multiple workspaces. A workspace is a segregated Corridor Environment within the same installation of Corridor.

Note

It is always possible to run multiple processes of Corridor to handle multi-tenancy too.

The tech admin can create a workspace using the add-workspace utility and modify a workspace using the modify-workspace utility.

Before running this command, make sure that the ENABLE_WORKSPACE backend configuration is set to True.

Available options:

$ corridor-api scripts add-workspace --help

Usage: corridor-api scripts add-workspace [OPTIONS] WORKSPACE

  Create a new workspace with the provided name

Options:
  -d, --description TEXT  A description for the created workspace
  --help                  Show this message and exit.

$ corridor-api scripts modify-workspace --help

Usage: corridor-api scripts modify-workspace [OPTIONS] WORKSPACE

  Modify a workspace.

Options:
  --name TEXT                New name of the Workspace
  -d, --description TEXT     New description for workspace
  --activate / --deactivate  Activate or deactivate workspace
  --help                     Show this message and exit.

These commands are only available for the corridor-api component.

Example

To create a workspace with the name 'Analytical Workspace' and the description 'A workspace for all the analytics' If the workspace creation is successful the logs would show Successfully added the workspace.

$ corridor-api scripts add-workspace 'Analytical Workspace' -d 'A workspace for all the analytics'
Successfully added the workspace "Analytical Workspace".

To modify the name and description of the already existing workspace 

$ corridor-api scripts modify-workspace 'Analytical Workspace' --name 'Dev Workspace' -d 'Workspace for Development'
Renaming workspace from "Analytical Workspace" to "Dev Workspace".

Modifying the description.

To deactivate/activate already existing workspace 

$ corridor-api scripts modify-workspace 'Dev Workspace' --deactivate
Deactivating workspace "Dev Workspace".

$ corridor-api scripts modify-workspace 'Dev Workspace' --activate
Activating workspace "Dev Workspace".