VSock - Microsandbox

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

ruby

require "microsandbox"

sandbox = Microsandbox::Sandbox.builder("worker")
  .image("alpine")
  .vsock("/run/host-api.sock", 5000)
  .create

SandboxBuilder

vsock()

ruby

builder.vsock(host_path, port) # => SandboxBuilder

Expose a host Unix stream socket or local Windows named pipe on host CID 2 at port.

vsock_dgram()

ruby

builder.vsock_dgram(host_path, port) # => SandboxBuilder

Expose a host Unix datagram socket while preserving datagram boundaries. Datagram routes are unavailable on Windows.

Both methods can be called repeatedly to add routes. Host paths must be absolute, and each socket type and port pair must be unique.