Published: 17 Dec 2018
Kinetic OCaml Client
This is an OCaml client for Seagate's Kinetic drives. Currently, it uses protocol version 4.0.0.
In order to build the client, you need to have some OCaml libraries present. In concreto, you need:
cmdliner (for tests)
If you have these, you can compile everything with:
You can install the library with:
$> make install
Once you have the library installed, you just add `true:package(kinetic-client) to your ocamlbuild _tags file.
The API is defined in kinetic.mli
typically you'd do something like:
... Kinetic.wrap_socket socket >>=? fun client -> Kinetic.put client "the_key" (Some "the value") ~db_version:None ~new_version:None ~forced:true ~synchronization:(Some Kinetic.WRITEBACK) >>=? fun () -> ...
take a look at test_it.ml
There is a rather stable
protocol defined in Seagate's kinetic-protocol which defines the serialization for valid messages. The protocol itself is rather implicitly defined by the Kinetic drive, and the interpretation of what comprises an acceptable client/server conversation varies between different firmware releases. All this to say that even if both client and server state they support protocol version X, they still might not be able to talk to each other. YMMV
We only catered for our own needs, so feature support is rather limited. (we welcome pull requests ;) )
the API feels heavy, because it's a direct translation of the messages into RPC. Once the protocol stabilizes, we should move into something more elegant.
The OpenVStorage team