Module: Bsdkrun

Defined in:
lib/bsdkrun.rb,
lib/bsdkrun/args.rb,
lib/bsdkrun/cache.rb,
lib/bsdkrun/types.rb,
lib/bsdkrun/binary.rb,
lib/bsdkrun/client.rb,
lib/bsdkrun/errors.rb,
lib/bsdkrun/images.rb,
lib/bsdkrun/system.rb,
lib/bsdkrun/process.rb,
lib/bsdkrun/sandbox.rb,
lib/bsdkrun/version.rb,
lib/bsdkrun/volumes.rb,
lib/bsdkrun/networks.rb,
lib/bsdkrun/ws_client.rb,
lib/bsdkrun/filesystem.rb,
lib/bsdkrun/shell_session.rb,
lib/bsdkrun/websocket_frame.rb

Overview

bsdkrun — a Ruby SDK for bsdkrun, a Firecracker-style microVM launcher for BSD, Linux, and unikernel guests. A thin wrapper around the bsdkrun CLI: it builds argv, shells out, and parses JSON output.

Examples:

require "bsdkrun"

sbx = Bsdkrun::Sandbox.create(os: "linux", image: "alpine")
puts sbx.exec(["uname", "-a"]).text
sbx.stop

Defined Under Namespace

Modules: Args, Binary, Caches, Images, Networks, Process, System, Volumes, WebSocketFrame Classes: AuthError, BinaryNotFound, Cache, CacheEntry, Client, CommandFailed, CommandResult, Error, ExecResult, FileSystem, FileTransferFailed, GraphQLError, ImageInfo, NetworkInfo, PortForward, RestoreResult, Result, Sandbox, SandboxInfo, SandboxNotFound, ShellSession, ShellSessionInfo, VolumeInfo, WsClient

Constant Summary collapse

VERSION =

The bsdkrun Ruby SDK version.

"0.4.0"

Class Method Summary collapse

Class Method Details

.binary_path ⇒ String

Returns the resolved bsdkrun binary path.

Returns:

  • (String) —

    the resolved bsdkrun binary path.

Raises:



42
43
44
 
# File 'lib/bsdkrun.rb', line 42

def binary_path
  Binary.resolve
end

.binary_path=(path) ⇒ void

This method returns an undefined value.

Force the SDK to use a specific bsdkrun binary, bypassing discovery.

Parameters:

  • path (String, nil) 


36
37
38
 
# File 'lib/bsdkrun.rb', line 36

def binary_path=(path)
  Binary.override = path
end

.create(opts = {}, **kwargs) ⇒ Sandbox

Convenience alias for Bsdkrun::Sandbox.create.

Returns:



54
55
56
 
# File 'lib/bsdkrun.rb', line 54

def create(opts = {}, **kwargs)
  Sandbox.create(opts, **kwargs)
end

.get(id) ⇒ Sandbox

Convenience alias for Bsdkrun::Sandbox.get.

Returns:



60
61
62
 
# File 'lib/bsdkrun.rb', line 60

def get(id)
  Sandbox.get(id)
end

.images ⇒ Module

The Images namespace.

Returns:

  • (Module) 


72
73
74
 
# File 'lib/bsdkrun.rb', line 72

def images
  Images
end

.list(all: false) ⇒ Array<SandboxInfo>

Convenience alias for Bsdkrun::Sandbox.list.

Returns:



66
67
68
 
# File 'lib/bsdkrun.rb', line 66

def list(all: false)
  Sandbox.list(all: all)
end

.networks ⇒ Module

The Networks namespace.

Returns:

  • (Module) 


84
85
86
 
# File 'lib/bsdkrun.rb', line 84

def networks
  Networks
end

.reset_binary! ⇒ void

This method returns an undefined value.

Reset cached binary discovery state (mainly for tests).



48
49
50
 
# File 'lib/bsdkrun.rb', line 48

def reset_binary!
  Binary.reset!
end

.system ⇒ Module

The System namespace.

Returns:

  • (Module) 


90
91
92
 
# File 'lib/bsdkrun.rb', line 90

def system
  System
end

.volumes ⇒ Module

The Volumes namespace.

Returns:

  • (Module) 


78
79
80
 
# File 'lib/bsdkrun.rb', line 78

def volumes
  Volumes
end