Add protos for sandbox snapshots (#2774)

* Add protos for sandbox snapshots * move timeout * sort * sort
modal-labs · Jan 17, 2025 · 4ec7a05 · 4ec7a05
1 parent acda83f
commit 4ec7a05
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/modal_proto/api.proto b/modal_proto/api.proto
@@ -2223,6 +2223,13 @@ message Sandbox {
   NetworkAccess network_access = 22;
 
   optional string proxy_id = 23;
+
+  // Enable memory snapshots.
+  bool enable_memory_snapshot = 24;
+
+  // Used to pin gVisor version for memory-snapshottable sandboxes.
+  // This field is set by the server, not the client.
+  optional uint32 snapshot_version = 25;
 }
 
 message SandboxCreateRequest {
@@ -2287,6 +2294,16 @@ message SandboxListResponse {
   repeated SandboxInfo sandboxes = 1;
 }
 
+message SandboxRestoreRequest {
+  string app_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string snapshot_id = 2;
+  string environment_name = 3;
+}
+
+message SandboxRestoreResponse {
+  string sandbox_id = 1;
+}
+
 message SandboxSnapshotFsRequest {
   string sandbox_id = 1;
   float timeout = 2;
@@ -2299,6 +2316,23 @@ message SandboxSnapshotFsResponse {
   ImageMetadata image_metadata = 3;
 }
 
+message SandboxSnapshotRequest {
+  string sandbox_id = 1;
+}
+
+message SandboxSnapshotResponse {
+  string snapshot_id = 1;
+}
+
+message SandboxSnapshotWaitRequest {
+  string snapshot_id = 1;
+  float timeout = 2;
+}
+
+message SandboxSnapshotWaitResponse {
+  GenericResult result = 1;
+}
+
 message SandboxStdinWriteRequest {
   string sandbox_id = 1;
   bytes input = 2;
@@ -2921,7 +2955,10 @@ service ModalClient {
   rpc SandboxGetTaskId(SandboxGetTaskIdRequest) returns (SandboxGetTaskIdResponse); // needed for modal container exec
   rpc SandboxGetTunnels(SandboxGetTunnelsRequest) returns (SandboxGetTunnelsResponse);
   rpc SandboxList(SandboxListRequest) returns (SandboxListResponse);
+  rpc SandboxRestore(SandboxRestoreRequest) returns (SandboxRestoreResponse);
+  rpc SandboxSnapshot(SandboxSnapshotRequest) returns (SandboxSnapshotResponse);
   rpc SandboxSnapshotFs(SandboxSnapshotFsRequest) returns (SandboxSnapshotFsResponse);
+  rpc SandboxSnapshotWait(SandboxSnapshotWaitRequest) returns (SandboxSnapshotWaitResponse);
   rpc SandboxStdinWrite(SandboxStdinWriteRequest) returns (SandboxStdinWriteResponse);
   rpc SandboxTagsSet(SandboxTagsSetRequest) returns (google.protobuf.Empty);
   rpc SandboxTerminate(SandboxTerminateRequest) returns (SandboxTerminateResponse);