Documentation
¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=argoproj.io +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=argoproj.io
Index ¶
- Constants
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func Resource(resource string) schema.GroupResource
- type AuthStrategy
- type BusConfig
- type EventBus
- type EventBusList
- type EventBusSpec
- type EventBusStatus
- func (in *EventBusStatus) DeepCopy() *EventBusStatus
- func (in *EventBusStatus) DeepCopyInto(out *EventBusStatus)
- func (s *EventBusStatus) InitConditions()
- func (s *EventBusStatus) MarkConfigured()
- func (s *EventBusStatus) MarkDeployFailed(reason, message string)
- func (s *EventBusStatus) MarkDeployed(reason, message string)
- func (s *EventBusStatus) MarkDeploying(reason, message string)
- func (s *EventBusStatus) MarkNotConfigured(reason, message string)
- type NATSBus
- type NATSConfig
- type NativeStrategy
- type PersistenceStrategy
Constants ¶
const ( // EventBusConditionDeployed has the status True when the EventBus // has its RestfulSet/Deployment ans service created. EventBusConditionDeployed common.ConditionType = "Deployed" // EventBusConditionConfigured has the status True when the EventBus // has its configuration ready. EventBusConditionConfigured common.ConditionType = "Configured" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: eventbus.Group, Version: "v1alpha1"} // SchemaGroupVersionKind is a group version kind used to attach owner references SchemaGroupVersionKind = schema.GroupVersionKind{Group: eventbus.Group, Version: "v1alpha1", Kind: eventbus.Kind} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is required by pkg/client/... AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AuthStrategy ¶
type AuthStrategy string
AuthStrategy is the auth strategy of native nats installaion
var ( AuthStrategyNone AuthStrategy = "none" AuthStrategyToken AuthStrategy = "token" )
possible auth strategies
type BusConfig ¶
type BusConfig struct {
NATS *NATSConfig `json:"nats,omitempty" protobuf:"bytes,1,opt,name=nats"`
}
BusConfig has the finalized configuration for EventBus
func (*BusConfig) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BusConfig.
func (*BusConfig) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EventBus ¶
type EventBus struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` Spec EventBusSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` Status EventBusStatus `json:"status" protobuf:"bytes,3,opt,name=status"` }
EventBus is the definition of a eventbus resource +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true
func (*EventBus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventBus.
func (*EventBus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventBus) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EventBusList ¶
type EventBusList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` // +listType=eventbus Items []EventBus `json:"items" protobuf:"bytes,2,opt,name=items"` }
EventBusList is the list of eventbus resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*EventBusList) DeepCopy ¶
func (in *EventBusList) DeepCopy() *EventBusList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventBusList.
func (*EventBusList) DeepCopyInto ¶
func (in *EventBusList) DeepCopyInto(out *EventBusList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventBusList) DeepCopyObject ¶
func (in *EventBusList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EventBusSpec ¶
type EventBusSpec struct { // NATS eventbus NATS *NATSBus `json:"nats,omitempty" protobuf:"bytes,1,opt,name=nats"` }
EventBusSpec refers to specification of eventbus resource
func (*EventBusSpec) DeepCopy ¶
func (in *EventBusSpec) DeepCopy() *EventBusSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventBusSpec.
func (*EventBusSpec) DeepCopyInto ¶
func (in *EventBusSpec) DeepCopyInto(out *EventBusSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EventBusStatus ¶
type EventBusStatus struct { Status common.Status `json:"status,omitempty" protobuf:"bytes,1,opt,name=status"` // Config holds the fininalized configuration of EventBus Config BusConfig `json:"config,omitempty" protobuf:"bytes,2,opt,name=config"` }
EventBusStatus holds the status of the eventbus resource
func (*EventBusStatus) DeepCopy ¶
func (in *EventBusStatus) DeepCopy() *EventBusStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventBusStatus.
func (*EventBusStatus) DeepCopyInto ¶
func (in *EventBusStatus) DeepCopyInto(out *EventBusStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventBusStatus) InitConditions ¶
func (s *EventBusStatus) InitConditions()
InitConditions sets conditions to Unknown state.
func (*EventBusStatus) MarkConfigured ¶
func (s *EventBusStatus) MarkConfigured()
MarkConfigured set the bus configuration has been done.
func (*EventBusStatus) MarkDeployFailed ¶
func (s *EventBusStatus) MarkDeployFailed(reason, message string)
MarkDeployFailed set the bus deploy failed
func (*EventBusStatus) MarkDeployed ¶
func (s *EventBusStatus) MarkDeployed(reason, message string)
MarkDeployed set the bus has been deployed.
func (*EventBusStatus) MarkDeploying ¶
func (s *EventBusStatus) MarkDeploying(reason, message string)
MarkDeploying set the bus is deploying
func (*EventBusStatus) MarkNotConfigured ¶
func (s *EventBusStatus) MarkNotConfigured(reason, message string)
MarkNotConfigured set the bus status not configured.
type NATSBus ¶
type NATSBus struct { // Native means to bring up a native NATS service Native *NativeStrategy `json:"native,omitempty" protobuf:"bytes,1,opt,name=native"` // Exotic holds an exotic NATS config Exotic *NATSConfig `json:"exotic,omitempty" protobuf:"bytes,2,opt,name=exotic"` }
NATSBus holds the NATS eventbus information
func (*NATSBus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NATSBus.
func (*NATSBus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NATSConfig ¶
type NATSConfig struct { // NATS host url URL string `json:"url,omitempty" protobuf:"bytes,1,opt,name=url"` // Cluster ID for nats streaming, if it's missing, treat it as NATS server // +optional ClusterID *string `json:"clusterID,omitempty" protobuf:"bytes,2,opt,name=clusterID"` // Auth strategy, default to AuthStrategyNone // +optional Auth *AuthStrategy `json:"auth,omitempty" protobuf:"bytes,3,opt,name=auth"` // Secret for auth // +optional AccessSecret *corev1.SecretKeySelector `json:"accessSecret,omitempty" protobuf:"bytes,4,opt,name=accessSecret"` }
NATSConfig holds the config of NATS
func (*NATSConfig) DeepCopy ¶
func (in *NATSConfig) DeepCopy() *NATSConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NATSConfig.
func (*NATSConfig) DeepCopyInto ¶
func (in *NATSConfig) DeepCopyInto(out *NATSConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NativeStrategy ¶
type NativeStrategy struct { // Size is the NATS StatefulSet size Size int `json:"size,omitempty" protobuf:"bytes,1,opt,name=size"` Auth *AuthStrategy `json:"auth,omitempty" protobuf:"bytes,2,opt,name=auth"` AntiAffinity bool `json:"antiAffinity,omitempty" protobuf:"bytes,3,opt,name=antiAffinity"` // +optional Persistence *PersistenceStrategy `json:"persistence,omitempty" protobuf:"bytes,4,opt,name=persistence"` }
NativeStrategy indicates to install a native NATS service
func (*NativeStrategy) DeepCopy ¶
func (in *NativeStrategy) DeepCopy() *NativeStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NativeStrategy.
func (*NativeStrategy) DeepCopyInto ¶
func (in *NativeStrategy) DeepCopyInto(out *NativeStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PersistenceStrategy ¶
type PersistenceStrategy struct { // Name of the StorageClass required by the claim. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 // +optional StorageClassName *string `json:"storageClassName,omitempty" protobuf:"bytes,1,opt,name=storageClassName"` // Available access modes such as ReadWriteOnce, ReadWriteMany // https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes // +optional AccessMode *corev1.PersistentVolumeAccessMode `json:"accessMode,omitempty" protobuf:"bytes,2,opt,name=accessMode"` // Volume size, e.g. 10Gi Size *apiresource.Quantity `json:"size,omitempty" protobuf:"bytes,3,opt,name=size"` }
PersistenceStrategy defines the strategy of persistence
func (*PersistenceStrategy) DeepCopy ¶
func (in *PersistenceStrategy) DeepCopy() *PersistenceStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PersistenceStrategy.
func (*PersistenceStrategy) DeepCopyInto ¶
func (in *PersistenceStrategy) DeepCopyInto(out *PersistenceStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.