cmd

type Cmd ¶

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

Cmd provides methods for the CNI ADD, DEL and CHECK commands.

func (cmd *Cmd) Add(args *skel.CmdArgs) (err error)

func (cmd *Cmd) Check(args *skel.CmdArgs) error

func (cmd *Cmd) Del(args *skel.CmdArgs) error

func (cmd *Cmd) Status(args *skel.CmdArgs) error

type CmdState ¶

type CmdState struct {
	IP6       netip.Addr
	IP6routes []route.Route
	IP6rules  []route.Rule
	IP4       netip.Addr
	IP4routes []route.Route
	IP4rules  []route.Rule
	HostAddr  *models.NodeAddressing
}

type ConfigurationParams ¶

type ConfigurationParams struct {
	Log     *slog.Logger
	Conf    *models.DaemonConfigurationStatus
	Args    *skel.CmdArgs
	CniArgs *types.ArgsSpec
}

ConfigurationParams contains the arguments and Cilium configuration of a CNI invocation. Those fields may be used by custom implementations of the EndpointConfigurator interface to customize the CNI ADD call.

type DefaultConfigurator ¶

type DefaultConfigurator struct{}

DefaultConfigurator is the default endpoint configurator. It configures a single endpoint for the interface name provided by the CNI ADD invocation, using an auto-selected IPAM pool.

func (c *DefaultConfigurator) GetConfigurations(p ConfigurationParams) ([]EndpointConfiguration, error)

type EndpointConfiguration ¶

type EndpointConfiguration interface {
	// IfName specifies the container interface name to be used for this endpoint
	IfName() string
	// IPAMPool specifies which IPAM pool the endpoint's IP should be allocated from
	IPAMPool() string

	// PrepareEndpoint returns the interface configuration 'cmd' of the container
	// namespace as well as the template for the endpoint creation request 'ep'.
	PrepareEndpoint(ipam *models.IPAMResponse) (cmd *CmdState, ep *models.EndpointChangeRequest, err error)
}

EndpointConfiguration determines the configuration of an endpoint to be created during a CNI ADD invocation.

type EndpointConfigurator ¶

type EndpointConfigurator interface {
	GetConfigurations(p ConfigurationParams) ([]EndpointConfiguration, error)
}

EndpointConfigurator returns a list of endpoint configurations for a given CNI ADD invocation. If the CNI ADD invocation should result in multiple endpoints being created, it may return multiple endpoint configurations, one for each endpoint.

type OnConfigReady ¶ added in v1.19.0

type OnConfigReady interface {
	OnConfigReady(netConf *types.NetConf, cniArgs *types.ArgsSpec, conf *models.DaemonConfigurationStatus) error
}

OnConfigReady is invoked at the beginning of [(*Cmd).Add], right after the CNI network configuration, CNI arguments and the Cilium agent configuration were loaded. It may be used to sets up internal state of the hook.

type OnIPAMReady ¶ added in v1.19.0

type OnIPAMReady interface {
	OnIPAMReady(ipam *models.IPAMResponse) error
}

OnIPAMReady is invoked after IPAM configuration was validated. It may be used to derive further endpoint configuration related to IPAM.

type OnInterfaceConfigReady ¶ added in v1.19.0

type OnInterfaceConfigReady interface {
	OnInterfaceConfigReady(cmd *CmdState, ep *models.EndpointChangeRequest, res *cniTypesV1.Result) error
}

OnInterfaceConfigReady is invoked right before the pod's network interface pair is configured and the endpoint creation request is sent to the daemon. It may be used to modify the endpoint creation request, the command state and the CNI result accumulated so far.

type OnLinkConfigReady ¶ added in v1.19.0

type OnLinkConfigReady interface {
	OnLinkConfigReady(linkConfig *connector.LinkConfig) error
}

OnLinkConfigReady is invoked before the datapath connectors are called to create the pod's network links (i.e. veth or netkit pairs). It may be used to further modify the link configuration.

type Option ¶

type Option func(cmd *Cmd)

Option allows the customization of the Cmd implementation

func WithEPConfigurator(cfg EndpointConfigurator) Option

func WithOnConfigReady(f OnConfigReady) Option

func WithOnIPAMReady(f OnIPAMReady) Option

func WithOnInterfaceConfigReady(f OnInterfaceConfigReady) Option

func WithOnLinkConfigReady(f OnLinkConfigReady) Option

func WithVersion(version string) Option