service

Documentation

Overview

Package service models an instance of a service managed by OSM controller and utility routines associated with it.

Index

• type ClusterName
  • func (c ClusterName) String() string
• type K8sServiceAccount
  • func (sa K8sServiceAccount) IsEmpty() bool
  • func (sa K8sServiceAccount) String() string
• type MeshService
  • func UnmarshalMeshService(str string) (*MeshService, error)
  • func (ms MeshService) Equals(service MeshService) bool
  • func (ms MeshService) ServerName() string
  • func (ms MeshService) String() string
• type WeightedCluster

Types

type ClusterName

type ClusterName string

ClusterName is a type for a service name

func (ClusterName) String

func (c ClusterName) String() string

String returns the given ClusterName type as a string

type K8sServiceAccount

type K8sServiceAccount struct {
	Namespace string
	Name      string
}

K8sServiceAccount is a type for a namespaced service account

func (K8sServiceAccount) IsEmpty

func (sa K8sServiceAccount) IsEmpty() bool

IsEmpty returns true if the given service account object is empty

func (K8sServiceAccount) String

func (sa K8sServiceAccount) String() string

String returns the string representation of the service account object

type MeshService

type MeshService struct {
	// If the service resides on a Kubernetes service, this would be the Kubernetes namespace.
	Namespace string

	// The name of the service
	Name string
}

MeshService is the struct defining a service (Kubernetes or otherwise) within a service mesh.

func UnmarshalMeshService

func UnmarshalMeshService(str string) (*MeshService, error)

UnmarshalMeshService unmarshals a NamespaceService type from a string

func (MeshService) Equals

func (ms MeshService) Equals(service MeshService) bool

Equals checks if two namespaced services are equal

func (MeshService) ServerName

func (ms MeshService) ServerName() string

ServerName returns the Server Name Identifier (SNI) for TLS connections

func (MeshService) String

func (ms MeshService) String() string

type WeightedCluster

type WeightedCluster struct {
	ClusterName ClusterName `json:"cluster_name:omitempty"`
	Weight      int         `json:"weight:omitempty"`
}

WeightedCluster is a struct of a cluster and is weight that is backing a service