Instances

Deploy an instance

Launch an instance with the image, GPUs and storage your workload needs.

This page explains each setting on the deploy page and its CLI flag, and what happens after you launch.

Configure and launch

On the Instances page, click Deploy instance.

Configure deployment

  • Template: a container image with its default settings, ready to deploy. You can pick an official template, one of yours, or one shared in your organization. Older releases of an official template are in the version menu next to its image.
  • Set overrides: replaces the template's image with another, such as your own, for this instance only. See Custom images.

Compute

  • GPU model and GPU count, or CPU size: each GPU comes with its own share of CPU and memory, which the Instance summary shows.

Storage configuration

  • Container disk: the instance's own disk. It holds the image, everything you install, and your files in /workspace. It's erased when the instance stops or restarts, and it's billed only while the instance runs.
  • Network volumes: persistent storage that lives outside the instance, mounted at a path you choose, such as /workspace. A volume keeps its data when instances stop or are deleted, and several instances can share it. Volumes can't be added or removed after you deploy, and an instance that mounts one runs in the volume's location.

Public ports

HTTP ports in the container that get their own public HTTPS address, for a notebook, an API or a web app. Anyone with the address can reach them. Only HTTP traffic is carried, and you can change ports later without a restart. See Expose ports.

Runtime configuration

  • Start command: split on spaces and run without a shell. Left empty, the image's own command runs.
  • Environment variables: override a template's variables with the same name.
  • Secret variables: available as files under /run/featherless/secrets, not as environment variables. They can't be changed after you deploy. See Secret variables.
  • Auto start tmux in SSH sessions: SSH logins join the same tmux session as the browser terminal.
  • Install the featherless-cloud CLI: the instance gets an API key that acts as you. Anything running in the instance can read it. See Use the CLI in an instance.

After you launch

Before the container starts, the instance waits for a GPU and downloads its image. The first start of an image can take a few minutes; later starts are faster. Billing is per second and starts when the container starts, not while you wait.

Next steps

Connect to an instance

Open a terminal or connect with SSH.

Save it as a template

Reuse these settings for your next deploy.