restserver

Documentation

Index

• Constants
• func NewHTTPRestService(config *common.ServiceConfig, ...) (cns.HTTPService, error)
• func ReturnCodeToString(returnCode int) (s string)
• type HTTPRestService
  • func (service *HTTPRestService) AllocateAnyAvailableIPConfig(podInfo cns.KubernetesPodInfo, orchestratorContext json.RawMessage) (cns.PodIpInfo, error)
  • func (service *HTTPRestService) AllocateDesiredIPConfig(podInfo cns.KubernetesPodInfo, desiredIPAddress string, ...) (cns.PodIpInfo, error)
  • func (service *HTTPRestService) CreateOrUpdateNetworkContainerInternal(req cns.CreateNetworkContainerRequest, scalar nnc.Scaler, ...) int
  • func (service *HTTPRestService) GetAllocatedIPConfigs() []cns.IPConfigurationStatus
  • func (service *HTTPRestService) GetAvailableIPConfigs() []cns.IPConfigurationStatus
  • func (service *HTTPRestService) GetExistingIPConfig(podInfo cns.KubernetesPodInfo) (cns.PodIpInfo, bool, error)
  • func (service *HTTPRestService) GetPartitionKey() (dncPartitionKey string)
  • func (service *HTTPRestService) GetPendingProgramIPConfigs() []cns.IPConfigurationStatus
  • func (service *HTTPRestService) GetPendingReleaseIPConfigs() []cns.IPConfigurationStatus
  • func (service *HTTPRestService) GetPodIPConfigState() map[string]cns.IPConfigurationStatus
  • func (service *HTTPRestService) MarkExistingIPsAsPending(pendingIPIDs []string) error
  • func (service *HTTPRestService) MarkIPsAsPending(numberToMark int) (map[string]cns.IPConfigurationStatus, error)
  • func (service *HTTPRestService) ReconcileNCState(ncRequest *cns.CreateNetworkContainerRequest, ...) int
  • func (service *HTTPRestService) SendNCSnapShotPeriodically(ncSnapshotIntervalInMinutes int, stopSnapshot chan bool)
  • func (service *HTTPRestService) SetNodeOrchestrator(r *cns.SetOrchestratorTypeRequest)
  • func (service *HTTPRestService) Start(config *common.ServiceConfig) error
  • func (service *HTTPRestService) Stop()
  • func (service *HTTPRestService) SyncNodeStatus(dncEP, infraVnet, nodeID string, contextFromCNI json.RawMessage) (returnCode int, errStr string)

Constants

const (
	Success                                = 0
	UnsupportedNetworkType                 = 1
	InvalidParameter                       = 2
	UnsupportedEnvironment                 = 3
	UnreachableHost                        = 4
	ReservationNotFound                    = 5
	MalformedSubnet                        = 8
	UnreachableDockerDaemon                = 9
	UnspecifiedNetworkName                 = 10
	NotFound                               = 14
	AddressUnavailable                     = 15
	NetworkContainerNotSpecified           = 16
	CallToHostFailed                       = 17
	UnknownContainerID                     = 18
	UnsupportedOrchestratorType            = 19
	DockerContainerNotSpecified            = 20
	UnsupportedVerb                        = 21
	UnsupportedNetworkContainerType        = 22
	InvalidRequest                         = 23
	NetworkJoinFailed                      = 24
	NetworkContainerPublishFailed          = 25
	NetworkContainerUnpublishFailed        = 26
	InvalidPrimaryIPConfig                 = 27
	PrimaryCANotSame                       = 28
	InconsistentIPConfigState              = 29
	InvalidSecondaryIPConfig               = 30
	NetworkContainerVfpProgramPending      = 31
	FailedToAllocateIpConfig               = 32
	EmptyOrchestratorContext               = 33
	UnsupportedOrchestratorContext         = 34
	NetworkContainerVfpProgramComplete     = 35
	NetworkContainerVfpProgramCheckSkipped = 36
	UnexpectedError                        = 99
)

Container Network Service remote API Contract.

Functions

func NewHTTPRestService

func NewHTTPRestService(config *common.ServiceConfig, imdsClientInterface imdsclient.ImdsClientInterface) (cns.HTTPService, error)

NewHTTPRestService creates a new HTTP Service object.

func ReturnCodeToString

func ReturnCodeToString(returnCode int) (s string)

ReturnCodeToString - Converts an error code to appropriate string.

Types

type HTTPRestService

