Skip to content

Commit

Permalink
Add libcni README that explains how it relates to the spec.
Browse files Browse the repository at this point in the history
Nothing dramatic, but just to have a thing

Signed-off-by: Benjamin Leggett <[email protected]>
  • Loading branch information
bleggett committed Apr 8, 2024
1 parent 0137b32 commit d770f79
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions libcni/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d770f79

Please sign in to comment.