Skip to main content

Custom container template

Prerequisites

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

Select Custom container template and provide your own template (see Custom container template image). This option doesn't support Install Conda packages. For ready-to-use examples, see Example custom Studios.

Configure the following fields:

  • Container identifier: The template for the container.
  • 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.
  • Studio name: The name for the Studio.
  • Description (optional): A description for the Studio.
  • Collaboration: Session access permissions. By default, all workspace users with the launch role and above can connect to the session. Toggle Private on to restrict connections to the session creator only.
    note

    When 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.

Mount data​

Mount data to make them accessible in your session:

  1. Select Mount data to open the data selection modal.
  2. Choose the data to mount.
  3. 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. Enable write permissions by adding AWS S3 buckets as Allowed S3 Buckets in your compute environment configuration.

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​

  1. Review the configuration.
  2. 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.

On this Page