Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the numaplane.numaproj.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=numaplane.numaproj.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type ConditionType
- type Controller
- type ControllerDefinitions
- type ISBServiceRollout
- func (in *ISBServiceRollout) DeepCopy() *ISBServiceRollout
- func (in *ISBServiceRollout) DeepCopyInto(out *ISBServiceRollout)
- func (in *ISBServiceRollout) DeepCopyObject() runtime.Object
- func (isbServiceRollout *ISBServiceRollout) GetChildGVK() schema.GroupVersionKind
- func (isbServiceRollout *ISBServiceRollout) GetChildGVR() metav1.GroupVersionResource
- func (isbServiceRollout *ISBServiceRollout) GetRolloutGVK() schema.GroupVersionKind
- func (isbServiceRollout *ISBServiceRollout) GetRolloutGVR() metav1.GroupVersionResource
- func (isbServiceRollout *ISBServiceRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
- func (isbServiceRollout *ISBServiceRollout) GetRolloutStatus() *Status
- type ISBServiceRolloutList
- type ISBServiceRolloutSpec
- type ISBServiceRolloutStatus
- type InterStepBufferService
- type Metadata
- type MonoVertex
- type MonoVertexRollout
- func (in *MonoVertexRollout) DeepCopy() *MonoVertexRollout
- func (in *MonoVertexRollout) DeepCopyInto(out *MonoVertexRollout)
- func (in *MonoVertexRollout) DeepCopyObject() runtime.Object
- func (monoVertexRollout *MonoVertexRollout) GetChildGVK() schema.GroupVersionKind
- func (monoVertexRollout *MonoVertexRollout) GetChildGVR() metav1.GroupVersionResource
- func (monoVertexRollout *MonoVertexRollout) GetRolloutGVK() schema.GroupVersionKind
- func (monoVertexRollout *MonoVertexRollout) GetRolloutGVR() metav1.GroupVersionResource
- func (monoVertexRollout *MonoVertexRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
- func (monoVertexRollout *MonoVertexRollout) GetRolloutStatus() *Status
- type MonoVertexRolloutList
- type MonoVertexRolloutSpec
- type MonoVertexRolloutStatus
- func (in *MonoVertexRolloutStatus) DeepCopy() *MonoVertexRolloutStatus
- func (in *MonoVertexRolloutStatus) DeepCopyInto(out *MonoVertexRolloutStatus)
- func (status *MonoVertexRolloutStatus) MarkMonoVertexPaused(reason, message string, generation int64)
- func (status *MonoVertexRolloutStatus) MarkMonoVertexUnpaused(generation int64)
- type NumaflowController
- type NumaflowControllerList
- type NumaflowControllerRollout
- type NumaflowControllerRolloutList
- type NumaflowControllerRolloutSpec
- type NumaflowControllerRolloutStatus
- type NumaflowControllerSpec
- type NumaflowControllerStatus
- type PauseStatus
- type Phase
- type Pipeline
- type PipelineRollout
- func (in *PipelineRollout) DeepCopy() *PipelineRollout
- func (in *PipelineRollout) DeepCopyInto(out *PipelineRollout)
- func (in *PipelineRollout) DeepCopyObject() runtime.Object
- func (pipelineRollout *PipelineRollout) GetChildGVK() schema.GroupVersionKind
- func (pipelineRollout *PipelineRollout) GetChildGVR() metav1.GroupVersionResource
- func (pipelineRollout *PipelineRollout) GetRolloutGVK() schema.GroupVersionKind
- func (pipelineRollout *PipelineRollout) GetRolloutGVR() metav1.GroupVersionResource
- func (pipelineRollout *PipelineRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
- func (pipelineRollout *PipelineRollout) GetRolloutStatus() *Status
- type PipelineRolloutList
- type PipelineRolloutSpec
- type PipelineRolloutStatus
- func (in *PipelineRolloutStatus) DeepCopy() *PipelineRolloutStatus
- func (in *PipelineRolloutStatus) DeepCopyInto(out *PipelineRolloutStatus)
- func (status *PipelineRolloutStatus) MarkPipelinePausingOrPaused(reason, message string, generation int64)
- func (status *PipelineRolloutStatus) MarkPipelineUnpaused(generation int64)
- type Status
- func (status *Status) ClearUpgradeInProgress()
- func (in *Status) DeepCopy() *Status
- func (in *Status) DeepCopyInto(out *Status)
- func (s *Status) GetCondition(t ConditionType) *metav1.Condition
- func (status *Status) Init(generation int64)
- func (s *Status) IsHealthy() bool
- func (status *Status) MarkChildResourcesHealthUnknown(reason, message string, generation int64)
- func (status *Status) MarkChildResourcesHealthy(generation int64)
- func (status *Status) MarkChildResourcesUnhealthy(reason, message string, generation int64)
- func (status *Status) MarkDeployed(generation int64)
- func (status *Status) MarkFailed(message string)
- func (s *Status) MarkFalse(t ConditionType, reason, message string, generation int64)
- func (status *Status) MarkPausingPipelines(generation int64)
- func (status *Status) MarkPending()
- func (status *Status) MarkProgressiveUpgradeFailed(message string, generation int64)
- func (status *Status) MarkProgressiveUpgradeSucceeded(message string, generation int64)
- func (s *Status) MarkTrue(t ConditionType, generation int64)
- func (s *Status) MarkTrueWithReason(t ConditionType, reason, message string, generation int64)
- func (s *Status) MarkUnknown(t ConditionType, reason, message string, generation int64)
- func (status *Status) MarkUnpausingPipelines(generation int64)
- func (status *Status) SetObservedGeneration(generation int64)
- func (status *Status) SetPhase(phase Phase, msg string)
- func (status *Status) SetUpgradeInProgress(upgradeStrategy UpgradeStrategy)
- type UpgradeStrategy
Constants ¶
const ( RolloutISBSvcName = "isbsvc-rollout" RolloutPipelineName = "pipeline-rollout" RolloutNumaflowControllerName = "numaflow-controller-rollout" RolloutMonoVertexName = "monovertex-rollout" NumaflowControllerName = "numaflow-controller" )
const ( // PhasePending indicates that a reconciliation operation on the rollout spec has started. // In this phase, the reconciliation process could take some time and/or happen with multiple reconciliation calls. PhasePending Phase = "Pending" // PhaseDeployed indicates that the child resource has been applied to the cluster. PhaseDeployed Phase = "Deployed" // PhaseFailed indicates that one or more errors have occurred during reconciliation. PhaseFailed Phase = "Failed" // ConditionChildResourceHealthy indicates if the child resource is in a healthy state. ConditionChildResourceHealthy ConditionType = "ChildResourcesHealthy" // ConditionChildResourceDeployed indicates that the child resource was deployed. ConditionChildResourceDeployed ConditionType = "ChildResourceDeployed" // ConditionPausingPipelines applies to ISBServiceRollout or NumaflowControllerRollout for when they are in the process // of pausing pipelines ConditionPausingPipelines ConditionType = "PausingPipelines" // ConditionProgressiveUpgradeSucceeded indicates that whether the progressive upgrade succeeded. ConditionProgressiveUpgradeSucceeded ConditionType = "ProgressiveUpgradeSucceeded" // ProgressingReasonString indicates the status condition reason as Progressing ProgressingReasonString = "Progressing" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "numaplane.numaproj.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme ISBServiceRolloutGroupVersionKind = SchemeGroupVersion.WithKind("ISBServiceRollout") ISBServiceRolloutGroupVersionResource = SchemeGroupVersion.WithResource("isbservicerollouts") PipelineRolloutGroupVersionKind = SchemeGroupVersion.WithKind("PipelineRollout") PipelineRolloutGroupVersionResource = SchemeGroupVersion.WithResource("pipelinerollouts") NumaflowControllerRolloutGroupVersionKind = SchemeGroupVersion.WithKind("NumaflowControllerRollout") NumaflowControllerRolloutGroupVersionResource = SchemeGroupVersion.WithResource("numaflowcontrollerrollouts") MonoVertexRolloutGroupVersionKind = SchemeGroupVersion.WithKind("MonoVertexRollout") MonoVertexRolloutGroupVersionResource = SchemeGroupVersion.WithResource("monovertexrollouts") NumaflowControllerGroupVersionKind = SchemeGroupVersion.WithKind("NumaflowController") NumaflowControllerGroupVersionResource = SchemeGroupVersion.WithResource("numaflowcontrollers") )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ConditionType ¶
type ConditionType string
ConditionType is a valid value of Condition.Type
const ( // ConditionMonoVertexPausingOrPaused indicates that the MonoVertex is either pausing or paused. ConditionMonoVertexPausingOrPaused ConditionType = "MonoVertexPausingOrPaused" )
const ( // ConditionPipelinePausingOrPaused indicates that the Pipeline is either pausing or paused. ConditionPipelinePausingOrPaused ConditionType = "PipelinePausingOrPaused" )
type Controller ¶
type Controller struct { // NOTE: keeping the instanceID also in the NumaflowControllerRollout in case users want to // create multiple Numaflow controllers within the same namespace InstanceID string `json:"instanceID,omitempty"` Version string `json:"version"` }
func (*Controller) DeepCopy ¶
func (in *Controller) DeepCopy() *Controller
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Controller.
func (*Controller) DeepCopyInto ¶
func (in *Controller) DeepCopyInto(out *Controller)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ControllerDefinitions ¶
type ControllerDefinitions struct { Version string `json:"version" yaml:"version"` FullSpec string `json:"fullSpec" yaml:"fullSpec"` }
ControllerDefinitions stores the Numaflow controller definitions for different versions.
func (*ControllerDefinitions) DeepCopy ¶
func (in *ControllerDefinitions) DeepCopy() *ControllerDefinitions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControllerDefinitions.
func (*ControllerDefinitions) DeepCopyInto ¶
func (in *ControllerDefinitions) DeepCopyInto(out *ControllerDefinitions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ISBServiceRollout ¶
type ISBServiceRollout struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ISBServiceRolloutSpec `json:"spec"` Status ISBServiceRolloutStatus `json:"status,omitempty"` }
+genclient +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase" ISBServiceRollout is the Schema for the isbservicerollouts API
func (*ISBServiceRollout) DeepCopy ¶
func (in *ISBServiceRollout) DeepCopy() *ISBServiceRollout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ISBServiceRollout.
func (*ISBServiceRollout) DeepCopyInto ¶
func (in *ISBServiceRollout) DeepCopyInto(out *ISBServiceRollout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ISBServiceRollout) DeepCopyObject ¶
func (in *ISBServiceRollout) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ISBServiceRollout) GetChildGVK ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetChildGVK() schema.GroupVersionKind
func (*ISBServiceRollout) GetChildGVR ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetChildGVR() metav1.GroupVersionResource
func (*ISBServiceRollout) GetRolloutGVK ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetRolloutGVK() schema.GroupVersionKind
func (*ISBServiceRollout) GetRolloutGVR ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetRolloutGVR() metav1.GroupVersionResource
func (*ISBServiceRollout) GetRolloutObjectMeta ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
func (*ISBServiceRollout) GetRolloutStatus ¶ added in v0.10.0
func (isbServiceRollout *ISBServiceRollout) GetRolloutStatus() *Status
type ISBServiceRolloutList ¶
type ISBServiceRolloutList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ISBServiceRollout `json:"items"` }
ISBServiceRolloutList contains a list of ISBServiceRollout
func (*ISBServiceRolloutList) DeepCopy ¶
func (in *ISBServiceRolloutList) DeepCopy() *ISBServiceRolloutList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ISBServiceRolloutList.
func (*ISBServiceRolloutList) DeepCopyInto ¶
func (in *ISBServiceRolloutList) DeepCopyInto(out *ISBServiceRolloutList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ISBServiceRolloutList) DeepCopyObject ¶
func (in *ISBServiceRolloutList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ISBServiceRolloutSpec ¶
type ISBServiceRolloutSpec struct {
InterStepBufferService InterStepBufferService `json:"interStepBufferService"`
}
ISBServiceRolloutSpec defines the desired state of ISBServiceRollout
func (*ISBServiceRolloutSpec) DeepCopy ¶
func (in *ISBServiceRolloutSpec) DeepCopy() *ISBServiceRolloutSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ISBServiceRolloutSpec.
func (*ISBServiceRolloutSpec) DeepCopyInto ¶
func (in *ISBServiceRolloutSpec) DeepCopyInto(out *ISBServiceRolloutSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ISBServiceRolloutStatus ¶
type ISBServiceRolloutStatus struct { Status `json:",inline"` PauseRequestStatus PauseStatus `json:"pauseRequestStatus,omitempty"` // NameCount is used as a suffix for the name of the managed isbsvc, to uniquely // identify an isbsvc. NameCount *int32 `json:"nameCount,omitempty"` }
ISBServiceRolloutStatus defines the observed state of ISBServiceRollout
func (*ISBServiceRolloutStatus) DeepCopy ¶
func (in *ISBServiceRolloutStatus) DeepCopy() *ISBServiceRolloutStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ISBServiceRolloutStatus.
func (*ISBServiceRolloutStatus) DeepCopyInto ¶
func (in *ISBServiceRolloutStatus) DeepCopyInto(out *ISBServiceRolloutStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InterStepBufferService ¶ added in v0.3.0
type InterStepBufferService struct { Metadata `json:"metadata,omitempty"` Spec runtime.RawExtension `json:"spec"` }
InterStepBufferService includes the spec of InterStepBufferService in Numaflow
func (*InterStepBufferService) DeepCopy ¶ added in v0.3.0
func (in *InterStepBufferService) DeepCopy() *InterStepBufferService
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterStepBufferService.
func (*InterStepBufferService) DeepCopyInto ¶ added in v0.3.0
func (in *InterStepBufferService) DeepCopyInto(out *InterStepBufferService)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Metadata ¶ added in v0.8.0
type Metadata struct { Annotations map[string]string `json:"annotations,omitempty"` Labels map[string]string `json:"labels,omitempty"` }
func (*Metadata) DeepCopy ¶ added in v0.8.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metadata.
func (*Metadata) DeepCopyInto ¶ added in v0.8.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MonoVertex ¶ added in v0.5.0
type MonoVertex struct { Metadata `json:"metadata,omitempty"` Spec runtime.RawExtension `json:"spec"` }
MonoVertex includes the spec of MonoVertex in Numaflow
func (*MonoVertex) DeepCopy ¶ added in v0.5.0
func (in *MonoVertex) DeepCopy() *MonoVertex
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MonoVertex.
func (*MonoVertex) DeepCopyInto ¶ added in v0.5.0
func (in *MonoVertex) DeepCopyInto(out *MonoVertex)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MonoVertexRollout ¶ added in v0.5.0
type MonoVertexRollout struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MonoVertexRolloutSpec `json:"spec"` Status MonoVertexRolloutStatus `json:"status,omitempty"` }
+genclient +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase" MonoVertexRollout is the Schema for the monovertexrollouts API
func (*MonoVertexRollout) DeepCopy ¶ added in v0.5.0
func (in *MonoVertexRollout) DeepCopy() *MonoVertexRollout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MonoVertexRollout.
func (*MonoVertexRollout) DeepCopyInto ¶ added in v0.5.0
func (in *MonoVertexRollout) DeepCopyInto(out *MonoVertexRollout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MonoVertexRollout) DeepCopyObject ¶ added in v0.5.0
func (in *MonoVertexRollout) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MonoVertexRollout) GetChildGVK ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetChildGVK() schema.GroupVersionKind
func (*MonoVertexRollout) GetChildGVR ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetChildGVR() metav1.GroupVersionResource
func (*MonoVertexRollout) GetRolloutGVK ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetRolloutGVK() schema.GroupVersionKind
func (*MonoVertexRollout) GetRolloutGVR ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetRolloutGVR() metav1.GroupVersionResource
the following functions implement the rolloutObject interface:
func (*MonoVertexRollout) GetRolloutObjectMeta ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
func (*MonoVertexRollout) GetRolloutStatus ¶ added in v0.10.0
func (monoVertexRollout *MonoVertexRollout) GetRolloutStatus() *Status
type MonoVertexRolloutList ¶ added in v0.5.0
type MonoVertexRolloutList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MonoVertexRollout `json:"items"` }
MonoVertexRolloutList contains a list of MonoVertexRollout
func (*MonoVertexRolloutList) DeepCopy ¶ added in v0.5.0
func (in *MonoVertexRolloutList) DeepCopy() *MonoVertexRolloutList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MonoVertexRolloutList.
func (*MonoVertexRolloutList) DeepCopyInto ¶ added in v0.5.0
func (in *MonoVertexRolloutList) DeepCopyInto(out *MonoVertexRolloutList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MonoVertexRolloutList) DeepCopyObject ¶ added in v0.5.0
func (in *MonoVertexRolloutList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MonoVertexRolloutSpec ¶ added in v0.5.0
type MonoVertexRolloutSpec struct {
MonoVertex MonoVertex `json:"monoVertex"`
}
MonoVertexRolloutSpec defines the desired state of MonoVertexRollout
func (*MonoVertexRolloutSpec) DeepCopy ¶ added in v0.5.0
func (in *MonoVertexRolloutSpec) DeepCopy() *MonoVertexRolloutSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MonoVertexRolloutSpec.
func (*MonoVertexRolloutSpec) DeepCopyInto ¶ added in v0.5.0
func (in *MonoVertexRolloutSpec) DeepCopyInto(out *MonoVertexRolloutSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MonoVertexRolloutStatus ¶ added in v0.5.0
type MonoVertexRolloutStatus struct { Status `json:",inline"` // NameCount is used as a suffix for the name of the managed monovertex, to uniquely // identify a monovertex. NameCount *int32 `json:"nameCount,omitempty"` }
MonoVertexRolloutStatus defines the observed state of MonoVertexRollout
func (*MonoVertexRolloutStatus) DeepCopy ¶ added in v0.5.0
func (in *MonoVertexRolloutStatus) DeepCopy() *MonoVertexRolloutStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MonoVertexRolloutStatus.
func (*MonoVertexRolloutStatus) DeepCopyInto ¶ added in v0.5.0
func (in *MonoVertexRolloutStatus) DeepCopyInto(out *MonoVertexRolloutStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MonoVertexRolloutStatus) MarkMonoVertexPaused ¶ added in v0.8.0
func (status *MonoVertexRolloutStatus) MarkMonoVertexPaused(reason, message string, generation int64)
func (*MonoVertexRolloutStatus) MarkMonoVertexUnpaused ¶ added in v0.8.0
func (status *MonoVertexRolloutStatus) MarkMonoVertexUnpaused(generation int64)
type NumaflowController ¶ added in v0.10.0
type NumaflowController struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec NumaflowControllerSpec `json:"spec,omitempty"` Status NumaflowControllerStatus `json:"status,omitempty"` }
+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase" +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version",description="The desired Numaflow Controller version" NumaflowController is the Schema for the numaflowcontrollers API
func (*NumaflowController) DeepCopy ¶ added in v0.10.0
func (in *NumaflowController) DeepCopy() *NumaflowController
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowController.
func (*NumaflowController) DeepCopyInto ¶ added in v0.10.0
func (in *NumaflowController) DeepCopyInto(out *NumaflowController)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NumaflowController) DeepCopyObject ¶ added in v0.10.0
func (in *NumaflowController) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NumaflowControllerList ¶ added in v0.10.0
type NumaflowControllerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []NumaflowController `json:"items"` }
NumaflowControllerList contains a list of NumaflowController
func (*NumaflowControllerList) DeepCopy ¶ added in v0.10.0
func (in *NumaflowControllerList) DeepCopy() *NumaflowControllerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerList.
func (*NumaflowControllerList) DeepCopyInto ¶ added in v0.10.0
func (in *NumaflowControllerList) DeepCopyInto(out *NumaflowControllerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NumaflowControllerList) DeepCopyObject ¶ added in v0.10.0
func (in *NumaflowControllerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NumaflowControllerRollout ¶
type NumaflowControllerRollout struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec NumaflowControllerRolloutSpec `json:"spec,omitempty"` Status NumaflowControllerRolloutStatus `json:"status,omitempty"` }
+genclient +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:validation:XValidation:rule="matches(self.metadata.name, '^numaflow-controller.*')",message="The metadata name must start with 'numaflow-controller'" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase" +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.controller.version",description="The desired Numaflow Controller version" NumaflowControllerRollout is the Schema for the numaflowcontrollerrollouts API
func (*NumaflowControllerRollout) DeepCopy ¶
func (in *NumaflowControllerRollout) DeepCopy() *NumaflowControllerRollout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerRollout.
func (*NumaflowControllerRollout) DeepCopyInto ¶
func (in *NumaflowControllerRollout) DeepCopyInto(out *NumaflowControllerRollout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NumaflowControllerRollout) DeepCopyObject ¶
func (in *NumaflowControllerRollout) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NumaflowControllerRolloutList ¶
type NumaflowControllerRolloutList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []NumaflowControllerRollout `json:"items"` }
NumaflowControllerRolloutList contains a list of NumaflowControllerRollout
func (*NumaflowControllerRolloutList) DeepCopy ¶
func (in *NumaflowControllerRolloutList) DeepCopy() *NumaflowControllerRolloutList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerRolloutList.
func (*NumaflowControllerRolloutList) DeepCopyInto ¶
func (in *NumaflowControllerRolloutList) DeepCopyInto(out *NumaflowControllerRolloutList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NumaflowControllerRolloutList) DeepCopyObject ¶
func (in *NumaflowControllerRolloutList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NumaflowControllerRolloutSpec ¶
type NumaflowControllerRolloutSpec struct {
Controller Controller `json:"controller"`
}
NumaflowControllerRolloutSpec defines the desired state of NumaflowControllerRollout
func (*NumaflowControllerRolloutSpec) DeepCopy ¶
func (in *NumaflowControllerRolloutSpec) DeepCopy() *NumaflowControllerRolloutSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerRolloutSpec.
func (*NumaflowControllerRolloutSpec) DeepCopyInto ¶
func (in *NumaflowControllerRolloutSpec) DeepCopyInto(out *NumaflowControllerRolloutSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NumaflowControllerRolloutStatus ¶
type NumaflowControllerRolloutStatus struct { Status `json:",inline"` PauseRequestStatus PauseStatus `json:"pauseRequestStatus,omitempty"` }
NumaflowControllerRolloutStatus defines the observed state of NumaflowControllerRollout
func (*NumaflowControllerRolloutStatus) DeepCopy ¶
func (in *NumaflowControllerRolloutStatus) DeepCopy() *NumaflowControllerRolloutStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerRolloutStatus.
func (*NumaflowControllerRolloutStatus) DeepCopyInto ¶
func (in *NumaflowControllerRolloutStatus) DeepCopyInto(out *NumaflowControllerRolloutStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NumaflowControllerSpec ¶ added in v0.10.0
type NumaflowControllerSpec struct { InstanceID string `json:"instanceID,omitempty"` Version string `json:"version"` }
NumaflowControllerSpec defines the desired state of NumaflowController
func (*NumaflowControllerSpec) DeepCopy ¶ added in v0.10.0
func (in *NumaflowControllerSpec) DeepCopy() *NumaflowControllerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerSpec.
func (*NumaflowControllerSpec) DeepCopyInto ¶ added in v0.10.0
func (in *NumaflowControllerSpec) DeepCopyInto(out *NumaflowControllerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NumaflowControllerStatus ¶ added in v0.10.0
type NumaflowControllerStatus struct {
Status `json:",inline"`
}
NumaflowControllerStatus defines the observed state of NumaflowController
func (*NumaflowControllerStatus) DeepCopy ¶ added in v0.10.0
func (in *NumaflowControllerStatus) DeepCopy() *NumaflowControllerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumaflowControllerStatus.
func (*NumaflowControllerStatus) DeepCopyInto ¶ added in v0.10.0
func (in *NumaflowControllerStatus) DeepCopyInto(out *NumaflowControllerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PauseStatus ¶ added in v0.5.0
type PauseStatus struct { // The begin timestamp for the last pause of the Pipeline. LastPauseBeginTime metav1.Time `json:"lastPauseBeginTime,omitempty"` // The transition timestamp from Pausing to Paused for the last pause of the Pipeline. LastPauseTransitionTime metav1.Time `json:"lastPausePhaseChangeTime,omitempty"` // The end timestamp for the last pause of the Pipeline. LastPauseEndTime metav1.Time `json:"lastPauseEndTime,omitempty"` }
PauseStatus is a common structure used to communicate how long Pipelines are paused.
func (*PauseStatus) DeepCopy ¶ added in v0.5.0
func (in *PauseStatus) DeepCopy() *PauseStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PauseStatus.
func (*PauseStatus) DeepCopyInto ¶ added in v0.5.0
func (in *PauseStatus) DeepCopyInto(out *PauseStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Pipeline ¶ added in v0.3.0
type Pipeline struct { Metadata `json:"metadata,omitempty"` Spec runtime.RawExtension `json:"spec"` }
Pipeline includes the spec of Pipeline in Numaflow
func (*Pipeline) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pipeline.
func (*Pipeline) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRollout ¶
type PipelineRollout struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PipelineRolloutSpec `json:"spec"` Status PipelineRolloutStatus `json:"status,omitempty"` }
+genclient +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase" +kubebuilder:printcolumn:name="Upgrade In Progress",type="string",JSONPath=".status.upgradeInProgress",description="The upgrade strategy currently prosessing the PipelineRollout. No upgrade in progress if empty" PipelineRollout is the Schema for the pipelinerollouts API
func (*PipelineRollout) DeepCopy ¶
func (in *PipelineRollout) DeepCopy() *PipelineRollout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRollout.
func (*PipelineRollout) DeepCopyInto ¶
func (in *PipelineRollout) DeepCopyInto(out *PipelineRollout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRollout) DeepCopyObject ¶
func (in *PipelineRollout) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PipelineRollout) GetChildGVK ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetChildGVK() schema.GroupVersionKind
func (*PipelineRollout) GetChildGVR ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetChildGVR() metav1.GroupVersionResource
func (*PipelineRollout) GetRolloutGVK ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetRolloutGVK() schema.GroupVersionKind
func (*PipelineRollout) GetRolloutGVR ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetRolloutGVR() metav1.GroupVersionResource
func (*PipelineRollout) GetRolloutObjectMeta ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetRolloutObjectMeta() *metav1.ObjectMeta
func (*PipelineRollout) GetRolloutStatus ¶ added in v0.10.0
func (pipelineRollout *PipelineRollout) GetRolloutStatus() *Status
type PipelineRolloutList ¶
type PipelineRolloutList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PipelineRollout `json:"items"` }
PipelineRolloutList contains a list of PipelineRollout
func (*PipelineRolloutList) DeepCopy ¶
func (in *PipelineRolloutList) DeepCopy() *PipelineRolloutList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRolloutList.
func (*PipelineRolloutList) DeepCopyInto ¶
func (in *PipelineRolloutList) DeepCopyInto(out *PipelineRolloutList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRolloutList) DeepCopyObject ¶
func (in *PipelineRolloutList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PipelineRolloutSpec ¶
type PipelineRolloutSpec struct {
Pipeline Pipeline `json:"pipeline"`
}
PipelineRolloutSpec defines the desired state of PipelineRollout
func (*PipelineRolloutSpec) DeepCopy ¶
func (in *PipelineRolloutSpec) DeepCopy() *PipelineRolloutSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRolloutSpec.
func (*PipelineRolloutSpec) DeepCopyInto ¶
func (in *PipelineRolloutSpec) DeepCopyInto(out *PipelineRolloutSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRolloutStatus ¶
type PipelineRolloutStatus struct { Status `json:",inline"` PauseStatus PauseStatus `json:"pauseStatus,omitempty"` // NameCount is used as a suffix for the name of the managed pipeline, to uniquely // identify a pipeline. NameCount *int32 `json:"nameCount,omitempty"` }
PipelineRolloutStatus defines the observed state of PipelineRollout
func (*PipelineRolloutStatus) DeepCopy ¶
func (in *PipelineRolloutStatus) DeepCopy() *PipelineRolloutStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRolloutStatus.
func (*PipelineRolloutStatus) DeepCopyInto ¶
func (in *PipelineRolloutStatus) DeepCopyInto(out *PipelineRolloutStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRolloutStatus) MarkPipelinePausingOrPaused ¶ added in v0.2.0
func (status *PipelineRolloutStatus) MarkPipelinePausingOrPaused(reason, message string, generation int64)
func (*PipelineRolloutStatus) MarkPipelineUnpaused ¶ added in v0.3.0
func (status *PipelineRolloutStatus) MarkPipelineUnpaused(generation int64)
type Status ¶
type Status struct { // Conditions are the latest available observations of a resource's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // Message is added if Phase is PhaseFailed. Message string `json:"message,omitempty"` // Phase indicates the current phase of the resource. Phase Phase `json:"phase,omitempty"` // ObservedGeneration stores the generation value observed when setting the current Phase ObservedGeneration int64 `json:"observedGeneration,omitempty"` // UpgradeInProgress indicates the upgrade strategy currently being used and affecting the resource state or empty if no upgrade is in progress UpgradeInProgress UpgradeStrategy `json:"upgradeInProgress,omitempty"` }
Status is a common structure which can be used for Status field.
func (*Status) ClearUpgradeInProgress ¶ added in v0.10.0
func (status *Status) ClearUpgradeInProgress()
func (*Status) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.
func (*Status) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Status) GetCondition ¶
func (s *Status) GetCondition(t ConditionType) *metav1.Condition
GetCondition returns the condition of a condition type
func (*Status) Init ¶ added in v0.2.0
Init sets certain Status parameters to a default initial state
func (*Status) MarkChildResourcesHealthUnknown ¶ added in v0.2.0
func (*Status) MarkChildResourcesHealthy ¶
func (*Status) MarkChildResourcesUnhealthy ¶
func (*Status) MarkDeployed ¶ added in v0.2.0
MarkDeployed sets Phase to Deployed
func (*Status) MarkFailed ¶
MarkFailed sets Phase to Failed
func (*Status) MarkFalse ¶
func (s *Status) MarkFalse(t ConditionType, reason, message string, generation int64)
MarkFalse sets the status of t to fasle
func (*Status) MarkPausingPipelines ¶ added in v0.4.0
func (*Status) MarkPending ¶ added in v0.2.0
func (status *Status) MarkPending()
MarkPending sets Phase to Pending
func (*Status) MarkProgressiveUpgradeFailed ¶ added in v0.8.0
func (*Status) MarkProgressiveUpgradeSucceeded ¶ added in v0.8.0
func (*Status) MarkTrue ¶
func (s *Status) MarkTrue(t ConditionType, generation int64)
MarkTrue sets the status of t to true
func (*Status) MarkTrueWithReason ¶
func (s *Status) MarkTrueWithReason(t ConditionType, reason, message string, generation int64)
MarkTrueWithReason sets the status of t to true with reason
func (*Status) MarkUnknown ¶
func (s *Status) MarkUnknown(t ConditionType, reason, message string, generation int64)
MarkUnknown sets the status of t to unknown
func (*Status) MarkUnpausingPipelines ¶ added in v0.4.0
func (*Status) SetObservedGeneration ¶ added in v0.3.0
func (*Status) SetUpgradeInProgress ¶ added in v0.10.0
func (status *Status) SetUpgradeInProgress(upgradeStrategy UpgradeStrategy)
type UpgradeStrategy ¶ added in v0.7.0
type UpgradeStrategy string
const ( UpgradeStrategyNoOp UpgradeStrategy = "" UpgradeStrategyError UpgradeStrategy = "Error" UpgradeStrategyApply UpgradeStrategy = "DirectApply" UpgradeStrategyPPND UpgradeStrategy = "PipelinePauseAndDrain" UpgradeStrategyProgressive UpgradeStrategy = "Progressive" )