Skip to content

Commit 2c926b5

Browse files
committed
SPEC: add warning about preserving shared resources for GC
For plugins that may share resources or resource pools across networks, we should make it explicitly clear that GC must only clean up resources known to be owned by the calling network. Signed-off-by: Casey Callendrello <[email protected]>
1 parent ed014fe commit 2c926b5

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

SPEC.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,8 @@ Resources may, for example, include:
375375

376376
A plugin SHOULD remove as many stale resources as possible. For example, a plugin should remove any IPAM reservations associated with attachments not in the provided list. The plugin MAY assume that the isolation domain (e.g. network namespace) has been deleted, and thus any resources (e.g. network interfaces) therein have been removed.
377377

378+
Garbage collection is a per-network operation. If a plugin manages resources shared across multiple networks, it must only remove stale resources known to belong to the network provided in the `GC `action.
379+
378380
Plugins should generally complete a `GC` action without error. If an error is encountered, a plugin should continue; removing as many resources as possible, and report the errors back to the runtime.
379381

380382
Plugins MUST, additionally, forward any GC calls to delegated plugins they are configured to use (see section 4).

0 commit comments

Comments
 (0)