func NetworkDeleteOptionRemoveLB(p *networkDeleteParams)

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

func (*ActiveContainerError)Error¶

func (ace *ActiveContainerError) Error()string

func (*ActiveContainerError)Forbidden¶

func (ace *ActiveContainerError) Forbidden()

Forbidden denotes the type of this error

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

func (*ActiveEndpointsError)Error¶

func (aee *ActiveEndpointsError) Error()string

func (*ActiveEndpointsError)Forbidden¶

func (aee *ActiveEndpointsError) Forbidden()

Forbidden denotes the type of this error

type ByNetworkType []*Endpoint

func (ByNetworkType)Len¶

func (epByNetworkType) Len()int

func (ByNetworkType)Less¶

func (epByNetworkType) Less(i, jint)bool

func (ByNetworkType)Swap¶

func (epByNetworkType) Swap(i, jint)

type ByTime []*types.EncryptionKey

func (ByTime)Len¶

func (bByTime) Len()int

func (ByTime)Less¶

func (bByTime) Less(i, jint)bool

func (ByTime)Swap¶

func (bByTime) Swap(i, jint)

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

funcNew¶

func New(ctxcontext.Context, cfgOptions ...config.Option) (_ *Controller, retErrerror)

New creates a new instance of network controller.

func (*Controller)AgentInitWait¶

func (c *Controller) AgentInitWait()

AgentInitWait waits for agent initialization to be completed in the controller.

func (*Controller)AgentStopWait¶

func (c *Controller) AgentStopWait()

AgentStopWait waits for the Agent stop to be completed in the controller.

func (*Controller)BuiltinDrivers¶

func (c *Controller) BuiltinDrivers() []string

BuiltinDrivers returns the list of builtin network drivers.

func (*Controller)BuiltinIPAMDrivers¶

func (c *Controller) BuiltinIPAMDrivers() []string

BuiltinIPAMDrivers returns the list of builtin ipam drivers.

func (*Controller)Config¶

func (c *Controller) Config()config.Config

Config returns the bootup configuration for the controller.

func (*Controller)FirewallBackend¶

func (c *Controller) FirewallBackend() *system.FirewallInfo

FirewallBackend returns the name of the firewall backend for "docker info".

func (*Controller)GetPluginGetter¶

func (c *Controller) GetPluginGetter()plugingetter.PluginGetter

func (*Controller)GetSandbox¶

func (c *Controller) GetSandbox(containerIDstring) (*Sandbox,error)

GetSandbox returns the Sandbox which has the passed id.

It returns an [ErrInvalidID] when passing an invalid ID, or anerrdefs.ErrNotFound if no Sandbox was found for the container.

func (*Controller)ID¶

func (c *Controller) ID()string

ID returns the controller's unique identity.

func (*Controller)IsDiagnosticEnabled¶

func (c *Controller) IsDiagnosticEnabled()bool

IsDiagnosticEnabled returns true if the diagnostic server is running.

func (*Controller)NetworkByID¶

func (c *Controller) NetworkByID(idstring) (*Network,error)

NetworkByID returns the Network which has the passed id.If not found, the errorErrNoSuchNetwork is returned.

func (*Controller)NetworkByName¶

func (c *Controller) NetworkByName(namestring) (*Network,error)

NetworkByName returns the Network which has the passed name.If not found, the errorErrNoSuchNetwork is returned.

func (*Controller)Networks¶

func (c *Controller) Networks(ctxcontext.Context) []*Network

Networks returns the list of Network(s) managed by this controller.

func (*Controller)NewNetwork¶

func (c *Controller) NewNetwork(ctxcontext.Context, networkType, namestring, idstring, options ...NetworkOption) (_ *Network, retErrerror)

NewNetwork creates a new network of the specified network type. The optionsare network specific and modeled in a generic way.

func (*Controller)NewSandbox¶

func (c *Controller) NewSandbox(ctxcontext.Context, containerIDstring, options ...SandboxOption) (_ *Sandbox, retErrerror)

NewSandbox creates a new sandbox for containerID.

func (*Controller)RegisterDriver¶

func (c *Controller) RegisterDriver(_string, driverdriverapi.Driver, _driverapi.Capability)error

func (*Controller)RegisterNetworkAllocator¶

func (c *Controller) RegisterNetworkAllocator(_string, _driverapi.NetworkAllocator)error

func (*Controller)SandboxByID¶

func (c *Controller) SandboxByID(idstring) (*Sandbox,error)

SandboxByID returns the Sandbox which has the passed id.If not found, aerrdefs.NotFoundError is returned.

func (*Controller)SandboxDestroy¶

func (c *Controller) SandboxDestroy(ctxcontext.Context, idstring)error

SandboxDestroy destroys a sandbox given a container ID.

func (*Controller)SetClusterProvider¶

func (c *Controller) SetClusterProvider(providercluster.Provider)

SetClusterProvider sets the cluster provider.

func (*Controller)SetKeys¶

func (c *Controller) SetKeys(keys []*types.EncryptionKey)error

SetKeys configures the encryption key for gossip and overlay data path.

func (*Controller)StartDiagnostic¶

func (c *Controller) StartDiagnostic(portint)

StartDiagnostic starts the network diagnostic server listening on port.

func (*Controller)Stop¶

func (c *Controller) Stop()

Stop stops the network controller.

func (*Controller)StopDiagnostic¶

func (c *Controller) StopDiagnostic()

StopDiagnostic stops the network diagnostic server.

func (*Controller)WalkNetworks¶

func (c *Controller) WalkNetworks(walkerNetworkWalker)

WalkNetworks uses the provided function to walk the Network(s) managed by this controller.

