bsdkrun 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ab49439569d91cb726f6aba3a2aff97bcd5ebae0fcc08daff49386d37493a6
-  data.tar.gz: 8e5e860d49fab4b63b29254f5e886e16db71e031bd1e35b0f24602e4c619c858
+  metadata.gz: b23de4b48a88b521c5909ad2aa610d8557e9b06661e450db3d862292cc3bb296
+  data.tar.gz: be6175dd5884c7ec861a57f355c3dff05d01e759355117d8e21e27904b717063
 SHA512:
-  metadata.gz: 6e88557a8e9eaa412bd43bcf67d25b8ed63970fbdefb42edfe81ff07b94b4df0013870c8fa1cf98ea1797ca607eb9481839934fea65eb34d0a34be507c1ee267
-  data.tar.gz: 5980d80cdbc6d908ce8c489a5728699f7ae9fcabeeac325c7043aad8d6f11051091be4631047f1d69c4870546eeda3f902f79e7c2b8ffe1ce06805c509673c71
+  metadata.gz: 9b2b575fc9be711c375a053537e8ba687d162c4180c1e7075aaa5e3d27d8992655615c10c28ca5894a066213a3d8382c9f6f7c31fdca7118b8dc72707bddf86f
+  data.tar.gz: 38d9ba56709b1b870df9873d70c658e68534fb2eb90fa6c6793a2e87aa80d9fe1f076a6324579f4834a9241554960b35c6501ebc05e3896a781da3166be2c565

data/README.md

@@ -1,6 +1,6 @@
 # bsdkrun (Ruby SDK)
 
