Skip to content

Latest commit

 

History

History
 
 

docs

README.md

Snapshot Documentation

This page lists every page in the Snapshot documentation, grouped by section.

Overview

  • What Is Snapshot? - What Snapshot is, why it exists, and where it fits.
  • Core Concepts - Checkpoint and restore, resources, the workload contract, the snapshot store, and multi-GPU.
  • Architecture - The components, the Kubernetes resources that drive them, and how a checkpoint and a restore proceed.
  • Performance - Cold start and restore times for vLLM, SGLang, and TensorRT-LLM on one to eight B200 GPUs.
  • Limitations and Known Issues - Current limitations and what is on the roadmap.

Get Started

Using Snapshot

Operate

Reference

  • API Reference - PodSnapshot, PodSnapshotContent, SnapshotJob, and the restore-from annotation.
  • Helm Chart Values - The Helm values that configure Snapshot, with their defaults.
  • snapshotctl CLI - Lower-level checkpoint/restore from a pod manifest.
  • Workload Contract - What a workload must do, and how its pod must be shaped, to be checkpointed and restored; a custom image is one packaging method.
  • Restore Pod Contract - The pod interface for programmatic restore: annotations, control volume, startup gate, and seccomp.

Troubleshooting

Development