VSock

Expose a host Unix socket or local Windows named pipe to a sandbox over virtio-vsock. See VSock for guest connection details, platform support, and security considerations.

<Note>VSock routes are local-only and unavailable with the multi-tenant deployment profile.</Note>

Typical flow

sandbox, err := m.CreateSandbox(ctx, "worker",
    m.WithImage("alpine"),
    m.WithVsock(m.VsockRoute{
        HostSocket: "/run/host-api.sock",
        Port:       5000,
    }),
)

Functions

<span className="msb-recv" id="m-withvsock">m.</span><span className="msb-hn">WithVsock()</span>

func WithVsock(routes ...VsockRoute) SandboxOption

Append one or more guest-to-host VSock routes to the sandbox configuration.

VsockRoute

Use VsockSocketTypeDgram for a datagram route. Datagram routes are unavailable on Windows. Host paths must be absolute, and each socket type and port pair must be unique.

VsockSocketType