types

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 5 Imported by: 10

Documentation

Index

Constants

View Source 
const (
	// ClusterAll is the default argument to specify on a context when you want to list or filter resources across all
	// managed clusters.
	ClusterAll = ""

	// SourceAll is the default argument to specify on a context when you want to list or filter resources across all
	// sources.
	SourceAll = ""
)
View Source 
const (
	// ExtensionResourceID is the cloud event extension key of the resource ID.
	ExtensionResourceID = "resourceid"

	// ExtensionResourceVersion is the cloud event extension key of the resource version.
	ExtensionResourceVersion = "resourceversion"

	// ExtensionStatusUpdateSequenceID is the cloud event extension key of the status update event sequence ID.
	// The status update event sequence id represents the order in which status update events occur on a single agent.
	ExtensionStatusUpdateSequenceID = "sequenceid"

	// ExtensionDeletionTimestamp is the cloud event extension key of the deletion timestamp.
	ExtensionDeletionTimestamp = "deletiontimestamp"

	// ExtensionClusterName is the cloud event extension key of the cluster name.
	ExtensionClusterName = "clustername"

	// ExtensionOriginalSource is the cloud event extension key of the original source.
	ExtensionOriginalSource = "originalsource"
)
View Source 
const (
	EventsTopicPattern          = `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/([a-z]+)/([a-z0-9-]+|\+)/(sourceevents|agentevents)$`
	SourceEventsTopicPattern    = `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/([a-z]+)/([a-z0-9-]+|\+)/sourceevents$`
	AgentEventsTopicPattern     = `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/([a-z]+)/([a-z0-9-]+|\+)/agentevents$`
	SourceBroadcastTopicPattern = `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/sourcebroadcast$`
	AgentBroadcastTopicPattern  = `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/agentbroadcast$`
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudEventsDataType 

type CloudEventsDataType struct {
	Group    string
	Version  string
	Resource string
}

CloudEventsDataType uniquely identifies the type of cloud event data.

func ParseCloudEventsDataType 

func ParseCloudEventsDataType(cloudEventsDataType string) (*CloudEventsDataType, error)

ParseCloudEventsDataType parse the cloud event data type to a struct object. The type format is `<reverse-group-of-resource>.<resource-version>.<resource-name>`.

func (CloudEventsDataType) String 

func (t CloudEventsDataType) String() string

type CloudEventsType 

type CloudEventsType struct {
	// CloudEventsDataType uniquely identifies the type of cloud event data.
	CloudEventsDataType

	// SubResource represents the cloud event data is from the resource spec or status.
	SubResource EventSubResource

	// Action represents the expected action for this cloud event.
	Action EventAction
}

CloudEventsType represents the type of cloud events, which describes the type of cloud event data.

func ParseCloudEventsType 

func ParseCloudEventsType(cloudEventsType string) (*CloudEventsType, error)

ParseCloudEventsType parse the cloud event type to a struct object. The type format is `<reverse-group-of-resource>.<resource-version>.<resource-name>.<subresource>.<action>`. The `<subresource>` must be one of "spec" and "status".

func (CloudEventsType) String 

func (t CloudEventsType) String() string

type EventAction 

type EventAction string

EventAction describes the expected action of a cloud event. 

const (
	// ResyncRequestAction represents the cloud event is for the resync request.
	ResyncRequestAction EventAction = "resync_request"

	// ResyncRequestAction represents the cloud event is for the resync response.
	ResyncResponseAction EventAction = "resync_response"
)

type EventBuilder 

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

func NewEventBuilder 

func NewEventBuilder(source string, eventType CloudEventsType) *EventBuilder

func (*EventBuilder) NewEvent 

func (b *EventBuilder) NewEvent() cloudevents.Event

func (*EventBuilder) WithClusterName 

func (b *EventBuilder) WithClusterName(clusterName string) *EventBuilder

func (*EventBuilder) WithDeletionTimestamp 

func (b *EventBuilder) WithDeletionTimestamp(timestamp time.Time) *EventBuilder

func (*EventBuilder) WithOriginalSource 

func (b *EventBuilder) WithOriginalSource(originalSource string) *EventBuilder

func (*EventBuilder) WithResourceID 

func (b *EventBuilder) WithResourceID(resourceID string) *EventBuilder

func (*EventBuilder) WithResourceVersion 

func (b *EventBuilder) WithResourceVersion(resourceVersion int64) *EventBuilder

func (*EventBuilder) WithStatusUpdateSequenceID 

func (b *EventBuilder) WithStatusUpdateSequenceID(sequenceID string) *EventBuilder

type EventSubResource 

type EventSubResource string

EventSubResource describes the subresource of a cloud event. Only `spec` and `status` are supported. 

const (
	// SubResourceSpec represents the cloud event data is from the resource spec.
	SubResourceSpec EventSubResource = "spec"

	// SubResourceSpec represents the cloud event data is from the resource status.
	SubResourceStatus EventSubResource = "status"
)

type ListOptions 

type ListOptions struct {
	// Source use the cluster name to restrict the list of returned objects by their cluster name.
	// Defaults to all clusters.
	ClusterName string

	// Agent use the source ID to restrict the list of returned objects by their source ID.
	// Defaults to all sources.
	Source string
}

ListOptions is the query options for listing the resource objects from the source/agent.

type ResourceAction 

type ResourceAction string

ResourceAction represents an action on a resource object on the source or agent. 

const (
	// Added represents a resource is added on the source part.
	Added ResourceAction = "ADDED"

	// Modified represents a resource is modified on the source part.
	Modified ResourceAction = "MODIFIED"

	// StatusModified represents the status of a resource is modified on the agent part.
	StatusModified ResourceAction = "STATUSMODIFIED"

	// Deleted represents a resource is deleted from the source prat.
	Deleted ResourceAction = "DELETED"
)

type Topics 

type Topics struct {
	// SourceEvents topic is a topic for sources to publish their resource create/update/delete events or status resync events
	//   - A source uses this topic to publish its resource create/update/delete request or status resync request with
	//     its sourceID to a specified agent
	//   - An agent subscribes to this topic with its cluster name to response sources resource create/update/delete
	//     request or status resync request
	// The topic format is `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/([a-z]+)/([a-z0-9-]+|\+)/sourceevents$`, e.g.
	// sources/+/clusters/+/sourceevents, sources/source1/clusters/+/sourceevents, sources/source1/clusters/cluster1/sourceevents
	// or $share/source-group/sources/+/clusters/+/sourceevents
	SourceEvents string `json:"sourceEvents" yaml:"sourceEvents"`

	// AgentEvents topic is a topic for agents to publish their resource status update events or spec resync events
	//   - An agent using this topic to publish the resource status update request or spec resync request with its
	//     cluster name to a specified source.
	//   - A source subscribe to this topic with its sourceID to response agents resource status update request or spec
	//     resync request
	// The topic format is `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/([a-z]+)/([a-z0-9-]+|\+)/agentevents$`, e.g.
	// sources/+/clusters/+/agentevents, sources/source1/clusters/+/agentevents, sources/source1/clusters/cluster1/agentevents
	// or $share/agent-group/+/clusters/+/agentevents
	AgentEvents string `json:"agentEvents" yaml:"agentEvents"`

	// SourceBroadcast is an optional topic, it is for a source to publish its events to all agents, currently, we use
	// this topic to resync resource status from all agents for a source that does not known the exact agents, e.g.
	//   - A source uses this topic to publish its resource status resync request with its sourceID to all the agents
	//   - Each agent subscribes to this topic to response sources resource status resync request
	// The topic format is `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/sourcebroadcast$`, e.g.
	// sources/+/sourcebroadcast, sources/source1/sourcebroadcast or $share/source-group/sources/+/sourcebroadcast
	SourceBroadcast string `json:"sourceBroadcast,omitempty" yaml:"sourceBroadcast,omitempty"`

	// AgentBroadcast is an optional topic, it is for a agent to publish its events to all sources, currently, we use
	// this topic to resync resources from all sources for an agent that does not known the exact sources, e.g.
	//   - An agent using this topic to publish the spec resync request with its cluster name to all the sources.
	//   - Each source subscribe to this topic to response agents spec resync request
	// The topic format is `^(\$share/[a-z0-9-]+/)?([a-z]+)/([a-z0-9-]+|\+)/agentbroadcast$`, e.g.
	// clusters/+/agentbroadcast, clusters/cluster1/agentbroadcast or $share/agent-group/clusters/+/agentbroadcast
	AgentBroadcast string `json:"agentBroadcast,omitempty" yaml:"agentBroadcast,omitempty"`
}

Topics represents required messaging system topics for a source or agent.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.