Documentation ¶
Overview ¶
Package v1 contains API Schema definitions for the bitflow v1 API group +k8s:deepcopy-gen=package,register +groupName=bitflow.com
Package v1 contains API Schema definitions for the bitflow v1 API group +k8s:deepcopy-gen=package,register +groupName=bitflow.com
Index ¶
- Constants
- Variables
- func DeepCopyUrl(u *url.URL) *url.URL
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- type BitflowSource
- func (in *BitflowSource) DeepCopy() *BitflowSource
- func (in *BitflowSource) DeepCopyInto(out *BitflowSource)
- func (in *BitflowSource) DeepCopyObject() runtime.Object
- func (s *BitflowSource) EqualSpec(other *BitflowSource) bool
- func (s *BitflowSource) Log() *log.Entry
- func (s *BitflowSource) LogFields(entry *log.Entry) *log.Entry
- func (s *BitflowSource) String() string
- func (s *BitflowSource) Validate()
- type BitflowSourceList
- type BitflowSourceSpec
- type BitflowStep
- func (in *BitflowStep) DeepCopy() *BitflowStep
- func (in *BitflowStep) DeepCopyInto(out *BitflowStep)
- func (in *BitflowStep) DeepCopyObject() runtime.Object
- func (s *BitflowStep) IsRecursive(sourceLabels map[string]string) bool
- func (s *BitflowStep) Log() *log.Entry
- func (s *BitflowStep) LogFields(entry *log.Entry) *log.Entry
- func (s *BitflowStep) Matches(sourceLabels map[string]string) bool
- func (s *BitflowStep) MatchesLabels(sourceLabels map[string]string) bool
- func (s *BitflowStep) String() string
- func (s *BitflowStep) Type() string
- func (s *BitflowStep) Validate()
- type BitflowStepList
- type BitflowStepSpec
- type BitflowValidationStatus
- type IngestMatch
- type StepOutput
Constants ¶
const ( DataSourcesKind = "BitflowSource" DataSourcesResourceSingular = "bitflow-source" DataSourcesResource = DataSourcesResourceSingular + "s" )
const ( StepsKind = "BitflowStep" StepsResourceSingular = "bitflow-step" StepsResource = StepsResourceSingular + "s" MatchCheckWildcard = "wildcard" MatchCheckExact = "exact" MatchCheckRegex = "regex" MatchCheckPresent = "present" MatchCheckAbsent = "absent" StepTypeOneToOne = "one-to-one" // The default, when the field is empty StepTypeAllToOne = "all-to-one" StepTypeSingleton = "singleton" )
const ( LabelStepType = "bitflow-step-type" LabelStepName = "bitflow-step-name" SourceLabelPodName = "bitflow-pod" SourceLabelPodOutputName = "bitflow-pod-output" PipelineDepthLabel = "bitflow-pipeline-depth" PipelinePathLabelPrefix = "bitflow-pipeline-" PodLabelOneToOneSourceName = "bitflow-source-name" )
const ( Group = "bitflow.com" Version = "v1" GroupVersion = Group + "/" + Version )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
Types ¶
type BitflowSource ¶
type BitflowSource struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BitflowSourceSpec `json:"spec,omitempty"` Status BitflowValidationStatus `json:"status,omitempty"` }
BitflowSource is the Schema for the BitflowSource API +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".spec.url" +kubebuilder:printcolumn:name="ValidationError",type="string",JSONPath=".status.validationError" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:path=bitflow-sources,shortName=bso;bfso,singular=bitflow-source
func (*BitflowSource) DeepCopy ¶
func (in *BitflowSource) DeepCopy() *BitflowSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowSource.
func (*BitflowSource) DeepCopyInto ¶
func (in *BitflowSource) DeepCopyInto(out *BitflowSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BitflowSource) DeepCopyObject ¶
func (in *BitflowSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BitflowSource) EqualSpec ¶
func (s *BitflowSource) EqualSpec(other *BitflowSource) bool
func (*BitflowSource) Log ¶
func (s *BitflowSource) Log() *log.Entry
func (*BitflowSource) String ¶
func (s *BitflowSource) String() string
func (*BitflowSource) Validate ¶
func (s *BitflowSource) Validate()
type BitflowSourceList ¶
type BitflowSourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []BitflowSource `json:"items"` }
BitflowSourceList contains a list of BitflowSource +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*BitflowSourceList) DeepCopy ¶
func (in *BitflowSourceList) DeepCopy() *BitflowSourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowSourceList.
func (*BitflowSourceList) DeepCopyInto ¶
func (in *BitflowSourceList) DeepCopyInto(out *BitflowSourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BitflowSourceList) DeepCopyObject ¶
func (in *BitflowSourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BitflowSourceList) GetItems ¶
func (l *BitflowSourceList) GetItems() []*BitflowSource
type BitflowSourceSpec ¶
type BitflowSourceSpec struct { // +kubebuilder:validation:MinLength=1 URL string `json:"url"` }
BitflowSourceSpec defines the desired state of BitflowSource +k8s:openapi-gen=true
func (*BitflowSourceSpec) DeepCopy ¶
func (in *BitflowSourceSpec) DeepCopy() *BitflowSourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowSourceSpec.
func (*BitflowSourceSpec) DeepCopyInto ¶
func (in *BitflowSourceSpec) DeepCopyInto(out *BitflowSourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BitflowStep ¶
type BitflowStep struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BitflowStepSpec `json:"spec,omitempty"` Status BitflowValidationStatus `json:"status,omitempty"` }
BitflowStep is the Schema for the bitflowsteps API +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="ValidationError",type="string",JSONPath=".status.validationError" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:path=bitflow-steps,shortName=bst;bfst +kubebuilder:singular=bitflow-step
func (*BitflowStep) DeepCopy ¶
func (in *BitflowStep) DeepCopy() *BitflowStep
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowStep.
func (*BitflowStep) DeepCopyInto ¶
func (in *BitflowStep) DeepCopyInto(out *BitflowStep)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BitflowStep) DeepCopyObject ¶
func (in *BitflowStep) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BitflowStep) IsRecursive ¶
func (s *BitflowStep) IsRecursive(sourceLabels map[string]string) bool
func (*BitflowStep) Log ¶
func (s *BitflowStep) Log() *log.Entry
func (*BitflowStep) MatchesLabels ¶
func (s *BitflowStep) MatchesLabels(sourceLabels map[string]string) bool
func (*BitflowStep) String ¶
func (s *BitflowStep) String() string
func (*BitflowStep) Type ¶
func (s *BitflowStep) Type() string
func (*BitflowStep) Validate ¶
func (s *BitflowStep) Validate()
type BitflowStepList ¶
type BitflowStepList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []BitflowStep `json:"items"` }
BitflowStepList contains a list of BitflowSteps +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*BitflowStepList) DeepCopy ¶
func (in *BitflowStepList) DeepCopy() *BitflowStepList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowStepList.
func (*BitflowStepList) DeepCopyInto ¶
func (in *BitflowStepList) DeepCopyInto(out *BitflowStepList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BitflowStepList) DeepCopyObject ¶
func (in *BitflowStepList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BitflowStepList) GetItems ¶
func (l *BitflowStepList) GetItems() []*BitflowStep
type BitflowStepSpec ¶
type BitflowStepSpec struct { // +kubebuilder:validation:Enum=one-to-one;all-to-one;"";singleton Type string `json:"type,omitempty"` Scheduler string `json:"scheduler,omitempty"` Ingest []*IngestMatch `json:"ingest,omitempty"` Outputs []*StepOutput `json:"outputs,omitempty"` MinResources corev1.ResourceList `json:"minResources,omitempty"` Template *v1.Pod `json:"template"` }
BitflowStepSpec defines the desired state of BitflowStep +k8s:openapi-gen=true
func (*BitflowStepSpec) DeepCopy ¶
func (in *BitflowStepSpec) DeepCopy() *BitflowStepSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowStepSpec.
func (*BitflowStepSpec) DeepCopyInto ¶
func (in *BitflowStepSpec) DeepCopyInto(out *BitflowStepSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BitflowValidationStatus ¶
type BitflowValidationStatus struct {
ValidationError string `json:"validationError"`
}
BitflowValidationStatus defines the validation status of a Bitflow object +k8s:openapi-gen=true
func (*BitflowValidationStatus) DeepCopy ¶
func (in *BitflowValidationStatus) DeepCopy() *BitflowValidationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BitflowValidationStatus.
func (*BitflowValidationStatus) DeepCopyInto ¶
func (in *BitflowValidationStatus) DeepCopyInto(out *BitflowValidationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngestMatch ¶
type IngestMatch struct { // +kubebuilder:validation:MinLength=1 Key string `json:"key"` Value string `json:"value,omitempty"` // +kubebuilder:validation:Enum=wildcard;exact;regex;present;"";absent Check string `json:"check,omitempty"` // contains filtered or unexported fields }
+k8s:openapi-gen=true
func (*IngestMatch) DeepCopy ¶
func (in *IngestMatch) DeepCopy() *IngestMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngestMatch.
func (*IngestMatch) DeepCopyInto ¶
func (in *IngestMatch) DeepCopyInto(out *IngestMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StepOutput ¶
type StepOutput struct { // +kubebuilder:validation:MinLength=1 Name string `json:"name"` // +kubebuilder:validation:MinLength=1 URL string `json:"url"` Labels map[string]string `json:"labels"` // contains filtered or unexported fields }
+k8s:openapi-gen=true
func (*StepOutput) DeepCopy ¶
func (in *StepOutput) DeepCopy() *StepOutput
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StepOutput.
func (*StepOutput) DeepCopyInto ¶
func (in *StepOutput) DeepCopyInto(out *StepOutput)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StepOutput) GetOutputSourceURL ¶
func (output *StepOutput) GetOutputSourceURL(pod *corev1.Pod) string
func (*StepOutput) GetUrl ¶
func (output *StepOutput) GetUrl() *url.URL