Workspaces#
Workspaces provide a convenient VSCode development environment for iterating on your Union tasks, workflows, and apps.
Creating a workspace#
To create a workspace, click on the Workspace tab on left navbar and click
on the New Workspace button on the top right.
Provide a name for your workspace, set an Idle TTL (time to live), and
click Create.
Note
The Idle TTL is the amount of time a workspace will be idle before it is automatically stopped. Workspaces have a global TTL of 1 day, but you can set the idle TTL field to a shorter duration to stop the workspace sooner.
You should see a new workspace created in the Workspaces view:
Setting secrets#
If you don’t have any secrets yet, create them with the union create secret
command:
union create secret --project my_project --domain my_domain --name my_secret
You’ll be prompted to enter a secret value in the terminal:
Enter secret value: ...
Note
You can learn more about secrets management here.
Set secrets for your workspace by clicking on the Secrets tab in the sidebar.
Provide the my_secret key and optionally, the environment variable you want
to assign it to in the workspace.
Setting resources#
You can also set the resources for your workspace:
These resources must be compatible with the resources available to your BYOC cluster. Find the details of your BYOC cluster in the top-level dashboard:
You can choose the GPU accelerator that corresponds to your available instance types.
Specifying custom on_startup commands#
If you need to run any commands like install additional dependencies or wget
a file from the web, specify custom on_startup commands:
Specifying custom container images#
By default, the workspace will use a Union-provided container image which contains the following Python libraries:
unionflytekituvipykernelpandaspyarrowscikit-learnmatplotlib
You can specify a pre-built custom container image by clicking on the Container
tab in the sidebar and provide the image name in the workspace creation form.
In many cases, you may want to use the same container image as a task execution that you want to debug. You can find the container image URI by going to the task execution details page:
Running a workspace#
To run a workspace, click on the switch on the workspace item:
Once the workspace has started, you can click on the Open in VSCode button:
Once the startup commands have completed, you’ll see a browser-based VSCode IDE:
Editing a workspace#
Change the workspace configuration by clicking on the Edit button:
Note that you can change everything except the workspace name.
The workspace detail view#
Clicking on the workspace item on the list view will reveal the workspace detail view, which provides all the information about the workspace.
Archiving a workspace#
Archive a workspace by clicking on the Archive button:
Show archived workspaces by clicking on the Show archived toggle
on the top right of the workspaces list view. Unarchive a workspace by clicking
on the Unarchive button:
Filesystem Persistence#
Any changes to the filesystem that you make in the working directory of your workspace (the directory you find yourself in when you first open the workspace) are persisted across workspace restarts.
This allows you to save data, code, models, and other files in your workspace.
Note
Storing large datasets, models, and other files in your workspace may slow down the start and stop times of your workspace. This is because the workspace instance needs time to download/upload the files from persistent storage.
Sorting and filtering workspaces#
You can filter workspaces to only the active ones by clicking on the Active
toggle on the top left of the workspaces list view.
Sort by recently updated by clicking on the Recently updated toggle on the
top right of the workspaces list view, and you can also sort by recently
updated by clicking on the Recently updated toggle on the top right of the
workspaces list view.
