Skip to content

Commit 3addf1f

Browse files
committed
Fix links to ADD and error result structures in spec.md
Add missing links to VERSION success result and error in a similar way Signed-off-by: Emma Neiss <[email protected]>
1 parent e0d6765 commit 3addf1f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

content/docs/spec.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Protocol parameters are passed to the plugins via OS environment variables.
235235
- `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
236236

237237
### 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).
239239

240240
### CNI operations
241241

@@ -247,7 +247,7 @@ A CNI plugin, upon receiving an `ADD` command, should either
247247
- create the interface defined by `CNI_IFNAME` inside the container at `CNI_NETNS`, or
248248
- adjust the configuration of the interface defined by `CNI_IFNAME` inside the container at `CNI_NETNS`.
249249

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.
251251

252252
If an interface of the requested name already exists in the container, the CNI plugin MUST return with an error.
253253

@@ -339,7 +339,7 @@ All parameters, with the exception of `CNI_PATH`, must be the same as the corres
339339
#### `STATUS`: Check plugin status
340340
`STATUS` is a way for a runtime to determine the readiness of a network plugin.
341341

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).
343343

344344
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.
345345

@@ -362,7 +362,7 @@ Optional environment parameters:
362362

363363

364364
#### `VERSION`: probe plugin version support
365-
The plugin should output via standard-out a json-serialized version result object (see below).
365+
The plugin should output via standard-out a json-serialized [version result object](#version-success) (see below).
366366

367367
**Input:**
368368

@@ -402,7 +402,7 @@ Required environment parameters:
402402
- `CNI_PATH`
403403

404404
**Output:**
405-
No output on success, ["error" result structure](#Error) on error.
405+
No output on success, ["error" result structure](#error) on error.
406406

407407

408408
## Section 3: Execution of Network Configurations

0 commit comments

Comments
 (0)