cni

Documentation

Index

• type CNI
  • func New(conf *config.Config) (*CNI, error)
  • func (c *CNI) Config(ctx context.Context, vmID string, numNICs int, vmCfg *types.VMConfig, ...) (configs []*types.NetworkConfig, retErr error)
  • func (c *CNI) Delete(ctx context.Context, vmIDs []string) ([]string, error)
  • func (c *CNI) GCModule() gc.Module[cniSnapshot]
  • func (c *CNI) Inspect(ctx context.Context, id string) (*types.Network, error)
  • func (c *CNI) List(ctx context.Context) ([]*types.Network, error)
  • func (c *CNI) RegisterGC(orch *gc.Orchestrator)
  • func (c *CNI) Type() string
  • func (c *CNI) Verify(_ context.Context, vmID string) error
• type Config
  • func (c *Config) CacheDir() string
  • func (c *Config) EnsureDirs() error
  • func (c *Config) IndexFile() string
  • func (c *Config) IndexLock() string

Types

type CNI

type CNI struct {
	// contains filtered or unexported fields
}

CNI implements network.Network using CNI plugins with per-VM netns + bridge + tap.

func New

func New(conf *config.Config) (*CNI, error)

New creates a CNI network provider. CNI conflist loading is best-effort at creation time; if no conflist is available (e.g. no network needed), Delete/Inspect/List still work. Config() will fail if the conflist is not loaded.

func (*CNI) Config

func (c *CNI) Config(ctx context.Context, vmID string, numNICs int, vmCfg *types.VMConfig, existing ...*types.NetworkConfig) (configs []*types.NetworkConfig, retErr error)

Config creates the netns, runs CNI ADD, and wires each NIC to a tap via TC.

func (*CNI) Delete

func (c *CNI) Delete(ctx context.Context, vmIDs []string) ([]string, error)

Delete removes all network resources for the given VM IDs:

1. CNI DEL for each NIC (releases IP from IPAM, removes veth pair).
2. Remove the named netns (kernel cleans up bridge + tap automatically).
3. Remove network records from the DB.

Best-effort: failing to clean one VM does not block others. Returns the VM IDs that were fully cleaned.

func (*CNI) GCModule

func (c *CNI) GCModule() gc.Module[cniSnapshot]

GCModule returns the GC module for orphan netns and stale CNI record cleanup.

func (*CNI) Inspect

func (c *CNI) Inspect(ctx context.Context, id string) (*types.Network, error)

Inspect returns the network record for a single network ID. Returns (nil, nil) if not found.

func (*CNI) List

func (c *CNI) List(ctx context.Context) ([]*types.Network, error)

List returns all known network records.

func (*CNI) RegisterGC

func (c *CNI) RegisterGC(orch *gc.Orchestrator)

RegisterGC registers the CNI GC module with the given Orchestrator.

func (*CNI) Type

func (c *CNI) Type() string

Type returns the network provider identifier.

func (*CNI) Verify

func (c *CNI) Verify(_ context.Context, vmID string) error

Verify checks whether the network namespace for a VM exists.

type Config

type Config struct {
	*config.Config
}

Config holds CNI network provider specific configuration, embedding the global config.

func (*Config) CacheDir

func (c *Config) CacheDir() string

CacheDir returns the CNI result cache directory path.

func (*Config) EnsureDirs

func (c *Config) EnsureDirs() error

EnsureDirs creates all static directories required by the CNI network provider.

func (*Config) IndexFile

func (c *Config) IndexFile() string

IndexFile returns the path to the network index JSON file.

func (*Config) IndexLock

func (c *Config) IndexLock() string

IndexLock returns the path to the network index lock file.