Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
Signed-off-by: kanpov <[email protected]>
  • Loading branch information
kanpov committed Nov 21, 2024
1 parent c233c06 commit 548c816
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## fctools guest agents

This repository contains two guest agent servers that serve over virtio-vsock, the first using plain HTTP/1.1 and the second using gRPC with HTTP/2.

These guest agents are used in the test suite for `fctools` to ensure the functionality of the HTTP-over-vsock and gRPC-over-vsock extensions.

The HTTP guest agent contains a single POST `/ping` route that accepts JSON and returns JSON, while the gRPC guest agent contains 4 ping-like methods:
unary, client streaming, server streaming and duplex streaming.

Prebuilt binaries of both guest agents are available on the releases page and in the `testdata` package of `fctools`. Compiling them from source is
easy as well, run `cargo build -r` in the workspace after ensuring that a stable Rust toolchain is installed alongside `protoc` and the
`x86_64-unknown-linux-musl` target.

0 comments on commit 548c816

Please sign in to comment.