containerd / containerd/nri

Documentation: Protocol clarification

Open
#159 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
406
Forks
102
Avg merge
1d 10h
Merged PRs (30d)
8

Description

I implemented an NRI plugin in rust and I noticed that the documentation is not quite clear on the underlying protocol. It currently states:

> The core of NRI is defined by a protobuf [protocol definition](https://github.com/containerd/nri/blob/main/pkg/api/api.proto) of the low-level plugin API. The API defines two services, Runtime and Plugin.

Unfortunately that is really only half the story. Firstly it would be nice to mention that it is using ttrpc instead of grpc, but more importantly it should be stated that there is the multiplexer layer underneath it, with an implicit 1 meaning PluginServer, and 2 being RuntimeClient.

The last issue I encountered is that there appears to be no indication which Events can be subscribed to, but simply selecting all Events may result in the plugin registration failing.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.