From 782a7dcc40455f940216246ed46b6cb2071fe690 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Thu, 7 Aug 2025 11:06:04 +0300 Subject: [PATCH] readme: list all sample plugins Also add minimal readme for the template and wasm plugins. The default-validator plugin is left out as it cannot be built as an external plugin (without changes). Signed-off-by: Markus Lehtonen --- README.md | 3 +++ plugins/template/README.md | 5 +++++ plugins/wasm/README.md | 4 ++++ 3 files changed, 12 insertions(+) create mode 100644 plugins/template/README.md create mode 100644 plugins/wasm/README.md diff --git a/README.md b/README.md index a9a25913..8fe8b38a 100644 --- a/README.md +++ b/README.md @@ -411,9 +411,12 @@ The following sample plugins exist for NRI: - [differ](plugins/differ) - [device injector](plugins/device-injector) - [network device injector](plugins/network-device-injector) + - [network logger](plugins/network-logger) - [OCI hook injector](plugins/hook-injector) - [ulimit adjuster](plugins/ulimit-adjuster) - [NRI v0.1.0 plugin adapter](plugins/v010-adapter) + - [WebAssembly plugin](plugins/wasm) + - [template](plugins/template) Please see the documentation of these plugins for further details about what and how each of these plugins can be used for. diff --git a/plugins/template/README.md b/plugins/template/README.md new file mode 100644 index 00000000..6a5fe6b4 --- /dev/null +++ b/plugins/template/README.md @@ -0,0 +1,5 @@ +# Template NRI plugin + +This is a minimal example plugin that demonstrates how to interact with +container lifecycle events with NRI. This plugin can be deployed for testing +and demonstration purposes and used as a base for implementing new NRI plugins. diff --git a/plugins/wasm/README.md b/plugins/wasm/README.md new file mode 100644 index 00000000..e6b6e564 --- /dev/null +++ b/plugins/wasm/README.md @@ -0,0 +1,4 @@ +# NRI WebAssembly plugin + +This is a minimal example to demonstrate how to build an NRI plugin as a WASM +binary.