v1alpha1

package
v0.8.1 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2019 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Copyright 2018 BlackRock, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	// SchemeBuilder is the builder for this scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme adds this
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
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

View Source 
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 Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes unqualified resource and returns Group qualified GroupResource

Types

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 

func (in *Gateway) DeepCopy() *Gateway

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Gateway.

func (*Gateway) DeepCopyInto 

func (in *Gateway) DeepCopyInto(out *Gateway)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Gateway) DeepCopyObject 

func (in *Gateway) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Gateway) Descriptor 

func (*Gateway) Descriptor() ([]byte, []int)

func (*Gateway) Marshal 

func (m *Gateway) Marshal() (dAtA []byte, err error)

func (*Gateway) MarshalTo 

func (m *Gateway) MarshalTo(dAtA []byte) (int, error)

func (*Gateway) ProtoMessage 

func (*Gateway) ProtoMessage()

func (*Gateway) Reset 

func (m *Gateway) Reset()

func (*Gateway) Size 

func (m *Gateway) Size() (n int)

func (*Gateway) String 

func (this *Gateway) String() string

func (*Gateway) Unmarshal 

func (m *Gateway) Unmarshal(dAtA []byte) error

func (*Gateway) XXX_DiscardUnknown 

func (m *Gateway) XXX_DiscardUnknown()

func (*Gateway) XXX_Marshal 

func (m *Gateway) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Gateway) XXX_Merge 

func (dst *Gateway) XXX_Merge(src proto.Message)

func (*Gateway) XXX_Size 

func (m *Gateway) XXX_Size() int

func (*Gateway) XXX_Unmarshal 

func (m *Gateway) XXX_Unmarshal(b []byte) error

type GatewayList 

type GatewayList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"`
	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.

func (*GatewayList) Descriptor 

func (*GatewayList) Descriptor() ([]byte, []int)

func (*GatewayList) Marshal 

func (m *GatewayList) Marshal() (dAtA []byte, err error)

func (*GatewayList) MarshalTo 

func (m *GatewayList) MarshalTo(dAtA []byte) (int, error)

func (*GatewayList) ProtoMessage 

func (*GatewayList) ProtoMessage()

func (*GatewayList) Reset 

func (m *GatewayList) Reset()

func (*GatewayList) Size 

func (m *GatewayList) Size() (n int)

func (*GatewayList) String 

func (this *GatewayList) String() string

func (*GatewayList) Unmarshal 

func (m *GatewayList) Unmarshal(dAtA []byte) error

func (*GatewayList) XXX_DiscardUnknown 

func (m *GatewayList) XXX_DiscardUnknown()

func (*GatewayList) XXX_Marshal 

func (m *GatewayList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewayList) XXX_Merge 

func (dst *GatewayList) XXX_Merge(src proto.Message)

func (*GatewayList) XXX_Size 

func (m *GatewayList) XXX_Size() int

func (*GatewayList) XXX_Unmarshal 

func (m *GatewayList) XXX_Unmarshal(b []byte) error

type GatewayNotificationWatcher 

