Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=argoproj.io +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true
Index ¶
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type EventSourceRef
- type Gateway
- type GatewayList
- type GatewayResource
- type GatewaySpec
- type GatewayStatus
- type NATSSubscriber
- type NodePhase
- type NodeStatus
- type Subscribers
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeBuilder is the builder for this scheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme adds this AddToScheme = SchemeBuilder.AddToScheme )
var SchemaGroupVersionKind = schema.GroupVersionKind{Group: gateway.Group, Version: "v1alpha1", Kind: gateway.Kind}
SchemaGroupVersionKind is a group version kind used to attach owner references to gateway-controller
var SchemeGroupVersion = schema.GroupVersion{Group: gateway.Group, Version: "v1alpha1"}
SchemeGroupVersion is a group version used to register these objects
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes unqualified resource and returns Group qualified GroupResource
Types ¶
type EventSourceRef ¶ added in v0.13.0
type EventSourceRef struct { // Name of the event source Name string `json:"name" protobuf:"bytes,1,name=name"` // Namespace of the event source // Default value is the namespace where referencing gateway is deployed // +optional Namespace string `json:"namespace,omitempty" protobuf:"bytes,2,opt,name=namespace"` }
EventSourceRef holds information about the EventSourceRef custom resource
func (*EventSourceRef) DeepCopy ¶ added in v0.13.0
func (in *EventSourceRef) DeepCopy() *EventSourceRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventSourceRef.
func (*EventSourceRef) DeepCopyInto ¶ added in v0.13.0
func (in *EventSourceRef) DeepCopyInto(out *EventSourceRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Gateway ¶
type Gateway struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` Status GatewayStatus `json:"status" protobuf:"bytes,2,opt,name=status"` Spec GatewaySpec `json:"spec" protobuf:"bytes,3,opt,name=spec"` }
Gateway is the definition of a gateway resource +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true
func (*Gateway) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Gateway.
func (*Gateway) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Gateway) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewayList ¶
type GatewayList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` // +listType=items Items []Gateway `json:"items" protobuf:"bytes,2,opt,name=items"` }
GatewayList is the list of Gateway resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*GatewayList) DeepCopy ¶
func (in *GatewayList) DeepCopy() *GatewayList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayList.
func (*GatewayList) DeepCopyInto ¶
func (in *GatewayList) DeepCopyInto(out *GatewayList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GatewayList) DeepCopyObject ¶
func (in *GatewayList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewayResource ¶ added in v0.13.0
type GatewayResource struct { // Metadata of the deployment for the gateway Deployment *metav1.ObjectMeta `json:"deployment" protobuf:"bytes,1,name=deployment"` // Metadata of the service for the gateway // +optional Service *metav1.ObjectMeta `json:"service,omitempty" protobuf:"bytes,2,opt,name=service"` }
GatewayResource holds the metadata about the gateway resources
func (*GatewayResource) DeepCopy ¶ added in v0.13.0
func (in *GatewayResource) DeepCopy() *GatewayResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayResource.
func (*GatewayResource) DeepCopyInto ¶ added in v0.13.0
func (in *GatewayResource) DeepCopyInto(out *GatewayResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewaySpec ¶
type GatewaySpec struct { // Template is the pod specification for the gateway // Refer https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core Template *corev1.PodTemplateSpec `json:"template" protobuf:"bytes,1,opt,name=template"` // EventSourceRef refers to event-source that stores event source configurations for the gateway EventSourceRef *EventSourceRef `json:"eventSourceRef,omitempty" protobuf:"bytes,2,opt,name=eventSourceRef"` // Type is the type of gateway. Used as metadata. Type apicommon.EventSourceType `json:"type" protobuf:"bytes,3,opt,name=type"` // Service is the specifications of the service to expose the gateway // Refer https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#service-v1-core Service *corev1.Service `json:"service,omitempty" protobuf:"bytes,4,opt,name=service"` // Subscribers holds the contexts of the subscribers/sinks to send events to. // +listType=subscribers // +optional Subscribers *Subscribers `json:"subscribers,omitempty" protobuf:"bytes,5,opt,name=subscribers"` // Port on which the gateway event source processor is running on. ProcessorPort string `json:"processorPort" protobuf:"bytes,6,opt,name=processorPort"` // Replica is the gateway deployment replicas Replica int `json:"replica,omitempty" protobuf:"bytes,9,opt,name=replica"` }
GatewaySpec represents gateway specifications
func (*GatewaySpec) DeepCopy ¶
func (in *GatewaySpec) DeepCopy() *GatewaySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewaySpec.
func (*GatewaySpec) DeepCopyInto ¶
func (in *GatewaySpec) DeepCopyInto(out *GatewaySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayStatus ¶
type GatewayStatus struct { // Phase is the high-level summary of the gateway Phase NodePhase `json:"phase" protobuf:"bytes,1,opt,name=phase"` // StartedAt is the time at which this gateway was initiated StartedAt metav1.Time `json:"startedAt,omitempty" protobuf:"bytes,2,opt,name=startedAt"` // Message is a human readable string indicating details about a gateway in its phase Message string `json:"message,omitempty" protobuf:"bytes,4,opt,name=message"` // Nodes is a mapping between a node ID and the node's status // it records the states for the configurations of gateway. Nodes map[string]NodeStatus `json:"nodes,omitempty" protobuf:"bytes,5,rep,name=nodes"` // Resources refers to the metadata about the gateway resources Resources *GatewayResource `json:"resources" protobuf:"bytes,6,opt,name=resources"` }
GatewayStatus contains information about the status of a gateway.
func (*GatewayStatus) DeepCopy ¶
func (in *GatewayStatus) DeepCopy() *GatewayStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayStatus.
func (*GatewayStatus) DeepCopyInto ¶
func (in *GatewayStatus) DeepCopyInto(out *GatewayStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NATSSubscriber ¶ added in v0.13.0
type NATSSubscriber struct { // ServerURL refers to the NATS server URL. ServerURL string `json:"serverURL" protobuf:"bytes,1,name=serverURL"` // Subject refers to the NATS subject name. Subject string `json:"subject" protobuf:"bytes,2,name=subject"` // Name of the subscription. Must be unique. Name string `json:"name" protobuf:"bytes,3,name=name"` }
NATSSubscriber holds the context of subscriber over NATS.
func (*NATSSubscriber) DeepCopy ¶ added in v0.13.0
func (in *NATSSubscriber) DeepCopy() *NATSSubscriber
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NATSSubscriber.
func (*NATSSubscriber) DeepCopyInto ¶ added in v0.13.0
func (in *NATSSubscriber) DeepCopyInto(out *NATSSubscriber)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodePhase ¶
type NodePhase string
NodePhase is the label for the condition of a node.
const ( NodePhaseRunning NodePhase = "Running" // the node is running NodePhaseError NodePhase = "Error" // the node has encountered an error in processing NodePhaseNew NodePhase = "" // the node is new NodePhaseCompleted NodePhase = "Completed" // node has completed running NodePhaseRemove NodePhase = "Remove" // stale node )
possible types of node phases
type NodeStatus ¶
type NodeStatus struct { // ID is a unique identifier of a node within a sensor // It is a hash of the node name ID string `json:"id" protobuf:"bytes,1,opt,name=id"` // Name is a unique name in the node tree used to generate the node ID Name string `json:"name" protobuf:"bytes,3,opt,name=name"` // DisplayName is the human readable representation of the node DisplayName string `json:"displayName" protobuf:"bytes,5,opt,name=displayName"` // Phase of the node Phase NodePhase `json:"phase" protobuf:"bytes,6,opt,name=phase"` // StartedAt is the time at which this node started // +k8s:openapi-gen=false StartedAt metav1.MicroTime `json:"startedAt,omitempty" protobuf:"bytes,7,opt,name=startedAt"` // Message store data or something to save for configuration Message string `json:"message,omitempty" protobuf:"bytes,8,opt,name=message"` // UpdateTime is the time when node(gateway configuration) was updated UpdateTime metav1.MicroTime `json:"updateTime,omitempty" protobuf:"bytes,9,opt,name=updateTime"` }
NodeStatus describes the status for an individual node in the gateway configurations. A single node can represent one configuration.
func (*NodeStatus) DeepCopy ¶
func (in *NodeStatus) DeepCopy() *NodeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeStatus.
func (*NodeStatus) DeepCopyInto ¶
func (in *NodeStatus) DeepCopyInto(out *NodeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Subscribers ¶ added in v0.13.0
type Subscribers struct { // HTTP subscribers are HTTP endpoints to send events to. // +listType=string // +optional HTTP []string `json:"http,omitempty" protobuf:"bytes,1,opt,name=http"` // NATS refers to the subscribers over NATS protocol. // +listType=NATSSubscriber // +optional NATS []NATSSubscriber `json:"nats,omitempty" protobuf:"bytes,2,opt,name=nats"` }
func (*Subscribers) DeepCopy ¶ added in v0.13.0
func (in *Subscribers) DeepCopy() *Subscribers
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Subscribers.
func (*Subscribers) DeepCopyInto ¶ added in v0.13.0
func (in *Subscribers) DeepCopyInto(out *Subscribers)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.