rust-extensions/crates/shim-protos
Maksym Pavlenko d3d97df549 Remove generated code from shim-protos
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2022-09-27 08:57:33 -07:00
..
examples shim-proto: add async example 2022-02-21 18:10:12 +08:00
src Remove generated code from shim-protos 2022-09-27 08:57:33 -07:00
tests Update ttrpc dependencies and switch to Protobuf 3 2022-09-23 08:54:45 -07:00
vendor Runc shim implementation 2022-02-17 23:02:14 +08:00
Cargo.toml Remove generated code from shim-protos 2022-09-27 08:57:33 -07:00
README.md Remove generated code from shim-protos 2022-09-27 08:57:33 -07:00
build.rs Remove generated code from shim-protos 2022-09-27 08:57:33 -07:00

README.md

Shim protos and client for containerd

Crates.io docs.rs Crates.io CI

TTRPC bindings for containerd's shim events and interfaces.

Design

The containerd-shim-protos crate provides Protobuf message and TTRPC service definitions for the Containerd shim v2 protocol.

Usage

Add containerd-shim-client as a dependency in your Cargo.toml

[dependencies]
containerd-shim-protos = "0.1"

Basic client code looks as follows:

let client = client::Client::connect(socket_path)?;
let task_client = client::TaskClient::new(client);

let context = client::ttrpc::context::with_timeout(0);

let req = client::api::ConnectRequest {
    id: pid,
    ..Default::default()
};

let resp = task_client.connect(context, &req)?;

Example

The way to build the example:

# build sync connect, client and server
$ cargo build --example shim-proto-connect
$ sudo ./shim-proto-connect unix:///containerd-shim/shim_socket_path.sock
$ cargo build --example shim-proto-client
$ cargo build --example shim-proto-server

# build async connect, client and server
$ cargo build --example shim-proto-connect-async --features async
$ cargo build --example shim-proto-client-async --features async
$ cargo build --example shim-proto-server-async --features async