announcements

Documentation

Overview

Package announcements provides the types and constants required to contextualize events received from the Kubernetes API server that are propagated internally within the control plane to trigger configuration changes.

Index

• type Announcement
• type AnnouncementType
  • func (at AnnouncementType) String() string

Types

type Announcement

type Announcement struct {
	Type               AnnouncementType
	ReferencedObjectID interface{}
}

Announcement is a struct for messages between various components of OSM signaling a need for a change in Envoy proxy configuration

type AnnouncementType

type AnnouncementType string

AnnouncementType is used to record the type of announcement

const (
	// ScheduleProxyBroadcast is used by other modules to request the dispatcher to schedule a global proxy broadcast
	ScheduleProxyBroadcast AnnouncementType = "schedule-proxy-broadcast"

	// TickerStart starts Ticker to trigger time-based proxy updates
	TickerStart AnnouncementType = "ticker-start"

	// TickerStop stops Ticker to stop time-based proxy updates
	TickerStop AnnouncementType = "ticker-stop"

	// ProxyBroadcast is used to notify all Proxy streams that they need to trigger an update
	ProxyBroadcast AnnouncementType = "proxy-broadcast"

	// PodAdded is the type of announcement emitted when we observe an addition of a Kubernetes Pod
	PodAdded AnnouncementType = "pod-added"

	// PodDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Pod
	PodDeleted AnnouncementType = "pod-deleted"

	// PodUpdated is the type of announcement emitted when we observe an update to a Kubernetes Pod
	PodUpdated AnnouncementType = "pod-updated"

	// EndpointAdded is the type of announcement emitted when we observe an addition of a Kubernetes Endpoint
	EndpointAdded AnnouncementType = "endpoint-added"

	// EndpointDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Endpoint
	EndpointDeleted AnnouncementType = "endpoint-deleted"

	// EndpointUpdated is the type of announcement emitted when we observe an update to a Kubernetes Endpoint
	EndpointUpdated AnnouncementType = "endpoint-updated"

	// NamespaceAdded is the type of announcement emitted when we observe an addition of a Kubernetes Namespace
	NamespaceAdded AnnouncementType = "namespace-added"

	// NamespaceDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Namespace
	NamespaceDeleted AnnouncementType = "namespace-deleted"

	// NamespaceUpdated is the type of announcement emitted when we observe an update to a Kubernetes Namespace
	NamespaceUpdated AnnouncementType = "namespace-updated"

	// ServiceAdded is the type of announcement emitted when we observe an addition of a Kubernetes Service
	ServiceAdded AnnouncementType = "service-added"

	// ServiceDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Service
	ServiceDeleted AnnouncementType = "service-deleted"

	// ServiceUpdated is the type of announcement emitted when we observe an update to a Kubernetes Service
	ServiceUpdated AnnouncementType = "service-updated"

	// ServiceAccountAdded is the type of announcement emitted when we observe an addition of a Kubernetes Service Account
	ServiceAccountAdded AnnouncementType = "serviceaccount-added"

	// ServiceAccountDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Service Account
	ServiceAccountDeleted AnnouncementType = "serviceaccount-deleted"

	// ServiceAccountUpdated is the type of announcement emitted when we observe an update to a Kubernetes Service
	ServiceAccountUpdated AnnouncementType = "serviceaccount-updated"

	// TrafficSplitAdded is the type of announcement emitted when we observe an addition of a Kubernetes TrafficSplit
	TrafficSplitAdded AnnouncementType = "trafficsplit-added"

	// TrafficSplitDeleted the type of announcement emitted when we observe the deletion of a Kubernetes TrafficSplit
	TrafficSplitDeleted AnnouncementType = "trafficsplit-deleted"

	// TrafficSplitUpdated is the type of announcement emitted when we observe an update to a Kubernetes TrafficSplit
	TrafficSplitUpdated AnnouncementType = "trafficsplit-updated"

	// RouteGroupAdded is the type of announcement emitted when we observe an addition of a Kubernetes RouteGroup
	RouteGroupAdded AnnouncementType = "routegroup-added"

	// RouteGroupDeleted the type of announcement emitted when we observe the deletion of a Kubernetes RouteGroup
	RouteGroupDeleted AnnouncementType = "routegroup-deleted"

	// RouteGroupUpdated is the type of announcement emitted when we observe an update to a Kubernetes RouteGroup
	RouteGroupUpdated AnnouncementType = "routegroup-updated"

	// TCPRouteAdded is the type of announcement emitted when we observe an addition of a Kubernetes TCPRoute
	TCPRouteAdded AnnouncementType = "tcproute-added"

	// TCPRouteDeleted the type of announcement emitted when we observe the deletion of a Kubernetes TCPRoute
	TCPRouteDeleted AnnouncementType = "tcproute-deleted"

	// TCPRouteUpdated is the type of announcement emitted when we observe an update to a Kubernetes TCPRoute
	TCPRouteUpdated AnnouncementType = "tcproute-updated"

	// TrafficTargetAdded is the type of announcement emitted when we observe an addition of a Kubernetes TrafficTarget
	TrafficTargetAdded AnnouncementType = "traffictarget-added"

	// TrafficTargetDeleted the type of announcement emitted when we observe the deletion of a Kubernetes TrafficTarget
	TrafficTargetDeleted AnnouncementType = "traffictarget-deleted"

	// TrafficTargetUpdated is the type of announcement emitted when we observe an update to a Kubernetes TrafficTarget
	TrafficTargetUpdated AnnouncementType = "traffictarget-updated"

	// ConfigMapAdded is the type of announcement emitted when we observe an addition of a Kubernetes ConfigMap
	ConfigMapAdded AnnouncementType = "configmap-added"

	// ConfigMapDeleted the type of announcement emitted when we observe the deletion of a Kubernetes ConfigMap
	ConfigMapDeleted AnnouncementType = "configmap-deleted"

	// ConfigMapUpdated is the type of announcement emitted when we observe an update to a Kubernetes ConfigMap
	ConfigMapUpdated AnnouncementType = "configmap-updated"

	// IngressAdded is the type of announcement emitted when we observe an addition of a Kubernetes Ingress
	IngressAdded AnnouncementType = "ingress-added"

	// IngressDeleted the type of announcement emitted when we observe the deletion of a Kubernetes Ingress
	IngressDeleted AnnouncementType = "ingress-deleted"

	// IngressUpdated is the type of announcement emitted when we observe an update to a Kubernetes Ingress
	IngressUpdated AnnouncementType = "ingress-updated"

	// CertificateRotated is the type of announcement emitted when a certificate is rotated by the certificate provider
	CertificateRotated AnnouncementType = "certificate-rotated"
)

func (AnnouncementType) String

func (at AnnouncementType) String() string