model

Documentation

Index

• Constants
• func EndpointIdFromIPAddressAndPort(address string, port Port) string
• type Changes
  • func (c *Changes) HasDeletes() bool
  • func (c *Changes) HasUpdates() bool
  • func (c *Changes) IsNone() bool
• type ClusterUtils
  • func NewClusterUtils(client client.Client) ClusterUtils
  • func NewClusterUtilsWithValues(clusterId string, clusterSetId string) ClusterUtils
  • func (r *ClusterUtils) GetClusterProperties(ctx context.Context) (*clusterProperties, error)
  • func (r *ClusterUtils) LoadClusterProperties(ctx context.Context) error
• type Endpoint
  • func NewEndpointFromInstance(inst *types.HttpInstanceSummary) (*Endpoint, error)
  • func (e *Endpoint) Equals(other *Endpoint) bool
  • func (e *Endpoint) GetCloudMapAttributes() map[string]string
  • func (e *Endpoint) String() string
• type Namespace
• type NamespaceType
  • func ConvertNamespaceType(nsType types.NamespaceType) (namespaceType NamespaceType)
  • func (namespaceType *NamespaceType) IsUnsupported() bool
• type Plan
  • func (p *Plan) CalculateChanges() Changes
• type Port
  • func (p *Port) Equals(other *Port) bool
  • func (p *Port) GetID() string
• type Service
  • func (svc *Service) GetEndpoints(clusterId string) (endpts []*Endpoint)
• type ServiceType
  • func (serviceType ServiceType) String() string

Constants

const (
	ClusterIdPropertyName    = "cluster.clusterset.k8s.io"
	ClusterSetIdPropertyName = "clusterset.k8s.io"
)

const (
	EndpointIpv4Attr          = "AWS_INSTANCE_IPV4"
	EndpointPortAttr          = "AWS_INSTANCE_PORT"
	EndpointPortNameAttr      = "ENDPOINT_PORT_NAME"
	EndpointProtocolAttr      = "ENDPOINT_PROTOCOL"
	EndpointReadyAttr         = "READY"
	EndpointHostnameAttr      = "HOSTNAME"
	EndpointNodeNameAttr      = "NODENAME"
	ClusterIdAttr             = "CLUSTER_ID"
	ClusterSetIdAttr          = "CLUSTERSET_ID"
	ServicePortNameAttr       = "SERVICE_PORT_NAME"
	ServicePortAttr           = "SERVICE_PORT"
	ServiceTargetPortAttr     = "SERVICE_TARGET_PORT"
	ServiceProtocolAttr       = "SERVICE_PROTOCOL"
	ServiceTypeAttr           = "SERVICE_TYPE"
	ServiceExportCreationAttr = "SERVICE_EXPORT_CREATION_TIMESTAMP"
	K8sVersionAttr            = "K8S_CONTROLLER"
)

Cloudmap Instances IP and Port is supposed to be AWS_INSTANCE_IPV4 and AWS_INSTANCE_PORT Rest are custom attributes

Functions

func EndpointIdFromIPAddressAndPort

func EndpointIdFromIPAddressAndPort(address string, port Port) string

EndpointIdFromIPAddressAndPort converts an IP address to human-readable identifier.

Types

type Changes

type Changes struct {
	// List of endpoints that need to be created
	Create []*Endpoint
	// List of endpoints that need to be updated
	Update []*Endpoint
	// List of endpoints that need to be deleted
	Delete []*Endpoint
}

func (*Changes) HasDeletes

func (c *Changes) HasDeletes() bool

func (*Changes) HasUpdates

func (c *Changes) HasUpdates() bool

func (*Changes) IsNone

func (c *Changes) IsNone() bool

type ClusterUtils

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

ClusterUtils provides utility functions for working with clusters

func NewClusterUtils

func NewClusterUtils(client client.Client) ClusterUtils

func NewClusterUtilsWithValues

func NewClusterUtilsWithValues(clusterId string, clusterSetId string) ClusterUtils

func (*ClusterUtils) GetClusterProperties

func (r *ClusterUtils) GetClusterProperties(ctx context.Context) (*clusterProperties, error)

func (*ClusterUtils) LoadClusterProperties

func (r *ClusterUtils) LoadClusterProperties(ctx context.Context) error

type Endpoint

type Endpoint struct {
	Id                             string
	IP                             string
	EndpointPort                   Port
	ServicePort                    Port
	ClusterId                      string
	ClusterSetId                   string
	ServiceType                    ServiceType
	ServiceExportCreationTimestamp int64
	Ready                          bool
	Hostname                       string
	Nodename                       string
	Attributes                     map[string]string
}

Endpoint holds basic values and attributes for an endpoint.

func NewEndpointFromInstance

func NewEndpointFromInstance(inst *types.HttpInstanceSummary) (*Endpoint, error)

NewEndpointFromInstance converts a Cloud Map HttpInstanceSummary to an endpoint.

func (*Endpoint) Equals

func (e *Endpoint) Equals(other *Endpoint) bool

Equals evaluates if two Endpoints are "deeply equal" (including all fields).

func (*Endpoint) GetCloudMapAttributes

func (e *Endpoint) GetCloudMapAttributes() map[string]string

GetCloudMapAttributes extracts endpoint attributes for Cloud Map service instance registration.

func (*Endpoint) String

func (e *Endpoint) String() string

String gives a string representation for an endpoint.

type Namespace

type Namespace struct {
	Id   string
	Name string
	Type NamespaceType
}

Namespace hold namespace attributes

type NamespaceType

type NamespaceType string

const (
	HttpNamespaceType       NamespaceType = "HTTP"
	DnsPrivateNamespaceType NamespaceType = "DNS_PRIVATE"
	// UnsupportedNamespaceType Placeholder NamespaceType to denote not supported values
	UnsupportedNamespaceType NamespaceType = ""
)

func ConvertNamespaceType

func ConvertNamespaceType(nsType types.NamespaceType) (namespaceType NamespaceType)

func (*NamespaceType) IsUnsupported

func (namespaceType *NamespaceType) IsUnsupported() bool

type Plan

type Plan struct {
	// List of current instances
	Current []*Endpoint

	// List of desired instances
	Desired []*Endpoint
}

func (*Plan) CalculateChanges

func (p *Plan) CalculateChanges() Changes

CalculateChanges returns list of Changes that need to applied

type Port

type Port struct {
	Name       string
	Port       int32
	TargetPort string
	Protocol   string // TCP, UDP, SCTP
}

func (*Port) Equals

func (p *Port) Equals(other *Port) bool

Equals evaluates if two Ports are "deeply equal" (including all fields).

func (*Port) GetID

func (p *Port) GetID() string

type Service

type Service struct {
	Namespace string
	Name      string
	Endpoints []*Endpoint
}

Service holds namespace and endpoint state for a named service.

func (*Service) GetEndpoints

func (svc *Service) GetEndpoints(clusterId string) (endpts []*Endpoint)

type ServiceType

type ServiceType string

const (
	HeadlessType     ServiceType = "Headless"
	ClusterSetIPType ServiceType = "ClusterSetIP"
)

func (ServiceType) String

func (serviceType ServiceType) String() string

Gives string representation for ServiceType