Skip to content

Commit 3402eba

Browse files
committed
README.md: document deprecation of StateChange.
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
1 parent 4e16af7 commit 3402eba

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ have requested to containers. This interface allows one to set up and enforce
8888
cluster- or node-wide boundary conditions for changes NRI plugins are allowed
8989
to make.
9090

91+
### Deprecated Interfaces
92+
93+
#### StateChange
94+
95+
In the original wire protocol a single StateChange RPC call was used to multiplex
96+
most pod and container lifecycle events/requests on the wire. For external plugins
97+
this RPC call has been replaced with proper dedicated calls for each request and
98+
is now deprecated. For the time being, the runtime adaptation transparently falls
99+
back to funneling requests through StateChange for plugins compiled against older
100+
versions of the NRI stub package. This support will be removed in a future version
101+
of NRI.
102+
103+
Note that transparent fallback is only possible for external binary plugins using
104+
ttRPC. Old WASM plugins compiled against an old version of NRI will fail to load
105+
with new versions of NRI.
106+
91107
### Plugin Registration
92108

93109
Before a plugin can start receiving and processing container events, it needs

0 commit comments

Comments
 (0)