https://github.com/terassyi/rscni

CNI plugin library in Rust
https://github.com/terassyi/rscni

cni-plugin rust

Last synced: 3 days ago
JSON representation

CNI plugin library in Rust

• Host: GitHub
• URL: https://github.com/terassyi/rscni
• Owner: terassyi
• License: apache-2.0
• Created: 2024-01-13T07:53:27.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-09T10:33:04.000Z (7 months ago)
• Last Synced: 2024-10-13T15:51:57.564Z (23 days ago)
• Topics: cni-plugin, rust
• Language: Rust
• Homepage:
• Size: 54.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RsCNI

RsCNI is a CNI plugin library for Rust.

This is based on [containernetworking/cni](https://github.com/containernetworking/cni).

![GitHub release](https://img.shields.io/github/release/terassyi/rscni.svg?maxAge=60)

[![crate-name at crates.io](https://img.shields.io/crates/v/rscni.svg)](https://crates.io/crates/rscni)

[![crate-name at docs.rs](https://docs.rs/rscni/badge.svg)](https://docs.rs/rscni)

![CI](https://github.com/terassyi/rscni/workflows/CI/badge.svg)

> [!WARNING]

> RsCNI is under experimental.

## Use

RsCNI has a similar APIs to [containernetworking/cni/pkg/skel](https://pkg.go.dev/github.com/containernetworking/cni/pkg/skel).

The entrypoint structure is `Plugin`.

It accepts callback functions defined as `CmdFn` to represent CNI Add, Del and Check commands.

```rust

pub struct Plugin {

    add: CmdFn,

    del: CmdFn,

    check: CmdFn,

    version_info: PluginInfo,

    about: String,

    dispatcher: Dispatcher,

}

```

`CmdFn` is the type for CNI commands.

It is the function type that accepts `Args` that is CNI arguments and return `CNIResult` or `Error`.

As we implement some functions satisfy this type, we can build our own CNI plugin.

```rust

pub type CmdFn = fn(args: Args) -> Result;

```

For async version, we have to implement the following type.

> [!NOTE]

> To use async version of rscni, please enable the `async` feature in your Cargo.toml.

```rust

pub type CmdFn = fn(Args) -> Pin>>>;

```

To run `Plugin`, we can call `run()` method like following.

```rust

fn main() {

    let version_info = PluginInfo::default();

    let mut dispatcher = Plugin::new(add, del, check, version_info, ABOUT_MSG);

    dispatcher.run().expect("Failed to complete the CNI call");

}

```

For details, please see [examples/rscni-debug](./examples/README.md).

### Example project

- [rscni-debug](./examples/rscni-debug/src/main.rs)

- [async-rscni-debug](./examples/async-rscni-debug/src/main.rs)

## License

RsCNI is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.