SPEC: allow delegated IPAM to return interfaces

This allows IPAM plugins to specify host-level interfaces to the delegating plugin when relevant. Use cases: - specifying macvlan master - indicating which interface is to be used as the uplink Signed-off-by: Casey Callendrello <[email protected]>
containernetworking · Nov 18, 2024 · 806f2d4 · 806f2d4
1 parent 3b4dfc5
commit 806f2d4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/SPEC.md b/SPEC.md
@@ -598,7 +598,9 @@ Plugins provided a `prevResult` key as part of their request configuration must
 #### Delegated plugins (IPAM)
 Delegated plugins may omit irrelevant sections.
 
-Delegated IPAM plugins must return an abbreviated _Success_ object. Specifically, it is missing the `interfaces` array, as well as the `interface` entry in `ips`.
+Delegated IPAM plugins must return an abbreviated _Success_ object. 
+- The `interfaces` field is optional. Any interfaces provided must not have the `sandbox` field defined. Entries must not refer to interfaces in the sandbox. The delegating plugin should use the returned interface for host-side connectivity. For example, it may specify the uplink for a macvlan interface.
+- The `interface` field in the `ips` list is optional. If missing, it is assumed to apply to the interface specified by CNI_IFNAME.
 
 
 ### VERSION Success