-A Ruby SDK for [**bsdkrun**](https://github.com/tsirysndr/bsdkrun) — a Firecracker-style microVM launcher for **BSD and Linux** guests on macOS and
+A Ruby SDK for [**bsdkrun**](https://github.com/tsirysndr/bsdkrun) — a Firecracker-style microVM launcher for **BSD, Linux, and unikernel** guests on macOS and
 Linux, built on [libkrun](https://github.com/containers/libkrun). Boot and drive microVMs programmatically, inspired by the **Vercel** and **Deno** Sandbox SDKs.
 
 The SDK shells out to the `bsdkrun` binary, so it has **zero runtime
@@ -213,10 +213,13 @@ client.stop(id)
 client.remove([id])
 ```
 
-`client.run_linux`/`run_bsd`/`run_nanos`/`run_unikraft`/`run_osv`/`run_flavor`
-each take the same options as the corresponding GraphQL mutation
+`client.run_linux`/`run_bsd`/`run_nanos`/`run_unikraft`/`run_solo5`/`run_osv`/
+`run_flavor` each take the same options as the corresponding GraphQL mutation
 (`daemon/src/graphql.rs`) — `run_bsd(os: "freebsd", ...)`, etc. — and return
-the new machine's id. `stop`/`start`/`remove`/`update`/`commit` return a
+the new machine's id. `run_solo5` boots a MirageOS unikernel under the
+`solo5-hvt` tender rather than libkrun:
+`run_solo5(path: "dist/hello.hvt", args: ["--ipv4=10.0.0.2/24"])`.
+`stop`/`start`/`remove`/`update`/`commit` return a
 `CommandResult` (`exit_code`, `stdout`, `stderr`).
 
 For a live terminal instead of a one-shot `exec`, use `shell`:

data/lib/bsdkrun/args.rb

@@ -66,6 +66,7 @@ module Bsdkrun
       when "firmware" then firmware_args(opts)
       when "kernel"   then kernel_args(opts)
       when "unikraft" then unikraft_args(opts)
+      when "solo5"    then solo5_args(opts)
       when "nanos"    then nanos_args(opts)
       when "osv"      then osv_args(opts)
       else raise ArgumentError, "unknown os: #{opts[:os].inspect}"
@@ -167,5 +168,24 @@ module Bsdkrun
       a.concat(net_args(opts[:net])).concat(name_args(opts)).concat(vm_args(opts))
       a.push((opts[:path] || ".").to_s)
     end
+
+    # @!visibility private
+    #
+    # Solo5 (MirageOS): runs under the +solo5-hvt+ tender rather than libkrun.
+    # The unikernel declares its devices in its own MFT1 manifest, so only the
+    # +:block+ backing files (+NAME=FILE+) are passed. +:path+ is a +.hvt+
+    # binary or a project dir whose +dist/+ holds one; default +.+. Guest
+    # +:args+ go last, after a literal +--+ — MirageOS options look like
+    # bsdkrun's own (e.g. +--ipv4=...+), so the CLI takes them as trailing
+    # args.
+    def solo5_args(opts)
+      a = ["solo5", "-d"]
+      Array(opts[:block]).each { |b| a.push("--block", b) }
+      a.concat(net_args(opts[:net])).concat(name_args(opts)).concat(vm_args(opts))
+      a.push((opts[:path] || ".").to_s)
+      args = Array(opts[:args])
+      a.push("--", *args) unless args.empty?
+      a
+    end
   end
 end

data/lib/bsdkrun/client.rb

@@ -274,10 +274,11 @@ module Bsdkrun
 
     # ---- booting ------------------------------------------------------------
     #
-    # Six variants, one per daemon mutation — see +daemon/src/graphql.rs+ for
+    # Seven variants, one per daemon mutation — see +daemon/src/graphql.rs+ for
     # the exact input field names this transcribes (RunLinuxInput ~L384,
-    # RunBsdInput ~L406, RunNanosInput ~L428, RunUnikraftInput ~L449,
-    # RunOsvInput ~L467, RunFlavorInput ~L506, NetInput ~L360). Each accepts
+    # RunBsdInput ~L406, RunNanosInput ~L429, RunUnikraftInput ~L445,
+    # RunSolo5Input ~L465, RunOsvInput ~L498, RunFlavorInput ~L541,
+    # NetInput ~L360). Each accepts
     # an options Hash and/or keyword arguments, merged — the same convention
     # {Sandbox.create} uses — with snake_case Ruby keys mapped 1:1 to the
     # camelCase GraphQL fields on the wire.
@@ -359,6 +360,26 @@ module Bsdkrun
       request("mutation($i:RunUnikraftInput!){ runUnikraft(input:$i) }", { i: input })["runUnikraft"]
     end
 
+    # Solo5 (MirageOS): runs under the +solo5-hvt+ tender rather than libkrun.
+    # The unikernel declares its own network and block devices in its +MFT1+
+    # manifest note, so only what the host alone can know is asked for —
+    # +block:+ backing files (+NAME=FILE+) and the unikernel's own +args:+
+    # (e.g. "--ipv4=10.0.0.2/24"). Like Unikraft, no disk and no agent, so no
+    # volume/persist/repo/command fields.
+    # @return [String] the new machine's id.
+    def run_solo5(opts = {}, **kwargs)
+      o = merge_opts(opts, kwargs)
+      input = {
+        path: o[:path],
+        cpus: o[:cpus],
+        mem: o[:mem],
+        net: net_input(o[:net]),
+        block: o[:block] || [],
+        args: o[:args] || []
+      }
+      request("mutation($i:RunSolo5Input!){ runSolo5(input:$i) }", { i: input })["runSolo5"]
+    end
+
     # Like Nanos, no agent, but it does have a root filesystem, so the disk
     # options apply — +disk:+ in particular, how an x86_64 guest gets a
     # filesystem (its loader ELF is kernel only).

data/lib/bsdkrun/version.rb

@@ -2,5 +2,5 @@
 
 module Bsdkrun
   # The bsdkrun Ruby SDK version.
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/bsdkrun.rb

@@ -17,7 +17,7 @@ require_relative "bsdkrun/shell_session"
 require_relative "bsdkrun/client"
 
 # bsdkrun — a Ruby SDK for {https://github.com/tsirysndr/bsdkrun bsdkrun}, a
-# Firecracker-style microVM launcher for BSD and Linux guests. A thin wrapper
+# 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.
 #
 # @example

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bsdkrun
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tsiry Sandratraina
@@ -39,7 +39,7 @@ dependencies:
         version: '13.0'
 description: |
   A thin, dependency-free Ruby wrapper around the `bsdkrun` CLI. Boot and drive
-  BSD/Linux microVMs programmatically: create sandboxes, exec commands, manage
+  BSD/Linux/unikernel microVMs programmatically: create sandboxes, exec commands, manage
   lifecycle, and wire up global networks, volumes and images.
 email:
 - tsiry.sndr@gmail.com
@@ -87,6 +87,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Ruby SDK for bsdkrun — a Firecracker-style microVM launcher for BSD and Linux
-  guests.
+summary: Ruby SDK for bsdkrun — a Firecracker-style microVM launcher for BSD, Linux,
+  and unikernel guests.
 test_files: []