type GatewayNotificationWatcher struct {
	// Name is the gateway name
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`

	// Port is http server port on which gateway is running
	Port string `json:"port" protobuf:"bytes,2,opt,name=port"`

	// Endpoint is REST API endpoint to post event to.
	// Events are sent using HTTP POST method to this endpoint.
	Endpoint string `json:"endpoint" protobuf:"bytes,3,opt,name=endpoint"`
}

GatewayNotificationWatcher is the gateway interested in listening to notifications from this gateway

func (*GatewayNotificationWatcher) DeepCopy 

func (in *GatewayNotificationWatcher) DeepCopy() *GatewayNotificationWatcher

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayNotificationWatcher.

func (*GatewayNotificationWatcher) DeepCopyInto 

func (in *GatewayNotificationWatcher) DeepCopyInto(out *GatewayNotificationWatcher)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GatewayNotificationWatcher) Descriptor 

func (*GatewayNotificationWatcher) Descriptor() ([]byte, []int)

func (*GatewayNotificationWatcher) Marshal 

func (m *GatewayNotificationWatcher) Marshal() (dAtA []byte, err error)

func (*GatewayNotificationWatcher) MarshalTo 

func (m *GatewayNotificationWatcher) MarshalTo(dAtA []byte) (int, error)

func (*GatewayNotificationWatcher) ProtoMessage 

func (*GatewayNotificationWatcher) ProtoMessage()

func (*GatewayNotificationWatcher) Reset 

func (m *GatewayNotificationWatcher) Reset()

func (*GatewayNotificationWatcher) Size 

func (m *GatewayNotificationWatcher) Size() (n int)

func (*GatewayNotificationWatcher) String 

func (this *GatewayNotificationWatcher) String() string

func (*GatewayNotificationWatcher) Unmarshal 

func (m *GatewayNotificationWatcher) Unmarshal(dAtA []byte) error

func (*GatewayNotificationWatcher) XXX_DiscardUnknown 

func (m *GatewayNotificationWatcher) XXX_DiscardUnknown()

func (*GatewayNotificationWatcher) XXX_Marshal 

func (m *GatewayNotificationWatcher) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewayNotificationWatcher) XXX_Merge 

func (dst *GatewayNotificationWatcher) XXX_Merge(src proto.Message)

func (*GatewayNotificationWatcher) XXX_Size 

func (m *GatewayNotificationWatcher) XXX_Size() int

func (*GatewayNotificationWatcher) XXX_Unmarshal 

func (m *GatewayNotificationWatcher) XXX_Unmarshal(b []byte) error

type GatewaySpec 

type GatewaySpec struct {
	// DeploySpec is the pod specification for the gateway
	// Refer https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core
	DeploySpec *corev1.Pod `json:"deploySpec" protobuf:"bytes,1,opt,name=deploySpec"`

	// ConfigMap is name of the configmap for gateway. This configmap contains event sources.
	ConfigMap string `json:"configMap,omitempty" protobuf:"bytes,2,opt,name=configmap"`

	// Type is the type of gateway. Used as metadata.
	Type string `json:"type" protobuf:"bytes,3,opt,name=type"`

	// Version is used for marking event version
	EventVersion string `json:"eventVersion" protobuf:"bytes,4,opt,name=eventVersion"`

	// ServiceSpec is the specifications of the service to expose the gateway
	// Refer https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#service-v1-core
	ServiceSpec *corev1.Service `json:"serviceSpec,omitempty" protobuf:"bytes,5,opt,name=serviceSpec"`

	// Watchers are components which are interested listening to notifications from this gateway
	// These only need to be specified when gateway dispatch mechanism is through HTTP POST notifications.
	// In future, support for NATS, KAFKA will be added as a means to dispatch notifications in which case
	// specifying watchers would be unnecessary.
	Watchers *NotificationWatchers `json:"watchers,omitempty" protobuf:"bytes,6,opt,name=watchers"`

	// Port on which the gateway event source processor is running on.
	ProcessorPort string `json:"processorPort" protobuf:"bytes,7,opt,name=processorPort"`

	// EventProtocol is the underlying protocol used to send events from gateway to watchers(components interested in listening to event from this gateway)
	EventProtocol *common.EventProtocol `json:"eventProtocol" protobuf:"bytes,8,opt,name=eventProtocol"`
}

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.

func (*GatewaySpec) Descriptor 

func (*GatewaySpec) Descriptor() ([]byte, []int)

func (*GatewaySpec) Marshal 

func (m *GatewaySpec) Marshal() (dAtA []byte, err error)

func (*GatewaySpec) MarshalTo 

func (m *GatewaySpec) MarshalTo(dAtA []byte) (int, error)

func (*GatewaySpec) ProtoMessage 

func (*GatewaySpec) ProtoMessage()

func (*GatewaySpec) Reset 

func (m *GatewaySpec) Reset()

func (*GatewaySpec) Size 

func (m *GatewaySpec) Size() (n int)

func (*GatewaySpec) String 

func (this *GatewaySpec) String() string

func (*GatewaySpec) Unmarshal 

func (m *GatewaySpec) Unmarshal(dAtA []byte) error

func (*GatewaySpec) XXX_DiscardUnknown 

func (m *GatewaySpec) XXX_DiscardUnknown()

func (*GatewaySpec) XXX_Marshal 

func (m *GatewaySpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewaySpec) XXX_Merge 

func (dst *GatewaySpec) XXX_Merge(src proto.Message)

func (*GatewaySpec) XXX_Size 

func (m *GatewaySpec) XXX_Size() int

func (*GatewaySpec) XXX_Unmarshal 

func (m *GatewaySpec) XXX_Unmarshal(b []byte) error

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"`
}

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.

