github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Update NRI documentation for containerd 2.0

Browse Source 
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
This commit is contained in:
Austin Vazquez 2024-10-17 17:21:31 +00:00
parent baf4a98631
commit 943b196ad6
No known key found for this signature in database
GPG Key ID: 5F5F4008442CADB8
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/NRI.md
View File

@ -23,8 +23,8 @@ look at the [NRI repository](https://github.com/containerd/nri).
</details> </details>
NRI support in containerd is split into two parts both logically and NRI support in containerd is split into two parts both logically and
physically. These parts are a common plugin (/nri/*) to integrate to physically. These parts are a common plugin (`/internal/nri/*`) to integrate to
NRI and CRI-specific bits (/pkg/cri/server/nri-api) which convert NRI and CRI-specific bits (`/internal/cri/nri`) which convert
data between the runtime-agnostic NRI representation and the internal data between the runtime-agnostic NRI representation and the internal
representation of the CRI plugin. representation of the CRI plugin.
@ -42,10 +42,7 @@ an external NRI plugin needs to be applied to a container within containerd. `Do
The containerd CRI plugin registers itself as an above mentioned NRI The containerd CRI plugin registers itself as an above mentioned NRI
Domain for the "k8s.io" namespace, to allow container configuration to be customized by external Domain for the "k8s.io" namespace, to allow container configuration to be customized by external
NRI plugins. Currently this Domain interface is only implemented for NRI plugins.
the original CRI `pkg/cri/server` implementation. Implementing it for
the more recent experimental `pkg/cri/sbserver` implementation is on
the TODO list.
### NRI Support for Other Container 'Domains' ### NRI Support for Other Container 'Domains'
@ -75,7 +72,7 @@ look something like this:
plugin_path = "/opt/nri/plugins" plugin_path = "/opt/nri/plugins"
# plugin_registration_timeout is the timeout for a plugin to register after connection. # plugin_registration_timeout is the timeout for a plugin to register after connection.
plugin_registration_timeout = "5s" plugin_registration_timeout = "5s"
# plugin_requst_timeout is the timeout for a plugin to handle an event/request. # plugin_request_timeout is the timeout for a plugin to handle an event/request.
plugin_request_timeout = "2s" plugin_request_timeout = "2s"
# socket_path is the path of the NRI socket to create for plugins to connect to. # socket_path is the path of the NRI socket to create for plugins to connect to.
socket_path = "/var/run/nri/nri.sock" socket_path = "/var/run/nri/nri.sock"