endpoint

Documentation

Overview

Package endpoint is a generated GoMock package.

Package endpoint defines the interface for an endpoints provider. Endpoints providers communicate with the compute platforms and are primarily responsible for providing information regarding the endpoints for services, such as their IP addresses, port numbers and protocol information. Reference: https://github.com/openservicemesh/osm/blob/main/DESIGN.md#3-endpoints-providers

Index

• type Endpoint
  • func (ep Endpoint) String() string
• type MockProvider
  • func NewMockProvider(ctrl *gomock.Controller) *MockProvider
  • func (m *MockProvider) EXPECT() *MockProviderMockRecorder
  • func (m *MockProvider) GetID() string
  • func (m *MockProvider) GetResolvableEndpointsForService(arg0 service.MeshService) ([]Endpoint, error)
  • func (m *MockProvider) GetServicesForServiceAccount(arg0 service.K8sServiceAccount) ([]service.MeshService, error)
  • func (m *MockProvider) GetTargetPortToProtocolMappingForService(arg0 service.MeshService) (map[uint32]string, error)
  • func (m *MockProvider) ListEndpointsForIdentity(arg0 service.K8sServiceAccount) []Endpoint
  • func (m *MockProvider) ListEndpointsForService(arg0 service.MeshService) []Endpoint
• type MockProviderMockRecorder
  • func (mr *MockProviderMockRecorder) GetID() *gomock.Call
  • func (mr *MockProviderMockRecorder) GetResolvableEndpointsForService(arg0 interface{}) *gomock.Call
  • func (mr *MockProviderMockRecorder) GetServicesForServiceAccount(arg0 interface{}) *gomock.Call
  • func (mr *MockProviderMockRecorder) GetTargetPortToProtocolMappingForService(arg0 interface{}) *gomock.Call
  • func (mr *MockProviderMockRecorder) ListEndpointsForIdentity(arg0 interface{}) *gomock.Call
  • func (mr *MockProviderMockRecorder) ListEndpointsForService(arg0 interface{}) *gomock.Call
• type Port
• type Provider

Types

type Endpoint

type Endpoint struct {
	net.IP `json:"ip"`
	Port   `json:"port"`
}

Endpoint is a tuple of IP and Port representing an instance of a service

func (Endpoint) String

func (ep Endpoint) String() string

type MockProvider

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

MockProvider is a mock of Provider interface

func NewMockProvider

func NewMockProvider(ctrl *gomock.Controller) *MockProvider

NewMockProvider creates a new mock instance

func (*MockProvider) EXPECT

func (m *MockProvider) EXPECT() *MockProviderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockProvider) GetID

func (m *MockProvider) GetID() string

GetID mocks base method

func (*MockProvider) GetResolvableEndpointsForService

func (m *MockProvider) GetResolvableEndpointsForService(arg0 service.MeshService) ([]Endpoint, error)

GetResolvableEndpointsForService mocks base method

func (*MockProvider) GetServicesForServiceAccount

func (m *MockProvider) GetServicesForServiceAccount(arg0 service.K8sServiceAccount) ([]service.MeshService, error)

GetServicesForServiceAccount mocks base method

func (*MockProvider) GetTargetPortToProtocolMappingForService

func (m *MockProvider) GetTargetPortToProtocolMappingForService(arg0 service.MeshService) (map[uint32]string, error)

GetTargetPortToProtocolMappingForService mocks base method

func (*MockProvider) ListEndpointsForIdentity

func (m *MockProvider) ListEndpointsForIdentity(arg0 service.K8sServiceAccount) []Endpoint

ListEndpointsForIdentity mocks base method

func (*MockProvider) ListEndpointsForService

func (m *MockProvider) ListEndpointsForService(arg0 service.MeshService) []Endpoint

ListEndpointsForService mocks base method

type MockProviderMockRecorder

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

MockProviderMockRecorder is the mock recorder for MockProvider

func (*MockProviderMockRecorder) GetID

func (mr *MockProviderMockRecorder) GetID() *gomock.Call

GetID indicates an expected call of GetID

func (*MockProviderMockRecorder) GetResolvableEndpointsForService

func (mr *MockProviderMockRecorder) GetResolvableEndpointsForService(arg0 interface{}) *gomock.Call

GetResolvableEndpointsForService indicates an expected call of GetResolvableEndpointsForService

func (*MockProviderMockRecorder) GetServicesForServiceAccount

func (mr *MockProviderMockRecorder) GetServicesForServiceAccount(arg0 interface{}) *gomock.Call

GetServicesForServiceAccount indicates an expected call of GetServicesForServiceAccount

func (*MockProviderMockRecorder) GetTargetPortToProtocolMappingForService

func (mr *MockProviderMockRecorder) GetTargetPortToProtocolMappingForService(arg0 interface{}) *gomock.Call

GetTargetPortToProtocolMappingForService indicates an expected call of GetTargetPortToProtocolMappingForService

func (*MockProviderMockRecorder) ListEndpointsForIdentity

func (mr *MockProviderMockRecorder) ListEndpointsForIdentity(arg0 interface{}) *gomock.Call

ListEndpointsForIdentity indicates an expected call of ListEndpointsForIdentity

func (*MockProviderMockRecorder) ListEndpointsForService

func (mr *MockProviderMockRecorder) ListEndpointsForService(arg0 interface{}) *gomock.Call

ListEndpointsForService indicates an expected call of ListEndpointsForService

type Port

type Port uint32

Port is a numerical type representing a port on which a service is exposed

type Provider

type Provider interface {
	// Retrieve the IP addresses comprising the given service.
	ListEndpointsForService(service.MeshService) []Endpoint

	// ListEndpointsForIdentity retrieves the list of IP addresses for the given service account
	ListEndpointsForIdentity(service.K8sServiceAccount) []Endpoint

	// Retrieve the namespaced services for a given service account
	GetServicesForServiceAccount(service.K8sServiceAccount) ([]service.MeshService, error)

	// GetTargetPortToProtocolMappingForService returns a mapping of the service's ports to their corresponding application protocol
	GetTargetPortToProtocolMappingForService(service.MeshService) (map[uint32]string, error)

	// Returns the expected endpoints that are to be reached when the service FQDN is resolved under
	// the scope of the provider
	GetResolvableEndpointsForService(service.MeshService) ([]Endpoint, error)

	// GetID returns the unique identifier of the EndpointsProvider.
	GetID() string
}

Provider is an interface to be implemented by components abstracting Kubernetes, and other compute/cluster providers