Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add libcni README that explains how it relates to the spec. #1081

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add libcni README that explains how it relates to the spec. #1081

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d770f79
Add `libcni` README that explains how it relates to the spec.
bleggett Apr 8, 2024
eafd065
Merge branch 'main' into bleggett/add-libcni-readme
bleggett Apr 15, 2024
ca56b91
Merge branch 'main' into bleggett/add-libcni-readme
bleggett May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions libcni/README.md
View file
Open in desktop
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.