cnsclient

Documentation

Index

• func HandleCNSClientCommands(cmd, arg string) error
• func IsNotFound(err error) bool
• type APIClient
• type CNSClient
  • func GetCnsClient() (*CNSClient, error)
  • func InitCnsClient(url string, requestTimeout time.Duration) (*CNSClient, error)
  • func (cnsClient *CNSClient) CreateHostNCApipaEndpoint(networkContainerID string) (string, error)
  • func (cnsClient *CNSClient) DeleteHostNCApipaEndpoint(networkContainerID string) error
  • func (cnsClient *CNSClient) GetHTTPServiceData() (restserver.GetHTTPServiceDataResponse, error)
  • func (cnsClient *CNSClient) GetIPAddressesMatchingStates(stateFilter ...cns.IPConfigState) ([]cns.IPConfigurationStatus, error)
  • func (cnsClient *CNSClient) GetNetworkConfiguration(orchestratorContext []byte) (*cns.GetNetworkContainerResponse, error)
  • func (cnsClient *CNSClient) GetPodOrchestratorContext() (map[string]string, error)
  • func (cnsClient *CNSClient) ReleaseIPAddress(ipconfig *cns.IPConfigRequest) error
  • func (cnsClient *CNSClient) RequestIPAddress(ipconfig *cns.IPConfigRequest) (*cns.IPConfigResponse, error)
• type CNSClientError
  • func (e *CNSClientError) Error() string

Functions

func HandleCNSClientCommands

func HandleCNSClientCommands(cmd, arg string) error

func IsNotFound

func IsNotFound(err error) bool

IsNotFound tests if the provided error is of type CNSClientError and then further tests if the error code is of type UnknowContainerID

Types

type APIClient

type APIClient interface {
	ReconcileNCState(nc *cns.CreateNetworkContainerRequest, pods map[string]cns.PodInfo, scalar v1alpha.Scaler, spec v1alpha.NodeNetworkConfigSpec) error
	CreateOrUpdateNC(nc cns.CreateNetworkContainerRequest) error
	UpdateIPAMPoolMonitor(scalar v1alpha.Scaler, spec v1alpha.NodeNetworkConfigSpec)
	GetNC(nc cns.GetNetworkContainerRequest) (cns.GetNetworkContainerResponse, error)
	DeleteNC(nc cns.DeleteNetworkContainerRequest) error
}

APIClient interface to update cns state

type CNSClient

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

CNSClient specifies a client to connect to Ipam Plugin.

func GetCnsClient

func GetCnsClient() (*CNSClient, error)

GetCnsClient returns the cns client object

func InitCnsClient

func InitCnsClient(url string, requestTimeout time.Duration) (*CNSClient, error)

InitCnsClient initializes new cns client and returns the object

func (*CNSClient) CreateHostNCApipaEndpoint

func (cnsClient *CNSClient) CreateHostNCApipaEndpoint(networkContainerID string) (string, error)

CreateHostNCApipaEndpoint creates an endpoint in APIPA network for host container connectivity.

func (*CNSClient) DeleteHostNCApipaEndpoint

func (cnsClient *CNSClient) DeleteHostNCApipaEndpoint(networkContainerID string) error

DeleteHostNCApipaEndpoint deletes the endpoint in APIPA network created for host container connectivity.

func (*CNSClient) GetHTTPServiceData

func (cnsClient *CNSClient) GetHTTPServiceData() (restserver.GetHTTPServiceDataResponse, error)

GetHTTPServiceData gets all public in-memory struct details for debugging purpose

func (*CNSClient) GetIPAddressesMatchingStates

func (cnsClient *CNSClient) GetIPAddressesMatchingStates(stateFilter ...cns.IPConfigState) ([]cns.IPConfigurationStatus, error)

GetIPAddressesWithStates takes a variadic number of string parameters, to get all IP Addresses matching a number of states usage GetIPAddressesWithStates(cns.Available, cns.Allocated)

func (*CNSClient) GetNetworkConfiguration

func (cnsClient *CNSClient) GetNetworkConfiguration(orchestratorContext []byte) (
	*cns.GetNetworkContainerResponse, error)

GetNetworkConfiguration Request to get network config.

func (*CNSClient) GetPodOrchestratorContext

func (cnsClient *CNSClient) GetPodOrchestratorContext() (map[string]string, error)

GetPodOrchestratorContext calls GetPodIpOrchestratorContext API on CNS

func (*CNSClient) ReleaseIPAddress

func (cnsClient *CNSClient) ReleaseIPAddress(ipconfig *cns.IPConfigRequest) error

ReleaseIPAddress calls releaseIPAddress on CNS, ipaddress ex: (10.0.0.1)

func (*CNSClient) RequestIPAddress

func (cnsClient *CNSClient) RequestIPAddress(ipconfig *cns.IPConfigRequest) (*cns.IPConfigResponse, error)

RequestIPAddress calls the requestIPAddress in CNS

type CNSClientError

type CNSClientError struct {
	Code types.ResponseCode
	Err  error
}

CNSClientError records an error and relevant code

func (*CNSClientError) Error

func (e *CNSClientError) Error() string