Guides
Stopping, archiving and storage
Workspace states, starting and stopping, starting with other settings, archiving and restoring, and how to see how full a work folder is.
App in development
On this page
The portal screens are in development. Their words and layout may still change; the commands behind the buttons are already built.
You start and stop your workspaces; nothing stops one because it is idle. Stop a workspace when you are done for now, and archive one you no longer use. IDs and numbers here are examples.
Workspace states
| State | Meaning |
|---|---|
| Off | Stopped, or not started yet. |
| Starting | The environment is coming up. |
| Running | Up. You can open the IDE. |
| Ended | Left running, but its environment stopped. The reason is shown with it. |
| Creating | The workspace is being created. |
| Failed | Creating it failed. Archive it and create a new one. |
| Archived | Put away. |
For an ended workspace the screen says: “This workspace was left running, but its environment stopped. Start it to run it again, or stop it to leave it off. Until you stop it, it counts toward your running workspace limit.” The reason reads, for example, “Out of memory”, “The environment exited (code 1)” or “The server restarted”. A workspace that a person stopped is “Off”, not “Ended”, and shows “Last ended” and “Stopped by” with it.
Starting
[Start] brings the environment up, and the workspace becomes “Running”.
ws start ws-0012 ... Preparing the workspace network... Checking the internet proxy and gateway... Starting the environmentStarted workspace: ws-0012IDE: https://app.example.org/ws/ws-0012/open There is a limit on running workspaces (2 by default). At the limit, stop another workspace. An ended workspace counts until you stop it.
Starting with other settings
[Start with settings] lets you choose “CPU cores” and “Memory”: “Only the values you change go into the command. The fields start with what a plain start uses.” Each field shows the maximum an admin set, such as “At most 8 cores”. GPUs and the environment image are for admins to set.
ws start ws-0012 --cpus 8 --memory 32gA running workspace's settings cannot be changed; stop it first. Trying anyway gives “The environment is running: ws-0012”.
If a setting changed after the workspace was created, it shows a mark such as “1 setting waits for a recreate”. Stop the workspace and press [Recreate and start] to apply it. The work folder stays, and system packages you installed are installed again.
ws start ws-0012 --recreateStopping
[Stop] asks first: “Stopping ends every program and terminal running in the environment, tmux and screen sessions included. The work folder and what you installed stay, and you can start it again.”
ws stop ws-0012 Stopped workspace: ws-0012The work folder stays as it is. A stopped workspace stays off until you start it. Admins can stop workspaces too; “Stopped by” then names the admin.
Archiving and restoring
Archive a workspace you no longer use. [Archive] is offered only once it is stopped: “Archiving removes the environment and frees its GPU. The work folder, records and releases stay, and you can restore it.” Requests waiting for approval are rejected.
ws archive ws-0012 Archived workspace: ws-0012The work folder, records and releases stay. ws restore ws-0012 Restored workspace: ws-0012Its environment is created again at the next start; the work folder stays. - Archived workspaces are under the “Archived” tab of [My workspaces]. While it is archived, its data does not appear under /data; restoring it shows the data again.
- An archived workspace no longer counts toward your workspace limit. [Restore] applies the limit again.
- After a restore, the environment is created again at the next start. The work folder stays as it was.
- A workspace in the “Failed” state can only be archived.
Storage
Each workspace's work folder has a size limit. The workspace's “Work folder” shows its use against the limit, such as “3.1 GiB of 20 GiB (16%)”, and adds “nearly full” at 80% or more.
To see all your work folders at once, run this command; you can type it into the console's command line under the screen:
synapse storage When a folder is nearly full, delete files you no longer need, starting with large intermediate files you can make again. Deleting files from the work folder does not touch releases you already made or the work folders saved with them. The work-folder limit is set for each installation.