operator

Documentation

Index

• Variables
• func NewServiceExportsObserver(cache *GlobalServiceExportCache, ...) store.Observer
• type ClusterMesh
• type ClusterMeshConfig
  • func (cfg ClusterMeshConfig) Flags(flags *pflag.FlagSet)
• type GlobalServiceExportCache
  • func NewGlobalServiceExportCache(metricTotalGlobalServiceExports metric.Gauge) *GlobalServiceExportCache
  • func (c *GlobalServiceExportCache) GetServiceExportByCluster(serviceExportNN types.NamespacedName) ServiceExportsByCluster
  • func (c *GlobalServiceExportCache) GetServiceExportsName(namespace string) []string
  • func (c *GlobalServiceExportCache) OnDelete(svcExport *mcsapitypes.MCSAPIServiceSpec) bool
  • func (c *GlobalServiceExportCache) OnUpdate(svcExport *mcsapitypes.MCSAPIServiceSpec)
  • func (c *GlobalServiceExportCache) Size() uint64
• type MCSAPIConfig
  • func (cfg MCSAPIConfig) Flags(flags *pflag.FlagSet)
• type Metrics
  • func NewMetrics() Metrics
• type ServiceExportsByCluster
• type ServiceExportsByName
• type ServiceExportsByNamespace

Variables

var Cell = cell.Module(
	"clustermesh",
	"Cell providing clustermesh capabilities in the operator",
	cell.Config(ClusterMeshConfig{}),
	cell.Config(MCSAPIConfig{}),
	cell.Provide(
		newClusterMesh,
		newAPIClustersHandler,
	),

	cell.Config(common.DefaultConfig),
	cell.Config(wait.TimeoutConfigDefault),

	metrics.Metric(NewMetrics),
	metrics.Metric(common.MetricsProvider(subsystem)),
)

Cell is the cell for the Operator ClusterMesh

Functions

func NewServiceExportsObserver

func NewServiceExportsObserver(
	cache *GlobalServiceExportCache, onUpdate, onDelete func(*mcsapitypes.MCSAPIServiceSpec),
) store.Observer

NewServiceExportsObserver returns an observer implementing the logic to convert and filter export notifications, update the global service export cache and call the upstream handlers when appropriate.

Types

type ClusterMesh

type ClusterMesh interface {
	// RegisterClusterAddHook register a hook when a cluster is added to the mesh.
	// This should NOT be called after the Start hook.
	RegisterClusterAddHook(clusterAddHook func(string))
	// RegisterClusterDeleteHook register a hook when a cluster is removed from the mesh.
	// This should NOT be called after the Start hook.
	RegisterClusterDeleteHook(clusterDeleteHook func(string))
	// RegisterClusterServiceUpdateHook register a hook when a service in the mesh is updated.
	// This should NOT be called after the Start hook.
	RegisterClusterServiceUpdateHook(clusterServiceUpdateHook func(*serviceStore.ClusterService))
	// RegisterClusterServiceDeleteHook register a hook when a service in the mesh is deleted.
	// This should NOT be called after the Start hook.
	RegisterClusterServiceDeleteHook(clusterServiceDeleteHook func(*serviceStore.ClusterService))
	// RegisterClusterServiceExportUpdateHook register a hook when a service export in the mesh is updated.
	// This should NOT be called after the Start hook.
	RegisterClusterServiceExportUpdateHook(clusterServiceExportUpdateHook func(*mcsapitypes.MCSAPIServiceSpec))
	// RegisterClusterServiceExportDeleteHook register a hook when a service export in the mesh is deleted.
	// This should NOT be called after the Start hook.
	RegisterClusterServiceExportDeleteHook(clusterServiceExportDeleteHook func(*mcsapitypes.MCSAPIServiceSpec))

	ServicesSynced(ctx context.Context) error
	GlobalServices() *common.GlobalServiceCache

	ServiceExportsSynced(ctx context.Context) error
	GlobalServiceExports() *GlobalServiceExportCache
}

ClusterMesh is the interface corresponding to the clusterMesh struct to expose its public methods to other Cilium packages.

type ClusterMeshConfig

type ClusterMeshConfig struct {
	// ClusterMeshEnableEndpointSync enables the EndpointSlice Cluster Mesh synchronization
	ClusterMeshEnableEndpointSync bool `mapstructure:"clustermesh-enable-endpoint-sync"`
}

ClusterMeshConfig contains the configuration for ClusterMesh inside the operator.

func (ClusterMeshConfig) Flags

func (cfg ClusterMeshConfig) Flags(flags *pflag.FlagSet)

Flags adds the flags used by ClientConfig.

type GlobalServiceExportCache

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

func NewGlobalServiceExportCache

func NewGlobalServiceExportCache(metricTotalGlobalServiceExports metric.Gauge) *GlobalServiceExportCache

func (*GlobalServiceExportCache) GetServiceExportByCluster

func (c *GlobalServiceExportCache) GetServiceExportByCluster(serviceExportNN types.NamespacedName) ServiceExportsByCluster

GetServiceExportByCluster returns a shallow copy of the GlobalServiceExport object, thus the MCSAPIServiceSpec objects should not be mutated.

func (*GlobalServiceExportCache) GetServiceExportsName

func (c *GlobalServiceExportCache) GetServiceExportsName(namespace string) []string

GetServiceExportsName returns all the service exports for a specific namespace that have at least one service export in one of the remote cluster in the mesh.

func (*GlobalServiceExportCache) OnDelete

func (c *GlobalServiceExportCache) OnDelete(svcExport *mcsapitypes.MCSAPIServiceSpec) bool

func (*GlobalServiceExportCache) OnUpdate

func (c *GlobalServiceExportCache) OnUpdate(svcExport *mcsapitypes.MCSAPIServiceSpec)

func (*GlobalServiceExportCache) Size

func (c *GlobalServiceExportCache) Size() uint64

type MCSAPIConfig

type MCSAPIConfig struct {
	// ClusterMeshEnableMCSAPI enables the MCS API support
	ClusterMeshEnableMCSAPI bool `mapstructure:"clustermesh-enable-mcs-api"`
}

MCSAPIConfig contains the configuration for MCS-API

func (MCSAPIConfig) Flags

func (cfg MCSAPIConfig) Flags(flags *pflag.FlagSet)

Flags adds the flags used by ClientConfig.

type Metrics

type Metrics struct {
	// TotalGlobalServices tracks the total number of global services.
	TotalGlobalServices metric.Vec[metric.Gauge]
	// TotalGlobalServiceExports tracks the total number of global service exports.
	TotalGlobalServiceExports metric.Vec[metric.Gauge]
}

func NewMetrics

func NewMetrics() Metrics

type ServiceExportsByCluster

type ServiceExportsByCluster map[string]*mcsapitypes.MCSAPIServiceSpec

type ServiceExportsByName

type ServiceExportsByName map[string]ServiceExportsByCluster

type ServiceExportsByNamespace

type ServiceExportsByNamespace map[string]ServiceExportsByName