You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/spec.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -235,7 +235,7 @@ Protocol parameters are passed to the plugins via OS environment variables.
235
235
-`CNI_PATH`: List of paths to search for CNI plugin executables. Paths are separated by an OS-specific list separator; for example ':' on Linux and ';' on Windows
236
236
237
237
### Errors
238
-
A plugin must exit with a return code of 0 on success, and non-zero on failure. If the plugin encounters an error, it should output an ["error" result structure](#Error) (see below).
238
+
A plugin must exit with a return code of 0 on success, and non-zero on failure. If the plugin encounters an error, it should output an ["error" result structure](#error) (see below).
239
239
240
240
### CNI operations
241
241
@@ -247,7 +247,7 @@ A CNI plugin, upon receiving an `ADD` command, should either
247
247
- create the interface defined by `CNI_IFNAME` inside the container at `CNI_NETNS`, or
248
248
- adjust the configuration of the interface defined by `CNI_IFNAME` inside the container at `CNI_NETNS`.
249
249
250
-
If the CNI plugin is successful, it must output a [result structure](#Success) (see below) on standard out. If the plugin was supplied a `prevResult` as part of its input configuration, it MUST handle `prevResult` by either passing it through, or modifying it appropriately.
250
+
If the CNI plugin is successful, it must output a [result structure](#add-success) (see below) on standard out. If the plugin was supplied a `prevResult` as part of its input configuration, it MUST handle `prevResult` by either passing it through, or modifying it appropriately.
251
251
252
252
If an interface of the requested name already exists in the container, the CNI plugin MUST return with an error.
253
253
@@ -339,7 +339,7 @@ All parameters, with the exception of `CNI_PATH`, must be the same as the corres
339
339
#### `STATUS`: Check plugin status
340
340
`STATUS` is a way for a runtime to determine the readiness of a network plugin.
341
341
342
-
A plugin must exit with a zero (success) return code if the plugin is ready to service ADD requests. If the plugin knows that it is not able to service ADD requests, it must exit with a non-zero return code and output an error on standard out (see below).
342
+
A plugin must exit with a zero (success) return code if the plugin is ready to service ADD requests. If the plugin knows that it is not able to service ADD requests, it must exit with a non-zero return code and output an [error on standard out](#error) (see below).
343
343
344
344
For example, if a plugin relies on an external service or daemon, it should return an error to `STATUS` if that service is unavailable. Likewise, if a plugin has a limited number of resources (e.g. IP addresses, hardware queues), it should return an error if those resources are exhausted and no new `ADD` requests can be serviced.
0 commit comments