network

Documentation

Index

• Constants
• type ConteinerNetworkManager
• type NetOpt
  • func WithLibNetDisableBridge(disableBridge bool) NetOpt
  • func WithLibNetEnableIPv6(enableIPv6 bool) NetOpt
  • func WithLibNetExecRoot(execRoot string) NetOpt
  • func WithLibNetFixedCIDRv4(fixedCIDRv4 string) NetOpt
  • func WithLibNetGatewayIPv4(gatewayIPv4 string) NetOpt
  • func WithLibNetIPForward(ipForward bool) NetOpt
  • func WithLibNetIPMasq(ipMasq bool) NetOpt
  • func WithLibNetIPTables(ipTables bool) NetOpt
  • func WithLibNetIPV4(ipv4 string) NetOpt
  • func WithLibNetIcc(icc bool) NetOpt
  • func WithLibNetMetaPath(metaPath string) NetOpt
  • func WithLibNetMtu(mtu int) NetOpt
  • func WithLibNetName(name string) NetOpt
  • func WithLibNetType(netType string) NetOpt
  • func WithLibNetUserlandProxy(userlandProxy bool) NetOpt

Constants

const (
	// LibetworkManagerServiceLocalID sets service local ID for libnetwork manager
	LibetworkManagerServiceLocalID = "container-management.service.local.v1.service-libnetwork-manager"
)

Types

type ConteinerNetworkManager

type ConteinerNetworkManager interface {
	// Manage performs any container network initialization operations that are needed so that a container is connectable afterwards
	Manage(ctx context.Context, container *types.Container) error

	// Connect is used to connect a container to a network.
	Connect(ctx context.Context, containers *types.Container) error

	// Disconnect disconnects the given container from given network
	Disconnect(ctx context.Context, container *types.Container, force bool) error

	// ReleaseContainerResources releases all locally allocated resources for the container by the network manager implementation - e.g. network endpoints, etc.
	ReleaseNetworkResources(ctx context.Context, container *types.Container) error

	// Dispose manages stop and dispose of the network manager
	Dispose(ctx context.Context) error

	// Restore restores all networking resources for all running containers
	Restore(ctx context.Context, container []*types.Container) error

	// Initialize initializes all base networks for the manager depending on the modes supported - currently on bridge is supported
	Initialize(ctx context.Context) error
}

ConteinerNetworkManager abstracts container's network operations

type NetOpt

type NetOpt func(netOpts *netOpts) error

NetOpt provides Network Manager Config Options

func WithLibNetDisableBridge

func WithLibNetDisableBridge(disableBridge bool) NetOpt

WithLibNetDisableBridge disables the default network bridge interface creation and usage.

func WithLibNetEnableIPv6

func WithLibNetEnableIPv6(enableIPv6 bool) NetOpt

WithLibNetEnableIPv6 enables IPv6

func WithLibNetExecRoot

func WithLibNetExecRoot(execRoot string) NetOpt

WithLibNetExecRoot sets network manager service's exec root.

func WithLibNetFixedCIDRv4

func WithLibNetFixedCIDRv4(fixedCIDRv4 string) NetOpt

WithLibNetFixedCIDRv4 sets network fixed CIDRv4.

func WithLibNetGatewayIPv4

func WithLibNetGatewayIPv4(gatewayIPv4 string) NetOpt

WithLibNetGatewayIPv4 sets network gateway IPv4.

func WithLibNetIPForward

func WithLibNetIPForward(ipForward bool) NetOpt

WithLibNetIPForward enables network IP forwarding

func WithLibNetIPMasq

func WithLibNetIPMasq(ipMasq bool) NetOpt

WithLibNetIPMasq sets network IP masquerade

func WithLibNetIPTables

func WithLibNetIPTables(ipTables bool) NetOpt

WithLibNetIPTables enables network IP tables

func WithLibNetIPV4

func WithLibNetIPV4(ipv4 string) NetOpt

WithLibNetIPV4 sets network IPv4.

func WithLibNetIcc

func WithLibNetIcc(icc bool) NetOpt

WithLibNetIcc enables network ICC

func WithLibNetMetaPath

func WithLibNetMetaPath(metaPath string) NetOpt

WithLibNetMetaPath sets network manager service's meta path.

func WithLibNetMtu

func WithLibNetMtu(mtu int) NetOpt

WithLibNetMtu sets network MTU

func WithLibNetName

func WithLibNetName(name string) NetOpt

WithLibNetName sets the default bridge network interface name.

func WithLibNetType

func WithLibNetType(netType string) NetOpt

WithLibNetType sets the default network interface type for the network manager service to use per container.

func WithLibNetUserlandProxy

func WithLibNetUserlandProxy(userlandProxy bool) NetOpt

WithLibNetUserlandProxy enables usage of a network userland proxy