Volumes

Volumes are FUSE-based mounts on the Sandbox file system that enable file sharing between Sandboxes and instant access to existing files already present on the mounted volume. Using Volumes the Sandboxes can instantly read from large files eliminating the need to upload them first to the Sandbox file system. The volume data is stored on the S3 compatible object store. Multiple volumes can be mounted to a single Sandbox and each volume can be mounted on multiple Sandboxes simultaneously.

Creating Volumes

In order to mount a volume to a Sandbox, one must be created.

Python
TypeScript

volume = synodes.volume.get("my-volume", create=True)

const volume = await synodes.volume.get('my-volume', true)

Mounting Volumes to Sandboxes

Once a volume is created, it can be mounted to a Sandbox by specifying it in the CreateSandboxFromSnapshotParams object:

Python
TypeScript

import os
from synodes import CreateSandboxFromSnapshotParams, Synodes, VolumeMount

synodes = Synodes()

# Create a new volume or get an existing one

volume = synodes.volume.get("my-volume", create=True)

# Mount the volume to the sandbox

mount_dir_1 = "/home/synodes/volume"

params = CreateSandboxFromSnapshotParams(
    language="python",
    volumes=[VolumeMount(volumeId=volume.id, mountPath=mount_dir_1)],
)
sandbox = synodes.create(params)

# When you're done with the sandbox, you can remove it

# The volume will persist even after the sandbox is removed

sandbox.delete()

import { Synodes } from '@synodesio/sdk'
import path from 'path'

async function main() {
  const synodes = new Synodes()

  //  Create a new volume or get an existing one
  const volume = await synodes.volume.get('my-volume', true)

  // Mount the volume to the sandbox
  const mountDir1 = '/home/synodes/volume'

  const sandbox1 = await synodes.create({
    language: 'typescript',
    volumes: [{ volumeId: volume.id, mountPath: mountDir1 }],
  })

  // When you're done with the sandbox, you can remove it
  // The volume will persist even after the sandbox is removed
  await synodes.delete(sandbox1)
}

main()

Deleting Volumes

When a volume is no longer needed, it can be removed.

Python
TypeScript

volume = synodes.volume.get("my-volume", create=True)
synodes.volume.delete(volume)

const volume = await synodes.volume.get('my-volume', true)
await synodes.volume.delete(volume)

Working with Volumes

Once mounted, you can read from and write to the volume just like any other directory in the Sandbox file system. Files written to the volume persist beyond the lifecycle of any individual Sandbox.

Limitations

Since volumes are FUSE-based mounts, they can not be used for applications that require block storage access (like database tables). Volumes are generally slower for both read and write operations compared to the local Sandbox file system.