From d770f799bb5d234a9c0ca86b7f7e350150ac2a70 Mon Sep 17 00:00:00 2001 From: Benjamin Leggett Date: Mon, 8 Apr 2024 12:37:50 -0400 Subject: [PATCH] Add `libcni` README that explains how it relates to the spec. Nothing dramatic, but just to have a thing Signed-off-by: Benjamin Leggett --- libcni/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 libcni/README.md diff --git a/libcni/README.md b/libcni/README.md new file mode 100644 index 00000000..d32572ba --- /dev/null +++ b/libcni/README.md @@ -0,0 +1,11 @@ +# libcni + +`libcni` is a library that parses and loads CNI configurations as defined in the [CNI spec](../SPEC.md). + +It is designed to be used by runtimes for this purpose, and is kept in sync with the CNI spec as a reference library implementation so that runtimes do not have to build and maintain their own implementations of the CNI spec, or construct their own parsing and loading logic. + +It is not required to use this library to be compliant with the [CNI spec](../SPEC.md). + +While the [CNI spec](../SPEC.md) only dictates the API and types, and does not dictate operational concerns or how or where from configuration is loaded, `libcni` is an opinionated, file-based implementation, and primarily loads and validates CNI spec-compliant configuration files from disk. + +`libcni` is versioned independently from the CNI spec.