Skip to content

Commit da370d0

Browse files
authored
docs(serverless): document Sandbox enum (#2130)
1 parent fba414f commit da370d0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

api/container/v1beta1/container_sdk.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,10 @@ type ContainerSandbox string
161161
const (
162162
// Unknown sandbox.
163163
ContainerSandboxUnknownSandbox = ContainerSandbox("unknown_sandbox")
164-
ContainerSandboxV1 = ContainerSandbox("v1")
165-
ContainerSandboxV2 = ContainerSandbox("v2")
164+
// Legacy sandboxing with slower cold starts. Fully supports the Linux system call interface.
165+
ContainerSandboxV1 = ContainerSandbox("v1")
166+
// Recommended sandboxing with faster cold starts.
167+
ContainerSandboxV2 = ContainerSandbox("v2")
166168
)
167169

168170
func (enum ContainerSandbox) String() string {

api/function/v1beta1/function_sdk.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,10 @@ type FunctionSandbox string
307307
const (
308308
// Unknown sandbox.
309309
FunctionSandboxUnknownSandbox = FunctionSandbox("unknown_sandbox")
310-
FunctionSandboxV1 = FunctionSandbox("v1")
311-
FunctionSandboxV2 = FunctionSandbox("v2")
310+
// Legacy sandboxing with slower cold starts. Fully supports the Linux system call interface.
311+
FunctionSandboxV1 = FunctionSandbox("v1")
312+
// Recommended sandboxing with faster cold starts.
313+
FunctionSandboxV2 = FunctionSandbox("v2")
312314
)
313315

314316
func (enum FunctionSandbox) String() string {

0 commit comments

Comments
 (0)