func (*GatewayStatus) Descriptor 

func (*GatewayStatus) Descriptor() ([]byte, []int)

func (*GatewayStatus) Marshal 

func (m *GatewayStatus) Marshal() (dAtA []byte, err error)

func (*GatewayStatus) MarshalTo 

func (m *GatewayStatus) MarshalTo(dAtA []byte) (int, error)

func (*GatewayStatus) ProtoMessage 

func (*GatewayStatus) ProtoMessage()

func (*GatewayStatus) Reset 

func (m *GatewayStatus) Reset()

func (*GatewayStatus) Size 

func (m *GatewayStatus) Size() (n int)

func (*GatewayStatus) String 

func (this *GatewayStatus) String() string

func (*GatewayStatus) Unmarshal 

func (m *GatewayStatus) Unmarshal(dAtA []byte) error

func (*GatewayStatus) XXX_DiscardUnknown 

func (m *GatewayStatus) XXX_DiscardUnknown()

func (*GatewayStatus) XXX_Marshal 

func (m *GatewayStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewayStatus) XXX_Merge 

func (dst *GatewayStatus) XXX_Merge(src proto.Message)

func (*GatewayStatus) XXX_Size 

func (m *GatewayStatus) XXX_Size() int

func (*GatewayStatus) XXX_Unmarshal 

func (m *GatewayStatus) XXX_Unmarshal(b []byte) error

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
	NodePhaseResourceUpdate NodePhase = "ResourceUpdate" // resource is updated
)

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.

func (*NodeStatus) Descriptor 

func (*NodeStatus) Descriptor() ([]byte, []int)

func (*NodeStatus) Marshal 

func (m *NodeStatus) Marshal() (dAtA []byte, err error)

func (*NodeStatus) MarshalTo 

func (m *NodeStatus) MarshalTo(dAtA []byte) (int, error)

func (*NodeStatus) ProtoMessage 

func (*NodeStatus) ProtoMessage()

func (*NodeStatus) Reset 

func (m *NodeStatus) Reset()

func (*NodeStatus) Size 

func (m *NodeStatus) Size() (n int)

func (*NodeStatus) String 

func (this *NodeStatus) String() string

func (*NodeStatus) Unmarshal 

func (m *NodeStatus) Unmarshal(dAtA []byte) error

func (*NodeStatus) XXX_DiscardUnknown 

func (m *NodeStatus) XXX_DiscardUnknown()

func (*NodeStatus) XXX_Marshal 

func (m *NodeStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NodeStatus) XXX_Merge 

func (dst *NodeStatus) XXX_Merge(src proto.Message)

func (*NodeStatus) XXX_Size 

func (m *NodeStatus) XXX_Size() int

func (*NodeStatus) XXX_Unmarshal 

func (m *NodeStatus) XXX_Unmarshal(b []byte) error

type NotificationWatchers 

type NotificationWatchers struct {
	// Gateways is the list of gateways interested in listening to notifications from this gateway
	Gateways []GatewayNotificationWatcher `json:"gateways,omitempty" protobuf:"bytes,1,opt,name=gateways"`

	// Sensors is the list of sensors interested in listening to notifications from this gateway
	Sensors []SensorNotificationWatcher `json:"sensors,omitempty" protobuf:"bytes,2,rep,name=sensors"`
}

