Workspace Creation and Set-up

Create a Basic Workspace

Navigate to the side panel tab Workspaces and click Add Workspace. On the Get Started tab, you can select a Stack (pre-set environment) to get started quickly.

To see what each Stack has pre-installed, check the Github repo (https://github.com/MAAP-Project/maap-workspaces/tree/main/base_images) and look at the Dockerfiles. Currently there is not a better way to reliably understand what is in each.

To customize your Workspace after creating it, you can use conda. Further documentation on how to do this is in the Environments section of this documentation.

If you would like a more customized approach, on the Custom Workspace tab you can name your workspace, select the storage type, and select a devfile template from available stacks or upload your own devfile.

Advanced Creation: Alter the Workspace Memory Limit

Here, you can edit the devfile under containers/jupyter/resources/limits/memory to alter the memory limit for your workspace.

If you want to edit the devfile or your workspace’s memory limit after its creation, just click on the Workspaces side panel tab, then the workspace, then the Devfile tab at the top of the page.

DISCLAIMER: MAAP might change the way that we do workspace memory limits in the future, including restricting the memory that a user can allocate for their workspace. For now, as a courtesy to other users only increase the memory limit if your kernel keeps running out of memory and crashing. If you’re not sure why your kernel is crashing after increasing your workspace’s memory limit, please contact the development team. We recommend using a memory limit of 16GB (which means altering the devfile to memory: 15258Mi).

How Do I Rename My Workspace?

Option 1: At Workspace Creation

You can replace the auto-generated workspace name during creation via the Custom Workspace option.

Option 2: Edit Existing Workspace

1. In the workspaces tab under the Che side panel, select the workspace you want to rename.

2. Under the Overview section, you can replace the Workspace name field with whatever you wish to name it.

Caveat: no special characters like space, dollar sign, etc; name should start/end only with digits, Latin letters, or underscores

Share My Workspace With Another MAAP User

1. In the workspaces tab under the Che side panel, select the workspace you want to share.

2. Under the Share section, click the button + Add Developer. Then type in the email of the person/people you wish to share the workspace with and click Share. Only emails registered with MAAP can be used to share workspaces.

3. The user will now be listed for this workspace.

Important notes:

• If the workspace was opened under an organization, the workspace can only be shared with members of that organization and not any other MAAP user.

• Currently, we do not have a way to denote shared workspaces in the Che side panel, so we recommend renaming your workspace so that you know it is shared (e.g. add _s)

• Users who you share a workspace with will be able to see everything in your my-private-bucket folder and will have read, write, and delete permissions

• You will be able to see what tabs other users have open by refreshing or clicking on the “Running Terminals and Kernels” side tab