Custom container template
You need the following:
- Valid credentials for accessing cloud storage resources
- Maintain role permissions or above
- A compute environment with sufficient resources (scale based on data volume)
- Data Explorer enabled
- If your container image is in a private registry, container registry credentials for that registry in the workspace. Wave uses them to pull the image. They are separate from your compute environment and cloud storage credentials.
Select Custom container template and provide your own template (see Custom container template image). This option supports Install Conda packages. See Conda augmentation of custom images. For ready-to-use examples, see Example custom Studios.
Configure the following fields in each section of the form:
-
Studio environment
- Container identifier: The template for the container.
- More settings:
-
Install Conda packages (optional): A list of Conda packages to include with the Studio. For more information on package syntax, see Conda package syntax.
noteThe workspace Admin must set a target container repository in Settings > Studios > Container repository, and the workspace must have credentials with push access to it. See the Conda packages prerequisites.
-
-
Compute
- Compute environment: The compute environment to launch the Studio session in.
- CPUs allocated: The number of CPUs allocated to the Studio session.
- Maximum memory allocated: The maximum memory allocated to the Studio session.
- More settings (optional):
- Resource labels: Any resource label already defined for the compute environment is added by default. Add or remove custom resource labels as needed.
- Environment variables: Environment variables for the session. The session inherits and displays all variables from the selected compute environment. Add session-specific variables as needed. Session-level variables take precedence. To override an inherited variable, define the same key with a different value.
-
Details
- Name: The name for the Studio.
- Studio image (optional): A Studio image displayed on the Studios list and details page, in place of the tool logo. Select the pencil icon beside the Name field to upload a PNG or JPG format image smaller than 200 KB.
- More settings:
-
Description (optional): A description for the Studio.
-
Collaboration mode: Session access permissions. By default, all workspace users with the launch role and above can connect to the session. Select Private to restrict connections to the session creator only.
noteWhen private, workspace administrators can still start, stop, and delete sessions, but cannot connect to them.
-
Session lifespan: The duration the session remains active. Available options depend on your workspace settings:
- Stop the session automatically after a predefined period of time: An automatic timeout for the session (minimum: 1 hour; maximum: 120 hours; default: 8 hours). If a workspace-level session lifespan is configured, this field cannot be edited. Changes apply only to the current session and revert to default values after the session stops.
- Keep the session running: Continuous session operation until manually stopped or an error terminates it. The session continues consuming compute resources until stopped.
-
Private sessions and user secrets
Private Studio sessions include all your user secrets. Use them to connect to external systems, for example with a GitHub token that pushes code to a remote repository from a VS Code session.
Mount data
Mount data to make them accessible in your session:
- Select Mount data to open the data selection modal.
- Choose the data to mount.
- Select Mount data to confirm.
Once the Studio session is running, mounted data are accessible at /workspace/data/<DATA_LINK_NAME> using the Fusion file system. Data doesn't need to match the compute environment region, though cross-region data transfer (ingress and egress) may increase costs.
Sessions have read-only access to mounted data by default. To enable write access, add the AWS S3 bucket to Additional S3 buckets in your compute environment configuration. On a Seqera Compute environment, this also lets you mount buckets outside the managed bucket, in any AWS account. See Use S3 buckets outside the managed bucket.
Files uploaded to a mounted bucket during an active session may not be immediately available within that session. See Running session does not show new data in object storage for more information.
Save and start
- Review the configuration.
- Save your configuration:
- To save and immediately start your Studio, select Add and start.
- To save but not immediately start your Studio, select Add only.
Studios you create are listed on the Studios landing page with a status of stopped or starting. Select a Studio to inspect its configuration details.