NotificationWatchers are components which are interested listening to notifications from this gateway

func (*NotificationWatchers) DeepCopy 

func (in *NotificationWatchers) DeepCopy() *NotificationWatchers

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NotificationWatchers.

func (*NotificationWatchers) DeepCopyInto 

func (in *NotificationWatchers) DeepCopyInto(out *NotificationWatchers)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NotificationWatchers) Descriptor 

func (*NotificationWatchers) Descriptor() ([]byte, []int)

func (*NotificationWatchers) Marshal 

func (m *NotificationWatchers) Marshal() (dAtA []byte, err error)

func (*NotificationWatchers) MarshalTo 

func (m *NotificationWatchers) MarshalTo(dAtA []byte) (int, error)

func (*NotificationWatchers) ProtoMessage 

func (*NotificationWatchers) ProtoMessage()

func (*NotificationWatchers) Reset 

func (m *NotificationWatchers) Reset()

func (*NotificationWatchers) Size 

func (m *NotificationWatchers) Size() (n int)

func (*NotificationWatchers) String 

func (this *NotificationWatchers) String() string

func (*NotificationWatchers) Unmarshal 

func (m *NotificationWatchers) Unmarshal(dAtA []byte) error

func (*NotificationWatchers) XXX_DiscardUnknown 

func (m *NotificationWatchers) XXX_DiscardUnknown()

func (*NotificationWatchers) XXX_Marshal 

func (m *NotificationWatchers) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NotificationWatchers) XXX_Merge 

func (dst *NotificationWatchers) XXX_Merge(src proto.Message)

func (*NotificationWatchers) XXX_Size 

func (m *NotificationWatchers) XXX_Size() int

func (*NotificationWatchers) XXX_Unmarshal 

func (m *NotificationWatchers) XXX_Unmarshal(b []byte) error

type SensorNotificationWatcher 

type SensorNotificationWatcher struct {
	// Name is name of the sensor
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
}

SensorNotificationWatcher is the sensor interested in listening to notifications from this gateway

func (*SensorNotificationWatcher) DeepCopy 

func (in *SensorNotificationWatcher) DeepCopy() *SensorNotificationWatcher

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SensorNotificationWatcher.

func (*SensorNotificationWatcher) DeepCopyInto 

func (in *SensorNotificationWatcher) DeepCopyInto(out *SensorNotificationWatcher)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SensorNotificationWatcher) Descriptor 

func (*SensorNotificationWatcher) Descriptor() ([]byte, []int)

func (*SensorNotificationWatcher) Marshal 

func (m *SensorNotificationWatcher) Marshal() (dAtA []byte, err error)

func (*SensorNotificationWatcher) MarshalTo 

func (m *SensorNotificationWatcher) MarshalTo(dAtA []byte) (int, error)

func (*SensorNotificationWatcher) ProtoMessage 

func (*SensorNotificationWatcher) ProtoMessage()

func (*SensorNotificationWatcher) Reset 

func (m *SensorNotificationWatcher) Reset()

func (*SensorNotificationWatcher) Size 

func (m *SensorNotificationWatcher) Size() (n int)

func (*SensorNotificationWatcher) String 

func (this *SensorNotificationWatcher) String() string

func (*SensorNotificationWatcher) Unmarshal 

func (m *SensorNotificationWatcher) Unmarshal(dAtA []byte) error

func (*SensorNotificationWatcher) XXX_DiscardUnknown 

func (m *SensorNotificationWatcher) XXX_DiscardUnknown()

func (*SensorNotificationWatcher) XXX_Marshal 

func (m *SensorNotificationWatcher) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SensorNotificationWatcher) XXX_Merge 

func (dst *SensorNotificationWatcher) XXX_Merge(src proto.Message)

func (*SensorNotificationWatcher) XXX_Size 

func (m *SensorNotificationWatcher) XXX_Size() int

func (*SensorNotificationWatcher) XXX_Unmarshal 

func (m *SensorNotificationWatcher) XXX_Unmarshal(b []byte) error

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.