type DNSBackend interface {// ResolveName resolves a service name to an IPv4 or IPv6 address by searching// the networks the sandbox is connected to. The second return value will be// true if the name exists in docker domain, even if there are no addresses of// the required type. Such queries shouldn't be forwarded to external nameservers.ResolveName(ctxcontext.Context, namestring, ipTypetypes.IPFamily) ([]net.IP,bool)// ResolveIP returns the service name for the passed in IP. IP is in reverse dotted// notation; the format used for DNS PTR recordsResolveIP(ctxcontext.Context, namestring)string// ResolveService returns all the backend details about the containers or hosts// backing a service. Its purpose is to satisfy an SRV queryResolveService(ctxcontext.Context, namestring) ([]*net.SRV, []net.IP)// ExecFunc allows a function to be executed in the context of the backend// on behalf of the resolver.ExecFunc(f func())error// NdotsSet queries the backends ndots dns option settingsNdotsSet()bool// HandleQueryResp passes the name & IP from a response to the backend. backend// can use it to maintain any required state about the resolutionHandleQueryResp(namestring, ipnet.IP)}

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

func (*Endpoint)AddStaticRoute¶

func (ep *Endpoint) AddStaticRoute(destination *net.IPNet, routeTypetypes.RouteType, nextHopnet.IP)error

AddStaticRoute adds a route to the sandbox.It may be used in addition to or instead of a default gateway (as above).

func (*Endpoint)AddTableEntry¶

func (ep *Endpoint) AddTableEntry(tableName, keystring, value []byte)error

AddTableEntry adds a table entry to the gossip layerpassing the table name, key and an opaque value.

func (*Endpoint)CopyTo¶

func (ep *Endpoint) CopyTo(odatastore.KVObject)error

func (*Endpoint)Delete¶

func (ep *Endpoint) Delete(ctxcontext.Context, forcebool)error

Delete deletes and detaches this endpoint from the network.

func (*Endpoint)DisableGatewayService¶

func (ep *Endpoint) DisableGatewayService()

DisableGatewayService tells libnetwork not to provide Default GW for the container

func (*Endpoint)DriverInfo¶

func (ep *Endpoint) DriverInfo() (map[string]any,error)

DriverInfo returns a collection of driver operational data related to this endpoint retrieved from the driver.

func (*Endpoint)Exists¶

func (ep *Endpoint) Exists()bool

func (*Endpoint)ForceGw4¶

func (ep *Endpoint) ForceGw4()

func (*Endpoint)ForceGw6¶

func (ep *Endpoint) ForceGw6()

func (*Endpoint)Gateway¶

func (ep *Endpoint) Gateway()net.IP

Gateway returns the IPv4 gateway assigned by the driver.This will only return a valid value if a container has joined the endpoint.

func (*Endpoint)GatewayIPv6¶

func (ep *Endpoint) GatewayIPv6()net.IP

GatewayIPv6 returns the IPv6 gateway assigned by the driver.This will only return a valid value if a container has joined the endpoint.

func (*Endpoint)ID¶

func (ep *Endpoint) ID()string

ID returns the system-generated id for this endpoint.

func (*Endpoint)Iface¶

func (ep *Endpoint) Iface() *EndpointInterface

Iface returns information about the interface which was assigned tothe endpoint by the driver. This can be used after theendpoint has been created.

func (*Endpoint)Index¶

func (ep *Endpoint) Index()uint64

func (*Endpoint)Info¶

func (ep *Endpoint) Info()EndpointInfo

Info hydrates the endpoint and returns certain operational data belongingto this endpoint.

TODO(thaJeztah): make sure that Endpoint is always fully hydrated, and remove the EndpointInfo interface, and use Endpoint directly.

func (*Endpoint)InterfaceName¶

func (ep *Endpoint) InterfaceName()driverapi.InterfaceNameInfo

func (*Endpoint)Join¶

func (ep *Endpoint) Join(ctxcontext.Context, sb *Sandbox, options ...EndpointOption)error

Join joins the sandbox to the endpoint and populates into the sandboxthe network resources allocated for the endpoint.

func (*Endpoint)Key¶

func (ep *Endpoint) Key() []string

Key returns the endpoint's key.

Key structure: endpoint/network-id/endpoint-id

func (*Endpoint)KeyPrefix¶

func (ep *Endpoint) KeyPrefix() []string

func (*Endpoint)Leave¶

func (ep *Endpoint) Leave(ctxcontext.Context, sb *Sandbox)error

Leave detaches the network resources populated in the sandbox.

func (*Endpoint)Less¶

func (ep *Endpoint) Less(epj *Endpoint)bool

Less defines an ordering over endpoints, with better candidates for the defaultgateway sorted first.

<=> Returns true if a < b, false if a > b and advances to next level if a == bep.prio <=> epj.prio           # 2 < 1ep.gw <=> epj.gw               # non-gw < gwep.internal <=> epj.internal   # non-internal < internalep.hasGw <=> epj.hasGw         # (gw4 and gw6) < (gw4 or gw6) < (no gw)ep.name <=> epj.name           # bar < foo

func (*Endpoint)LoadBalancer¶

func (ep *Endpoint) LoadBalancer()bool

LoadBalancer returns whether the endpoint is the load balancer endpoint for the network.

func (*Endpoint)MarshalJSON¶

func (ep *Endpoint) MarshalJSON() ([]byte,error)

func (*Endpoint)Name¶

func (ep *Endpoint) Name()string

Name returns the name of this endpoint.

func (*Endpoint)Network¶

func (ep *Endpoint) Network()string

Network returns the name of the network to which this endpoint is attached.

func (*Endpoint)New¶

func (ep *Endpoint) New()datastore.KVObject

func (*Endpoint)Sandbox¶

func (ep *Endpoint) Sandbox() *Sandbox

Sandbox returns the attached sandbox if there, nil otherwise.

func (*Endpoint)SetGateway¶

func (ep *Endpoint) SetGateway(gwnet.IP)error

SetGateway sets the default IPv4 gateway when a container joins the endpoint.

func (*Endpoint)SetGatewayIPv6¶

func (ep *Endpoint) SetGatewayIPv6(gw6net.IP)error

SetGatewayIPv6 sets the default IPv6 gateway when a container joins the endpoint.

func (*Endpoint)SetIndex¶

func (ep *Endpoint) SetIndex(indexuint64)

func (*Endpoint)SetValue¶

func (ep *Endpoint) SetValue(value []byte)error

func (*Endpoint)Skip¶

func (ep *Endpoint) Skip()bool

func (*Endpoint)StaticRoutes¶

func (ep *Endpoint) StaticRoutes() []*types.StaticRoute

StaticRoutes returns the list of static routes configured by the networkdriver when the container joins a network

func (*Endpoint)UnmarshalJSON¶

func (ep *Endpoint) UnmarshalJSON(b []byte) (errerror)

func (*Endpoint)UpdateDNSNames¶

func (ep *Endpoint) UpdateDNSNames(dnsNames []string)error

func (*Endpoint)Value¶

func (ep *Endpoint) Value() []byte

type EndpointInfo interface {// Iface returns information about the interface which was assigned to// the endpoint by the driver. This can be used after the// endpoint has been created.Iface() *EndpointInterface// Gateway returns the IPv4 gateway assigned by the driver.// This will only return a valid value if a container has joined the endpoint.Gateway()net.IP// GatewayIPv6 returns the IPv6 gateway assigned by the driver.// This will only return a valid value if a container has joined the endpoint.GatewayIPv6()net.IP// StaticRoutes returns the list of static routes configured by the network// driver when the container joins a networkStaticRoutes() []*types.StaticRoute// Sandbox returns the attached sandbox if there, nil otherwise.Sandbox() *Sandbox// LoadBalancer returns whether the endpoint is the load balancer endpoint for the network.LoadBalancer()bool}

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

func (*EndpointInterface)Addr¶

func (epi *EndpointInterface) Addr()netip.Prefix

func (*EndpointInterface)AddrIPv6¶

func (epi *EndpointInterface) AddrIPv6()netip.Prefix

func (*EndpointInterface)Address¶

func (epi *EndpointInterface) Address() *net.IPNet

Address returns the IPv4 address assigned to the endpoint.

func (*EndpointInterface)AddressIPv6¶

func (epi *EndpointInterface) AddressIPv6() *net.IPNet

AddressIPv6 returns the IPv6 address assigned to the endpoint.

func (*EndpointInterface)Copy¶

func (epi *EndpointInterface) Copy() *EndpointInterface

Copy returns a deep copy ofEndpointInterface. If the receiver is nil,Copy returns nil.

func (*EndpointInterface)LinkLocalAddresses¶

func (epi *EndpointInterface) LinkLocalAddresses() []*net.IPNet

LinkLocalAddresses returns the list of link-local (IPv4/IPv6) addresses assigned to the endpoint.

func (*EndpointInterface)MacAddress¶

func (epi *EndpointInterface) MacAddress()net.HardwareAddr

MacAddress returns the MAC address assigned to the endpoint.

func (*EndpointInterface)MarshalJSON¶

func (epi *EndpointInterface) MarshalJSON() ([]byte,error)

func (*EndpointInterface)NetnsPath¶

func (epi *EndpointInterface) NetnsPath()string

NetnsPath returns the path of the network namespace, if there is one. Else "".

func (*EndpointInterface)SetCreatedInContainer¶

func (epi *EndpointInterface) SetCreatedInContainer(cicbool)

SetCreatedInContainer can be called by the driver to indicate that it'screated the network interface in the container's network namespace (so,it doesn't need to be moved there).

func (*EndpointInterface)SetIPAddress¶

func (epi *EndpointInterface) SetIPAddress(address *net.IPNet)error

func (*EndpointInterface)SetMacAddress¶

func (epi *EndpointInterface) SetMacAddress(macnet.HardwareAddr)error

SetMacAddress allows the driver to set the mac address to the endpoint interfaceduring the call to CreateEndpoint, if the mac address is not already set.

func (*EndpointInterface)SetNames¶

func (epi *EndpointInterface) SetNames(srcName, dstPrefix, dstNamestring)error

SetNames method assigns the srcName, dstName, and dstPrefix for theinterface. If both dstName and dstPrefix are set, dstName takes precedence.

func (*EndpointInterface)SrcName¶

func (epi *EndpointInterface) SrcName()string

SrcName returns the name of the interface w/in the container

func (*EndpointInterface)UnmarshalJSON¶

func (epi *EndpointInterface) UnmarshalJSON(b []byte)error

type EndpointOption func(ep *Endpoint)

funcCreateOptionAlias¶

func CreateOptionAlias(namestring, aliasstring)EndpointOption

CreateOptionAlias function returns an option setter for setting endpoint alias

funcCreateOptionDNS¶

func CreateOptionDNS(dns []string)EndpointOption

CreateOptionDNS function returns an option setter for dns entry option tobe passed to container Create method.

funcCreateOptionDNSNames¶

func CreateOptionDNSNames(names []string)EndpointOption

CreateOptionDNSNames specifies the list of (non fully qualified) DNS names associated to an endpoint. These will beused to populate the embedded DNS server. Order matters: first name will be used to generate PTR records.

funcCreateOptionDisableIPv6¶

func CreateOptionDisableIPv6()EndpointOption

CreateOptionDisableIPv6 prevents allocation of an IPv6 address/gateway, evenif the container is connected to an IPv6-enabled network.

funcCreateOptionDisableResolution¶

func CreateOptionDisableResolution()EndpointOption

CreateOptionDisableResolution function returns an option setter to indicatethis endpoint doesn't want embedded DNS server functionality

funcCreateOptionExposedPorts¶

func CreateOptionExposedPorts(exposedPorts []types.TransportPort)EndpointOption

CreateOptionExposedPorts function returns an option setter for the container exposedports option to be passed toNetwork.CreateEndpoint method.

funcCreateOptionIPAM¶

func CreateOptionIPAM(ipV4, ipV6net.IP, llIPs []net.IP)EndpointOption

CreateOptionIPAM function returns an option setter for the ipam configuration for this endpoint

funcCreateOptionLoadBalancer¶

func CreateOptionLoadBalancer()EndpointOption

CreateOptionLoadBalancer function returns an option setter for denoting the endpoint is a load balancer for a network

funcCreateOptionPortMapping¶

func CreateOptionPortMapping(portBindings []types.PortBinding)EndpointOption

CreateOptionPortMapping function returns an option setter for the mappingports option to be passed toNetwork.CreateEndpoint method.

funcCreateOptionService¶

func CreateOptionService(name, idstring, vipnet.IP, ingressPorts []*PortConfig, aliases []string)EndpointOption

CreateOptionService function returns an option setter for setting service binding configuration

funcEndpointOptionGeneric¶

func EndpointOptionGeneric(generic map[string]any)EndpointOption

EndpointOptionGeneric function returns an option setter for a Generic option definedin a Dictionary of Key-Value pair

funcJoinOptionPriority¶

func JoinOptionPriority(prioint)EndpointOption

JoinOptionPriority function returns an option setter for priority option tobe passed to the endpoint.Join() method.

funcWithNetnsPath¶

func WithNetnsPath(pathstring)EndpointOption

type EndpointRecord struct {// Name of the containerNamestring `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Service name of the service to which this endpoint belongs.ServiceNamestring `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`// Service ID of the service to which this endpoint belongs.ServiceIDstring `protobuf:"bytes,3,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"`// Virtual IP of the service to which this endpoint belongs.VirtualIPstring `protobuf:"bytes,4,opt,name=virtual_ip,json=virtualIp,proto3" json:"virtual_ip,omitempty"`// IP assigned to this endpoint.EndpointIPstring `protobuf:"bytes,5,opt,name=endpoint_ip,json=endpointIp,proto3" json:"endpoint_ip,omitempty"`// IngressPorts exposed by the service to which this endpoint belongs.IngressPorts []*PortConfig `protobuf:"bytes,6,rep,name=ingress_ports,json=ingressPorts,proto3" json:"ingress_ports,omitempty"`// A list of aliases which are alternate names for the serviceAliases []string `protobuf:"bytes,7,rep,name=aliases,proto3" json:"aliases,omitempty"`// List of aliases task specific aliasesTaskAliases []string `protobuf:"bytes,8,rep,name=task_aliases,json=taskAliases,proto3" json:"task_aliases,omitempty"`// Whether this endpoint's service has been disabledServiceDisabledbool `protobuf:"varint,9,opt,name=service_disabled,json=serviceDisabled,proto3" json:"service_disabled,omitempty"`}

func (*EndpointRecord)Descriptor¶

func (*EndpointRecord) Descriptor() ([]byte, []int)

func (*EndpointRecord)GetAliases¶

func (m *EndpointRecord) GetAliases() []string

func (*EndpointRecord)GetEndpointIP¶

func (m *EndpointRecord) GetEndpointIP()string

func (*EndpointRecord)GetIngressPorts¶

func (m *EndpointRecord) GetIngressPorts() []*PortConfig

func (*EndpointRecord)GetName¶

func (m *EndpointRecord) GetName()string

func (*EndpointRecord)GetServiceDisabled¶

func (m *EndpointRecord) GetServiceDisabled()bool

func (*EndpointRecord)GetServiceID¶

func (m *EndpointRecord) GetServiceID()string

func (*EndpointRecord)GetServiceName¶

func (m *EndpointRecord) GetServiceName()string

func (*EndpointRecord)GetTaskAliases¶

func (m *EndpointRecord) GetTaskAliases() []string

func (*EndpointRecord)GetVirtualIP¶

func (m *EndpointRecord) GetVirtualIP()string

func (*EndpointRecord)GoString¶

func (this *EndpointRecord) GoString()string

func (*EndpointRecord)Marshal¶

func (m *EndpointRecord) Marshal() (dAtA []byte, errerror)

func (*EndpointRecord)MarshalTo¶

func (m *EndpointRecord) MarshalTo(dAtA []byte) (int,error)

func (*EndpointRecord)MarshalToSizedBuffer¶

func (m *EndpointRecord) MarshalToSizedBuffer(dAtA []byte) (int,error)

func (*EndpointRecord)ProtoMessage¶

func (*EndpointRecord) ProtoMessage()

func (*EndpointRecord)Reset¶

func (m *EndpointRecord) Reset()

func (*EndpointRecord)Size¶

func (m *EndpointRecord) Size() (nint)

func (*EndpointRecord)String¶

func (this *EndpointRecord) String()string

func (*EndpointRecord)Unmarshal¶

func (m *EndpointRecord) Unmarshal(dAtA []byte)error

func (*EndpointRecord)XXX_DiscardUnknown¶

func (m *EndpointRecord) XXX_DiscardUnknown()

func (*EndpointRecord)XXX_Marshal¶

func (m *EndpointRecord) XXX_Marshal(b []byte, deterministicbool) ([]byte,error)

func (*EndpointRecord)XXX_Merge¶

func (m *EndpointRecord) XXX_Merge(srcproto.Message)

func (*EndpointRecord)XXX_Size¶

func (m *EndpointRecord) XXX_Size()int

func (*EndpointRecord)XXX_Unmarshal¶

func (m *EndpointRecord) XXX_Unmarshal(b []byte)error

type EndpointWalker func(ep *Endpoint)bool

type ErrNoSuchNetworkstring

func (ErrNoSuchNetwork)Error¶

func (nsnErrNoSuchNetwork) Error()string

func (ErrNoSuchNetwork)NotFound¶

func (nsnErrNoSuchNetwork) NotFound()

NotFound denotes the type of this error

type IpamConf struct {// PreferredPool is the master address pool for containers and network interfaces.PreferredPoolstring// SubPool is a subset of the master pool. If specified,// this becomes the container pool for automatic address allocations.SubPoolstring// Gateway is the preferred Network Gateway address (optional).Gatewaystring// AuxAddresses contains auxiliary addresses for network driver. Must be within the master pool.// libnetwork will reserve them if they fall into the container pool.AuxAddresses map[string]string}

func (*IpamConf)Contains¶

func (c *IpamConf) Contains(addrnetip.Addr)bool

Contains checks whether the ipam master address pool contains [addr].

func (*IpamConf)Copy¶

func (c *IpamConf) Copy() *IpamConf

Copy returns a deep copy of theIpamConf. If the receiver is nil,Copy returns nil.

func (*IpamConf)IPAMConfig¶

func (c *IpamConf) IPAMConfig()network.IPAMConfig

func (*IpamConf)IsStatic¶

func (c *IpamConf) IsStatic()bool

IsStatic checks whether the subnet was statically allocated (ie. user-defined).

func (*IpamConf)Validate¶

func (c *IpamConf) Validate()error

Validate checks whether the configuration is valid

type IpamInfo struct {PoolIDstringMeta   map[string]stringdriverapi.IPAMData}

func (*IpamInfo)Copy¶

func (i *IpamInfo) Copy() *IpamInfo

Copy returns a deep copy ofIpamInfo. If the receiver is nil,Copy returns nil.

func (*IpamInfo)MarshalJSON¶

func (i *IpamInfo) MarshalJSON() ([]byte,error)

MarshalJSON encodes IpamInfo into json message

func (*IpamInfo)UnmarshalJSON¶

func (i *IpamInfo) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes json message into PoolData

type ManagerRedirectErrorstring

func (ManagerRedirectError)Error¶

func (mrManagerRedirectError) Error()string

func (ManagerRedirectError)Maskable¶

func (mrManagerRedirectError) Maskable()

Maskable denotes the type of this error

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

func (*Network)Attachable¶

func (n *Network) Attachable()bool

func (*Network)ConfigFrom¶

func (n *Network) ConfigFrom()string

func (*Network)ConfigOnly¶

func (n *Network) ConfigOnly()bool

func (*Network)CopyTo¶

func (n *Network) CopyTo(odatastore.KVObject)error

func (*Network)CreateEndpoint¶

func (n *Network) CreateEndpoint(ctxcontext.Context, namestring, options ...EndpointOption) (*Endpoint,error)

CreateEndpoint creates a new endpoint to this network symbolically identified by thespecified unique name. The options parameter carries driver specific options.

func (*Network)Created¶

func (n *Network) Created()time.Time

func (*Network)Delete¶

func (n *Network) Delete(options ...NetworkDeleteOption)error

Delete the network.

func (*Network)Driver¶

func (n *Network) Driver()string

Driver is an alias forNetwork.Type.

func (*Network)DriverOptions¶

func (n *Network) DriverOptions() map[string]string

func (*Network)Dynamic¶

func (n *Network) Dynamic()bool

func (*Network)EndpointByName¶

func (n *Network) EndpointByName(namestring) (*Endpoint,error)

EndpointByName returns the Endpoint which has the passed name. If not found,anerrdefs.ErrNotFound is returned.

func (*Network)Endpoints¶

func (n *Network) Endpoints() []*Endpoint

Endpoints returns the list of Endpoint(s) in this network.

func (*Network)Exists¶

func (n *Network) Exists()bool

func (*Network)HandleQueryResp¶

func (n *Network) HandleQueryResp(namestring, ipnet.IP)

func (*Network)HasContainerAttachments¶

func (n *Network) HasContainerAttachments()bool

HasContainerAttachments returns true when len(n.Endpoints()) > 0.

func (*Network)HasServiceAttachments¶

func (n *Network) HasServiceAttachments()bool

HasServiceAttachments returns true when len(n.Services()) > 0.

func (*Network)ID¶

func (n *Network) ID()string

ID returns a system generated id for this network.

func (*Network)IPAMStatus¶

func (n *Network) IPAMStatus(ctxcontext.Context) (network.IPAMStatus,error)

func (*Network)IPv4Enabled¶

func (n *Network) IPv4Enabled()bool

func (*Network)IPv6Enabled¶

func (n *Network) IPv6Enabled()bool

func (*Network)Index¶

func (n *Network) Index()uint64

func (*Network)Ingress¶

func (n *Network) Ingress()bool

func (*Network)Internal¶

func (n *Network) Internal()bool

func (*Network)IpamConfig¶

func (n *Network) IpamConfig() (ipamTypestring, ipamOptions map[string]string, ipamV4Config []*IpamConf, ipamV6Config []*IpamConf)

func (*Network)IpamInfo¶

func (n *Network) IpamInfo() (ipamV4Info []*IpamInfo, ipamV6Info []*IpamInfo)

func (*Network)IsPruneable¶

func (n *Network) IsPruneable()bool

IsPruneable returns true if n can be considered for removal as part of a"docker network prune" (or system prune). The caller must still check that thenetwork should be removed. For example, it may have active endpoints.

func (*Network)Key¶

func (n *Network) Key() []string

func (*Network)KeyPrefix¶

func (n *Network) KeyPrefix() []string

func (*Network)Labels¶

func (n *Network) Labels() map[string]string

func (*Network)MarshalJSON¶

func (n *Network) MarshalJSON() ([]byte,error)

func (*Network)Name¶

func (n *Network) Name()string

Name returns a user chosen name for this network.

func (*Network)NdotsSet¶

func (n *Network) NdotsSet()bool

func (*Network)New¶

func (n *Network) New()datastore.KVObject

func (*Network)Peers¶

func (n *Network) Peers() []networkdb.PeerInfo

Peers returns a slice of PeerInfo structures which has the information about the peernodes participating in the same overlay network. This is currently the per-networkgossip cluster. For non-dynamic overlay networks and bridge networks it returns anempty slice

func (*Network)ResolveIP¶

func (n *Network) ResolveIP(_context.Context, ipstring)string

func (*Network)ResolveName¶

func (n *Network) ResolveName(ctxcontext.Context, reqstring, ipTypetypes.IPFamily) ([]net.IP,bool)

ResolveName looks up addresses of ipType for name req.Returns (addresses, true) if req is found, but len(addresses) may be 0 ifthere are no addresses of ipType. If the name is not found, the bool returnwill be false.

func (*Network)ResolveService¶

func (n *Network) ResolveService(ctxcontext.Context, namestring) ([]*net.SRV, []net.IP)

func (*Network)Resolvers¶

func (n *Network) Resolvers() []*Resolver

func (*Network)Scope¶

func (n *Network) Scope()string

func (*Network)Services¶

func (n *Network) Services() map[string]ServiceInfo

Services returns a map of services keyed by the service name with the detailsof all the tasks that belong to the service. Applicable only in swarm mode.

func (*Network)SetIndex¶

func (n *Network) SetIndex(indexuint64)

func (*Network)SetValue¶

func (n *Network) SetValue(value []byte)error

func (*Network)Skip¶

func (n *Network) Skip()bool

func (*Network)TableEventRegister¶

func (n *Network) TableEventRegister(tableNamestring, objTypedriverapi.ObjectType)error

func (*Network)Type¶

func (n *Network) Type()string

Type returns the type of network, which corresponds to its managing driver.

func (*Network)UnmarshalJSON¶

func (n *Network) UnmarshalJSON(b []byte) (errerror)

func (*Network)UpdateIpamConfig¶

func (n *Network) UpdateIpamConfig(ipV4Data []driverapi.IPAMData)

func (*Network)Value¶

func (n *Network) Value() []byte

func (*Network)WalkEndpoints¶

func (n *Network) WalkEndpoints(walkerEndpointWalker)

WalkEndpoints uses the provided function to walk the Endpoints.

type NetworkDeleteOption func(p *networkDeleteParams)

type NetworkNameErrorstring

func (NetworkNameError)Conflict¶

func (nnrNetworkNameError) Conflict()

Conflict denotes the type of this error

func (NetworkNameError)Error¶

func (nnrNetworkNameError) Error()string

type NetworkOption func(n *Network)

funcNetworkOptionAttachable¶

func NetworkOptionAttachable(attachablebool)NetworkOption

NetworkOptionAttachable returns an option setter to set attachable for a network

funcNetworkOptionConfigFrom¶

func NetworkOptionConfigFrom(namestring)NetworkOption

NetworkOptionConfigFrom tells controller to pick thenetwork configuration from a configuration only network

funcNetworkOptionConfigOnly¶

func NetworkOptionConfigOnly()NetworkOption

NetworkOptionConfigOnly tells controller this network isa configuration only network. It serves as a configurationfor other networks.

funcNetworkOptionDriverOpts¶

func NetworkOptionDriverOpts(opts map[string]string)NetworkOption

NetworkOptionDriverOpts function returns an option setter for any driver parameter described by a map

funcNetworkOptionDynamic¶

func NetworkOptionDynamic()NetworkOption

NetworkOptionDynamic function returns an option setter for dynamic option for a network

funcNetworkOptionEnableIPv4¶

func NetworkOptionEnableIPv4(enableIPv4bool)NetworkOption

NetworkOptionEnableIPv4 returns an option setter to explicitly configure IPv4

funcNetworkOptionEnableIPv6¶

func NetworkOptionEnableIPv6(enableIPv6bool)NetworkOption

NetworkOptionEnableIPv6 returns an option setter to explicitly configure IPv6

funcNetworkOptionGeneric¶

func NetworkOptionGeneric(generic map[string]any)NetworkOption

NetworkOptionGeneric function returns an option setter for a Generic option definedin a Dictionary of Key-Value pair

funcNetworkOptionIngress¶

func NetworkOptionIngress(ingressbool)NetworkOption

NetworkOptionIngress returns an option setter to indicate if a network isan ingress network.

funcNetworkOptionInternalNetwork¶

func NetworkOptionInternalNetwork()NetworkOption

NetworkOptionInternalNetwork returns an option setter to config the networkto be internal which disables default gateway service

funcNetworkOptionIpam¶

func NetworkOptionIpam(ipamDriverstring, addrSpacestring, ipV4 []*IpamConf, ipV6 []*IpamConf, opts map[string]string)NetworkOption

NetworkOptionIpam function returns an option setter for the ipam configuration for this network

funcNetworkOptionLBEndpoint¶

func NetworkOptionLBEndpoint(ipnet.IP)NetworkOption

NetworkOptionLBEndpoint function returns an option setter for the configuration of the load balancer endpoint for this network

funcNetworkOptionLabels¶

func NetworkOptionLabels(labels map[string]string)NetworkOption

NetworkOptionLabels function returns an option setter for labels specific to a network

funcNetworkOptionPersist¶

func NetworkOptionPersist(persistbool)NetworkOption

NetworkOptionPersist returns an option setter to set persistence policy for a network

funcNetworkOptionScope¶

func NetworkOptionScope(scopestring)NetworkOption

NetworkOptionScope returns an option setter to overwrite the network's scope.By default the network's scope is set to the network driver's datascope.

type NetworkWalker func(nw *Network)bool

type PortConfig struct {// Name for the port. If provided the port information can// be queried using the name as in a DNS SRV query.Namestring `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Protocol for the port which is exposed.ProtocolPortConfig_Protocol `protobuf:"varint,2,opt,name=protocol,proto3,enum=libnetwork.PortConfig_Protocol" json:"protocol,omitempty"`// The port which the application is exposing and is bound to.TargetPortuint32 `protobuf:"varint,3,opt,name=target_port,json=targetPort,proto3" json:"target_port,omitempty"`// PublishedPort specifies the port on which the service is// exposed on all nodes on the cluster. If not specified an// arbitrary port in the node port range is allocated by the// system. If specified it should be within the node port// range and it should be available.PublishedPortuint32 `protobuf:"varint,4,opt,name=published_port,json=publishedPort,proto3" json:"published_port,omitempty"`}

func (*PortConfig)Descriptor¶

func (*PortConfig) Descriptor() ([]byte, []int)

func (*PortConfig)GetName¶

func (m *PortConfig) GetName()string

func (*PortConfig)GetProtocol¶

func (m *PortConfig) GetProtocol()PortConfig_Protocol

func (*PortConfig)GetPublishedPort¶

func (m *PortConfig) GetPublishedPort()uint32

func (*PortConfig)GetTargetPort¶

func (m *PortConfig) GetTargetPort()uint32

func (*PortConfig)GoString¶

func (this *PortConfig) GoString()string

func (*PortConfig)Marshal¶

func (m *PortConfig) Marshal() (dAtA []byte, errerror)

func (*PortConfig)MarshalTo¶

func (m *PortConfig) MarshalTo(dAtA []byte) (int,error)

func (*PortConfig)MarshalToSizedBuffer¶

func (m *PortConfig) MarshalToSizedBuffer(dAtA []byte) (int,error)

func (*PortConfig)ProtoMessage¶

func (*PortConfig) ProtoMessage()

func (*PortConfig)Reset¶

func (m *PortConfig) Reset()

func (*PortConfig)Size¶

func (m *PortConfig) Size() (nint)

func (*PortConfig)String¶

func (this *PortConfig) String()string

func (*PortConfig)Unmarshal¶

func (m *PortConfig) Unmarshal(dAtA []byte)error

func (*PortConfig)XXX_DiscardUnknown¶

func (m *PortConfig) XXX_DiscardUnknown()

func (*PortConfig)XXX_Marshal¶

func (m *PortConfig) XXX_Marshal(b []byte, deterministicbool) ([]byte,error)

func (*PortConfig)XXX_Merge¶

func (m *PortConfig) XXX_Merge(srcproto.Message)

func (*PortConfig)XXX_Size¶

func (m *PortConfig) XXX_Size()int

func (*PortConfig)XXX_Unmarshal¶

func (m *PortConfig) XXX_Unmarshal(b []byte)error

type PortConfig_Protocolint32

func (PortConfig_Protocol)EnumDescriptor¶

func (PortConfig_Protocol) EnumDescriptor() ([]byte, []int)

func (PortConfig_Protocol)String¶

func (xPortConfig_Protocol) String()string

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

funcNewResolver¶

func NewResolver(addressstring, proxyDNSbool, backendDNSBackend) *Resolver

NewResolver creates a new instance of the Resolver

func (*Resolver)NameServer¶

func (r *Resolver) NameServer()netip.Addr

NameServer returns the IP of the DNS resolver for the containers.

func (*Resolver)ResolverOptions¶

func (r *Resolver) ResolverOptions() []string

ResolverOptions returns resolv.conf options that should be set.

func (*Resolver)SetExtServers¶

func (r *Resolver) SetExtServers(extDNS []extDNSEntry)

SetExtServers configures the external nameservers the resolver should usewhen forwarding queries, unless SetExtServersForSrc has configured serversfor the DNS client making the request.

func (*Resolver)SetExtServersForSrc¶

func (r *Resolver) SetExtServersForSrc(srcAddrnetip.Addr, extDNS []extDNSEntry)error

SetExtServersForSrc configures the external nameservers the resolver shoulduse when forwarding queries from srcAddr. If set, these servers will be usedin preference to servers set by SetExtServers. Supplying a nil or empty extDNSdeletes nameservers for srcAddr.

func (*Resolver)SetForwardingPolicy¶

func (r *Resolver) SetForwardingPolicy(policybool)

SetForwardingPolicy re-configures the embedded DNS resolver to either enable or disable forwarding DNS queries toexternal servers.

func (*Resolver)SetupFunc¶

func (r *Resolver) SetupFunc(portuint16) func()

SetupFunc returns the setup function that should be run in the container'snetwork namespace.

func (*Resolver)Start¶

func (r *Resolver) Start()error

Start starts the name server for the container.

func (*Resolver)Stop¶

func (r *Resolver) Stop()

Stop stops the name server for the container. A stopped resolver can bereused after running the SetupFunc again.

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

func (*Sandbox)AddHostsEntry¶

func (sb *Sandbox) AddHostsEntry(ctxcontext.Context, namestring, ipnetip.Addr)error

AddHostsEntry adds an entry to /etc/hosts.

func (*Sandbox)ContainerID¶

func (sb *Sandbox) ContainerID()string

ContainerID returns the container id associated to this sandbox.

func (*Sandbox)Delete¶

func (sb *Sandbox) Delete(ctxcontext.Context)error

Delete destroys this container after detaching it from all connected endpoints.

func (*Sandbox)DisableService¶

func (sb *Sandbox) DisableService()error

DisableService removes a managed container's endpoints from the load balancerand service discovery.

func (*Sandbox)EnableService¶

func (sb *Sandbox) EnableService() (retErrerror)

EnableService makes a managed container's service available by adding theendpoint to the service load balancer and service discovery.

func (*Sandbox)Endpoints¶

func (sb *Sandbox) Endpoints() []*Endpoint

Endpoints returns all the endpoints connected to the sandbox.

func (*Sandbox)ExecFunc¶

func (sb *Sandbox) ExecFunc(f func())error

func (*Sandbox)GetEndpoint¶

func (sb *Sandbox) GetEndpoint(idstring) *Endpoint

func (*Sandbox)HandleQueryResp¶

func (sb *Sandbox) HandleQueryResp(namestring, ipnet.IP)

func (*Sandbox)ID¶

func (sb *Sandbox) ID()string

ID returns the ID of the sandbox.

func (*Sandbox)IPv6Enabled¶

func (sb *Sandbox) IPv6Enabled() (enabled, okbool)

IPv6Enabled determines whether a container supports IPv6.IPv6 support can always be determined for host networking. For other networktypes it can only be determined once there's a container namespace to probe,return ok=false in that case.

func (*Sandbox)Key¶

func (sb *Sandbox) Key()string

Key returns the sandbox's key.

func (*Sandbox)Labels¶

func (sb *Sandbox) Labels() map[string]any

Labels returns the sandbox's labels.

func (*Sandbox)MarshalJSON¶

func (sb *Sandbox) MarshalJSON() ([]byte,error)

func (*Sandbox)NdotsSet¶

func (sb *Sandbox) NdotsSet()bool

func (*Sandbox)NetnsPath¶

func (sb *Sandbox) NetnsPath() (pathstring, okbool)

NetnsPath returns the network namespace's path and true, if a network has beencreated - else the empty string and false.

func (*Sandbox)Refresh¶

func (sb *Sandbox) Refresh(ctxcontext.Context, options ...SandboxOption)error

Refresh leaves all the endpoints, resets and re-applies the options,re-joins all the endpoints without destroying the osl sandbox

func (*Sandbox)Rename¶

func (sb *Sandbox) Rename(namestring)error

Rename changes the name of all attached Endpoints.

func (*Sandbox)ResolveIP¶

func (sb *Sandbox) ResolveIP(ctxcontext.Context, ipstring)string

func (*Sandbox)ResolveName¶

func (sb *Sandbox) ResolveName(ctxcontext.Context, namestring, ipTypetypes.IPFamily) ([]net.IP,bool)

func (*Sandbox)ResolveService¶

func (sb *Sandbox) ResolveService(ctxcontext.Context, namestring) ([]*net.SRV, []net.IP)

ResolveService returns all the backend details about the containers or hostsbacking a service. Its purpose is to satisfy an SRV query.

func (*Sandbox)SetKey¶

func (sb *Sandbox) SetKey(ctxcontext.Context, basePathstring)error

SetKey updates the Sandbox Key.

func (*Sandbox)Statistics¶

func (sb *Sandbox) Statistics() (map[string]*types.InterfaceStatistics,error)

Statistics retrieves the interfaces' statistics for the sandbox.

func (*Sandbox)UnmarshalJSON¶

func (sb *Sandbox) UnmarshalJSON(b []byte) (errerror)

func (*Sandbox)UpdateHostsEntry¶

func (sb *Sandbox) UpdateHostsEntry(regexpstring, ipnetip.Addr)error

UpdateHostsEntry updates the IP address in a /etc/hosts entry where thename matches the regular expression regexp.

func (*Sandbox)UpdateLabels¶

func (sb *Sandbox) UpdateLabels(labels map[string]any)

type SandboxOption func(sb *Sandbox)

funcOptionDNS¶

func OptionDNS(dns []netip.Addr)SandboxOption

OptionDNS function returns an option setter for dns entry option tobe passed to container Create method.

funcOptionDNSOptions¶

func OptionDNSOptions(options []string)SandboxOption

OptionDNSOptions function returns an option setter for dns options entry option tobe passed to container Create method.

funcOptionDNSSearch¶

func OptionDNSSearch(search []string)SandboxOption

OptionDNSSearch function returns an option setter for dns search entry option tobe passed to container Create method.

funcOptionDomainname¶

func OptionDomainname(namestring)SandboxOption

OptionDomainname function returns an option setter for domainname option tobe passed to NewSandbox method.

funcOptionExposedPorts¶

func OptionExposedPorts(exposedPorts []types.TransportPort)SandboxOption

OptionExposedPorts function returns an option setter for the container exposedports option to be passed to container Create method.

funcOptionExtraHost¶

func OptionExtraHost(namestring, IPnetip.Addr)SandboxOption

OptionExtraHost function returns an option setter for extra /etc/hosts optionswhich is a name and IP as strings.

funcOptionHostname¶

func OptionHostname(namestring)SandboxOption

OptionHostname function returns an option setter for hostname option tobe passed to NewSandbox method.

funcOptionHostsPath¶

func OptionHostsPath(pathstring)SandboxOption

OptionHostsPath function returns an option setter for hostspath option tobe passed to NewSandbox method.

funcOptionIngress¶

func OptionIngress()SandboxOption

OptionIngress function returns an option setter for marking asandbox as the controller's ingress sandbox.

funcOptionLoadBalancer¶

func OptionLoadBalancer(nidstring)SandboxOption

OptionLoadBalancer function returns an option setter for marking asandbox as a load balancer sandbox.

funcOptionOriginHostsPath¶

func OptionOriginHostsPath(pathstring)SandboxOption

OptionOriginHostsPath function returns an option setter for origin hosts file pathto be passed to NewSandbox method.

funcOptionOriginResolvConfPath¶

func OptionOriginResolvConfPath(pathstring)SandboxOption

OptionOriginResolvConfPath function returns an option setter to set the path to theorigin resolv.conf file to be passed to net container methods.

funcOptionPortMapping¶

func OptionPortMapping(portBindings []types.PortBinding)SandboxOption

OptionPortMapping function returns an option setter for the mappingports option to be passed to container Create method.

funcOptionResolvConfPath¶

func OptionResolvConfPath(pathstring)SandboxOption

OptionResolvConfPath function returns an option setter for resolvconfpath option tobe passed to net container methods.

funcOptionUseDefaultSandbox¶

func OptionUseDefaultSandbox()SandboxOption

OptionUseDefaultSandbox function returns an option setter for using default sandbox(host namespace) to be passed to container Create method.

funcOptionUseExternalKey¶

func OptionUseExternalKey()SandboxOption

OptionUseExternalKey function returns an option setter for using provided namespaceinstead of creating one.

type ServiceInfo struct {VIPstringLocalLBIndexintTasks        []TaskPorts        []string}

type Task struct {NamestringEndpointIDstringEndpointIPstringInfo       map[string]string}