type HTTPRestService struct {
	*cns.Service

	PodIPIDByOrchestratorContext map[string]string                    // OrchestratorContext is key and value is Pod IP uuid.
	PodIPConfigState             map[string]cns.IPConfigurationStatus // seondaryipid(uuid) is key
	AllocatedIPCount             map[string]allocatedIPCount          // key - ncid
	IPAMPoolMonitor              cns.IPAMPoolMonitor

	sync.RWMutex
	// contains filtered or unexported fields
}

HTTPRestService represents http listener for CNS - Container Networking Service.

func (*HTTPRestService) AllocateAnyAvailableIPConfig

func (service *HTTPRestService) AllocateAnyAvailableIPConfig(podInfo cns.KubernetesPodInfo, orchestratorContext json.RawMessage) (cns.PodIpInfo, error)

func (*HTTPRestService) AllocateDesiredIPConfig

func (service *HTTPRestService) AllocateDesiredIPConfig(podInfo cns.KubernetesPodInfo, desiredIPAddress string, orchestratorContext json.RawMessage) (cns.PodIpInfo, error)

func (*HTTPRestService) CreateOrUpdateNetworkContainerInternal

func (service *HTTPRestService) CreateOrUpdateNetworkContainerInternal(req cns.CreateNetworkContainerRequest, scalar nnc.Scaler, spec nnc.NodeNetworkConfigSpec) int

This API will be called by CNS RequestController on CRD update.

func (*HTTPRestService) GetAllocatedIPConfigs

func (service *HTTPRestService) GetAllocatedIPConfigs() []cns.IPConfigurationStatus

func (*HTTPRestService) GetAvailableIPConfigs

func (service *HTTPRestService) GetAvailableIPConfigs() []cns.IPConfigurationStatus

func (*HTTPRestService) GetExistingIPConfig

func (service *HTTPRestService) GetExistingIPConfig(podInfo cns.KubernetesPodInfo) (cns.PodIpInfo, bool, error)

func (*HTTPRestService) GetPartitionKey

func (service *HTTPRestService) GetPartitionKey() (dncPartitionKey string)

GetPartitionKey - Get dnc/service partition key

func (*HTTPRestService) GetPendingProgramIPConfigs

func (service *HTTPRestService) GetPendingProgramIPConfigs() []cns.IPConfigurationStatus

GetPendingProgramIPConfigs returns list of IPs which are in pending program status

func (*HTTPRestService) GetPendingReleaseIPConfigs

func (service *HTTPRestService) GetPendingReleaseIPConfigs() []cns.IPConfigurationStatus

func (*HTTPRestService) GetPodIPConfigState

func (service *HTTPRestService) GetPodIPConfigState() map[string]cns.IPConfigurationStatus

func (*HTTPRestService) MarkExistingIPsAsPending

func (service *HTTPRestService) MarkExistingIPsAsPending(pendingIPIDs []string) error

called when CNS is starting up and there are existing ipconfigs in the CRD that are marked as pending

func (*HTTPRestService) MarkIPsAsPending

func (service *HTTPRestService) MarkIPsAsPending(numberToMark int) (map[string]cns.IPConfigurationStatus, error)

func (*HTTPRestService) ReconcileNCState

func (service *HTTPRestService) ReconcileNCState(ncRequest *cns.CreateNetworkContainerRequest, podInfoByIp map[string]cns.KubernetesPodInfo, scalar nnc.Scaler, spec nnc.NodeNetworkConfigSpec) int

This API will be called by CNS RequestController on CRD update.

func (*HTTPRestService) SendNCSnapShotPeriodically

func (service *HTTPRestService) SendNCSnapShotPeriodically(ncSnapshotIntervalInMinutes int, stopSnapshot chan bool)

Sets up periodic timer for sending network container snapshots

func (*HTTPRestService) SetNodeOrchestrator

func (service *HTTPRestService) SetNodeOrchestrator(r *cns.SetOrchestratorTypeRequest)

SetNodeOrchestrator :- Set node orchestrator after registering with mDNC

func (*HTTPRestService) Start

func (service *HTTPRestService) Start(config *common.ServiceConfig) error

Start starts the CNS listener.

func (*HTTPRestService) Stop

func (service *HTTPRestService) Stop()

Stop stops the CNS.

func (*HTTPRestService) SyncNodeStatus

func (service *HTTPRestService) SyncNodeStatus(dncEP, infraVnet, nodeID string, contextFromCNI json.RawMessage) (returnCode int, errStr string)

SyncNodeStatus :- Retrieve the latest node state from DNC & returns the first occurence of returnCode and error with respect to contextFromCNI