Documentation ¶
Overview ¶
Package v1alpha08 contains API Schema definitions for the serverless v1alpha08 API group +kubebuilder:object:generate=true +groupName=sonataflow.org
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- func ToCNCFWorkflow(workflowCR *SonataFlow, context context.Context) (*cncfmodel.Workflow, error)
- type BuildPhase
- type BuildPlatformConfig
- func (in *BuildPlatformConfig) DeepCopy() *BuildPlatformConfig
- func (in *BuildPlatformConfig) DeepCopyInto(out *BuildPlatformConfig)
- func (b *BuildPlatformConfig) GetTimeout() metav1.Duration
- func (b *BuildPlatformConfig) IsStrategyOptionEmpty(option string) bool
- func (b *BuildPlatformConfig) IsStrategyOptionEnabled(option string) bool
- type BuildPlatformSpec
- type BuildStrategy
- type BuildTemplate
- type ConfigMapWorkflowResource
- type DevModePlatformSpec
- type Flow
- type PlatformCluster
- type RegistrySpec
- type SonataFlow
- type SonataFlowBuild
- type SonataFlowBuildList
- type SonataFlowBuildSpec
- type SonataFlowBuildStatus
- type SonataFlowList
- type SonataFlowPlatform
- type SonataFlowPlatformList
- type SonataFlowPlatformSpec
- type SonataFlowPlatformStatus
- func (in *SonataFlowPlatformStatus) DeepCopy() *SonataFlowPlatformStatus
- func (in *SonataFlowPlatformStatus) DeepCopyInto(out *SonataFlowPlatformStatus)
- func (in *SonataFlowPlatformStatus) GetTopLevelCondition() *api.Condition
- func (in *SonataFlowPlatformStatus) GetTopLevelConditionType() api.ConditionType
- func (in *SonataFlowPlatformStatus) IsCreating() bool
- func (in *SonataFlowPlatformStatus) IsDuplicated() bool
- func (in *SonataFlowPlatformStatus) IsFailure() bool
- func (in *SonataFlowPlatformStatus) IsReady() bool
- func (in *SonataFlowPlatformStatus) IsWarming() bool
- func (in *SonataFlowPlatformStatus) Manager() api.ConditionsManager
- type SonataFlowSpec
- type SonataFlowStatus
- func (in *SonataFlowStatus) DeepCopy() *SonataFlowStatus
- func (in *SonataFlowStatus) DeepCopyInto(out *SonataFlowStatus)
- func (s *SonataFlowStatus) GetTopLevelCondition() *api.Condition
- func (s *SonataFlowStatus) GetTopLevelConditionType() api.ConditionType
- func (s *SonataFlowStatus) IsBuildFailed() bool
- func (s *SonataFlowStatus) IsBuildRunningOrUnknown() bool
- func (s *SonataFlowStatus) IsChildObjectsProblem() bool
- func (s *SonataFlowStatus) IsReady() bool
- func (s *SonataFlowStatus) IsWaitingForBuild() bool
- func (s *SonataFlowStatus) IsWaitingForDeployment() bool
- func (s *SonataFlowStatus) IsWaitingForPlatform() bool
- func (s *SonataFlowStatus) Manager() api.ConditionsManager
- type WorkflowResources
Constants ¶
const ( PlatformCreatingReason = "Creating" PlatformWarmingReason = "Warming" PlatformFailureReason = "Failure" PlatformDuplicatedReason = "Duplicated" )
const ( // SonataFlowPlatformKind is the Kind name of the SonataFlowPlatform CR SonataFlowPlatformKind string = "SonataFlowPlatform" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "sonataflow.org", Version: "v1alpha08"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
func ToCNCFWorkflow ¶
ToCNCFWorkflow converts a SonataFlow object to a Workflow one in order to be able to convert it to a YAML/Json
Types ¶
type BuildPhase ¶
type BuildPhase string
const ( // BuildPhaseNone -- BuildPhaseNone BuildPhase = "" // BuildPhaseInitialization -- BuildPhaseInitialization BuildPhase = "Initialization" // BuildPhaseScheduling -- BuildPhaseScheduling BuildPhase = "Scheduling" // BuildPhasePending -- BuildPhasePending BuildPhase = "Pending" // BuildPhaseRunning -- BuildPhaseRunning BuildPhase = "Running" // BuildPhaseSucceeded -- BuildPhaseSucceeded BuildPhase = "Succeeded" // BuildPhaseFailed -- BuildPhaseFailed BuildPhase = "Failed" // BuildPhaseInterrupted -- BuildPhaseInterrupted BuildPhase = "Interrupted" // BuildPhaseError -- BuildPhaseError BuildPhase = "Error" )
type BuildPlatformConfig ¶ added in v1.43.0
type BuildPlatformConfig struct { // a base image that can be used as base layer for all images. // It can be useful if you want to provide some custom base image with further utility software BaseImage string `json:"baseImage,omitempty"` // how much time to wait before time out the build process Timeout *metav1.Duration `json:"timeout,omitempty"` // BuildStrategy to use to build workflows in the platform. // Usually, the operator elect the strategy based on the platform. // Note that this field might be read only in certain scenarios. BuildStrategy BuildStrategy `json:"strategy,omitempty"` // BuildStrategyOptions additional options to add to the build strategy. // See https://sonataflow.org/serverlessworkflow/main/cloud/operator/build-and-deploy-workflows.html BuildStrategyOptions map[string]string `json:"strategyOptions,omitempty"` // Registry the registry where to publish the built image Registry RegistrySpec `json:"registry,omitempty"` }
Describes the configuration for building in the given platform
func (*BuildPlatformConfig) DeepCopy ¶ added in v1.43.0
func (in *BuildPlatformConfig) DeepCopy() *BuildPlatformConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildPlatformConfig.
func (*BuildPlatformConfig) DeepCopyInto ¶ added in v1.43.0
func (in *BuildPlatformConfig) DeepCopyInto(out *BuildPlatformConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BuildPlatformConfig) GetTimeout ¶ added in v1.43.0
func (b *BuildPlatformConfig) GetTimeout() metav1.Duration
GetTimeout returns the specified duration or a default one
func (*BuildPlatformConfig) IsStrategyOptionEmpty ¶ added in v1.43.0
func (b *BuildPlatformConfig) IsStrategyOptionEmpty(option string) bool
func (*BuildPlatformConfig) IsStrategyOptionEnabled ¶ added in v1.43.0
func (b *BuildPlatformConfig) IsStrategyOptionEnabled(option string) bool
IsStrategyOptionEnabled return whether the BuildStrategyOptions is enabled or not
type BuildPlatformSpec ¶ added in v1.43.0
type BuildPlatformSpec struct { // Describes a build template for building workflows. Base for the internal SonataFlowBuild resource. Template BuildTemplate `json:"template,omitempty"` // Describes the platform configuration for building workflows. Config BuildPlatformConfig `json:"config,omitempty"` }
Describes the general build specification for this platform. Specific for build scenarios.
func (*BuildPlatformSpec) DeepCopy ¶ added in v1.43.0
func (in *BuildPlatformSpec) DeepCopy() *BuildPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildPlatformSpec.
func (*BuildPlatformSpec) DeepCopyInto ¶ added in v1.43.0
func (in *BuildPlatformSpec) DeepCopyInto(out *BuildPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BuildStrategy ¶
type BuildStrategy string
const ( // OperatorBuildStrategy uses the operator builder to perform the workflow build // E.g. on Minikube or Kubernetes the container-builder strategies OperatorBuildStrategy BuildStrategy = "operator" // PlatformBuildStrategy uses the cluster to perform the build. // E.g. on OpenShift, BuildConfig. PlatformBuildStrategy BuildStrategy = "platform" )
type BuildTemplate ¶
type BuildTemplate struct { // Timeout defines the Build maximum execution duration. // The Build deadline is set to the Build start time plus the Timeout duration. // If the Build deadline is exceeded, the Build context is canceled, // and its phase set to BuildPhaseFailed. // +kubebuilder:validation:Format=duration Timeout metav1.Duration `json:"timeout,omitempty"` // Resources optional compute resource requirements for the builder Resources corev1.ResourceRequirements `json:"resources,omitempty"` // Arguments lists the command line arguments to send to the internal builder command. // Depending on the build method you might set this attribute instead of BuildArgs. // For example: ".spec.arguments=verbose=3". // Please see the SonataFlow guides. Arguments []string `json:"arguments,omitempty"` // Optional build arguments that can be set to the internal build (e.g. Docker ARG) BuildArgs []corev1.EnvVar `json:"buildArgs,omitempty"` // Optional environment variables to add to the internal build Envs []corev1.EnvVar `json:"envs,omitempty"` }
func (*BuildTemplate) DeepCopy ¶
func (in *BuildTemplate) DeepCopy() *BuildTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildTemplate.
func (*BuildTemplate) DeepCopyInto ¶
func (in *BuildTemplate) DeepCopyInto(out *BuildTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConfigMapWorkflowResource ¶
type ConfigMapWorkflowResource struct { // ConfigMap the given configMap name in the same workflow context to find the resource // +kubebuilder:validation:Required ConfigMap v1.LocalObjectReference `json:"configMap"` // WorkflowPath path relative to the workflow application root file system within the pod (/<application path>/src/main/resources). // Starting trailing slashes will be removed. WorkflowPath string `json:"workflowPath,omitempty"` }
ConfigMapWorkflowResource ConfigMap local reference holding one or more workflow resources, such as OpenAPI files that will be mounted in the workflow application.
func (*ConfigMapWorkflowResource) DeepCopy ¶
func (in *ConfigMapWorkflowResource) DeepCopy() *ConfigMapWorkflowResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapWorkflowResource.
func (*ConfigMapWorkflowResource) DeepCopyInto ¶
func (in *ConfigMapWorkflowResource) DeepCopyInto(out *ConfigMapWorkflowResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DevModePlatformSpec ¶ added in v1.43.0
type DevModePlatformSpec struct { // Base image to run the Workflow in dev mode instead of the operator's default. BaseImage string `json:"baseImage,omitempty"` }
DevModePlatformSpec describes the devmode configuration for the given platform.
func (*DevModePlatformSpec) DeepCopy ¶ added in v1.43.0
func (in *DevModePlatformSpec) DeepCopy() *DevModePlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevModePlatformSpec.
func (*DevModePlatformSpec) DeepCopyInto ¶ added in v1.43.0
func (in *DevModePlatformSpec) DeepCopyInto(out *DevModePlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Flow ¶
type Flow struct { // Workflow start definition. // +kubebuilder:validation:Schemaless // +kubebuilder:pruning:PreserveUnknownFields // +optional Start *cncfmodel.Start `json:"start,omitempty"` // Annotations List of helpful terms describing the workflows intended purpose, subject areas, or other important // qualities. // +optional Annotations []string `json:"annotations,omitempty"` // DataInputSchema URI of the JSON Schema used to validate the workflow data input // +optional DataInputSchema *cncfmodel.DataInputSchema `json:"dataInputSchema,omitempty"` // Secrets allow you to access sensitive information, such as passwords, OAuth tokens, ssh keys, etc, // inside your Workflow Expressions. // +optional Secrets cncfmodel.Secrets `json:"secrets,omitempty"` // Constants Workflow constants are used to define static, and immutable, data which is available to // Workflow Expressions. // +optional Constants *cncfmodel.Constants `json:"constants,omitempty"` // Defines the workflow default timeout settings. // +optional Timeouts *cncfmodel.Timeouts `json:"timeouts,omitempty"` // Defines checked errors that can be explicitly handled during workflow execution. // +optional Errors cncfmodel.Errors `json:"errors,omitempty"` // If "true", workflow instances is not terminated when there are no active execution paths. // Instance can be terminated with "terminate end definition" or reaching defined "workflowExecTimeout" // +optional KeepActive bool `json:"keepActive,omitempty"` // Metadata custom information shared with the runtime. // +kubebuilder:validation:Schemaless // +kubebuilder:pruning:PreserveUnknownFields // +optional Metadata cncfmodel.Metadata `json:"metadata,omitempty"` // AutoRetries If set to true, actions should automatically be retried on unchecked errors. Default is false // +optional AutoRetries bool `json:"autoRetries,omitempty"` // Auth definitions can be used to define authentication information that should be applied to resources defined // in the operation property of function definitions. It is not used as authentication information for the // function invocation, but just to access the resource containing the function invocation information. // +kubebuilder:validation:Schemaless // +kubebuilder:pruning:PreserveUnknownFields // +optional Auth cncfmodel.Auths `json:"auth,omitempty" validate:"omitempty"` // +kubebuilder:validation:MinItems=1 // +kubebuilder:pruning:PreserveUnknownFields States []cncfmodel.State `json:"states" validate:"required,min=1,dive"` // +optional Events cncfmodel.Events `json:"events,omitempty"` // +optional Functions cncfmodel.Functions `json:"functions,omitempty"` // +optional Retries cncfmodel.Retries `json:"retries,omitempty" validate:"dive"` }
Flow describes the contents of the Workflow definition following the CNCF Serverless Workflow Specification. The attributes not part of the flow are defined by the Custom Resource metadata information, as follows:
- Id, name, and key are replaced by the Custom Resource's name. Must follow the Kubernetes naming patterns (RFC1123).
- Description can be added in the CR's annotation field sonataflow.org/description
- Version is also defined in the CR's annotation, field sonataflow.org/version
- SpecVersion is in the CR's apiVersion, for example v1alpha08 means that it follows the specification version 0.8.
func (*Flow) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Flow.
func (*Flow) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformCluster ¶
type PlatformCluster string
PlatformCluster is the kind of orchestration cluster the platform is installed into +kubebuilder:validation:Enum=kubernetes;openshift
const ( // PlatformClusterOpenShift is used when targeting an OpenShift cluster PlatformClusterOpenShift PlatformCluster = "openshift" // PlatformClusterKubernetes is used when targeting a Kubernetes cluster PlatformClusterKubernetes PlatformCluster = "kubernetes" )
type RegistrySpec ¶
type RegistrySpec struct { // if the container registry is insecure (ie, http only) Insecure bool `json:"insecure,omitempty"` // the URI to access Address string `json:"address,omitempty"` // the secret where credentials are stored Secret string `json:"secret,omitempty"` // the configmap which stores the Certificate Authority CA string `json:"ca,omitempty"` // the registry organization Organization string `json:"organization,omitempty"` }
RegistrySpec provides the configuration for the container registry
func (*RegistrySpec) DeepCopy ¶
func (in *RegistrySpec) DeepCopy() *RegistrySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegistrySpec.
func (*RegistrySpec) DeepCopyInto ¶
func (in *RegistrySpec) DeepCopyInto(out *RegistrySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SonataFlow ¶
type SonataFlow struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SonataFlowSpec `json:"spec,omitempty"` Status SonataFlowStatus `json:"status,omitempty"` }
SonataFlow is the descriptor representation for a workflow application based on the CNCF Serverless Workflow specification. +kubebuilder:object:root=true +kubebuilder:object:generate=true +kubebuilder:subresource:status +kubebuilder:resource:shortName={"sf", "workflow", "workflows"} +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Profile",type=string,JSONPath=`.metadata.annotations.sonataflow\.org\/profile` +kubebuilder:printcolumn:name="Version",type=string,JSONPath=`.metadata.annotations.sonataflow\.org\/version` +kubebuilder:printcolumn:name="URL",type=string,JSONPath=`.status.endpoint` +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=='Running')].status` +kubebuilder:printcolumn:name="Reason",type=string,JSONPath=`.status.conditions[?(@.type=='Running')].reason`
func FromCNCFWorkflow ¶
func FromCNCFWorkflow(cncfWorkflow *cncfmodel.Workflow, context context.Context) (*SonataFlow, error)
FromCNCFWorkflow converts the given CNCF Serverless Workflow instance in a new SonataFlow Custom Resource.
func (*SonataFlow) DeepCopy ¶
func (in *SonataFlow) DeepCopy() *SonataFlow
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlow.
func (*SonataFlow) DeepCopyInto ¶
func (in *SonataFlow) DeepCopyInto(out *SonataFlow)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlow) DeepCopyObject ¶
func (in *SonataFlow) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowBuild ¶
type SonataFlowBuild struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SonataFlowBuildSpec `json:"spec,omitempty"` Status SonataFlowBuildStatus `json:"status,omitempty"` }
SonataFlowBuild is an internal custom resource to control workflow build instances in the target platform +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:object:root=true +kubebuilder:object:generate=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Image",type=string,JSONPath=`.status.imageTag` +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=`.status.buildPhase` +kubebuilder:resource:shortName={"sfb", "sfbuild", "sfbuilds"}
func (*SonataFlowBuild) DeepCopy ¶
func (in *SonataFlowBuild) DeepCopy() *SonataFlowBuild
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowBuild.
func (*SonataFlowBuild) DeepCopyInto ¶
func (in *SonataFlowBuild) DeepCopyInto(out *SonataFlowBuild)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowBuild) DeepCopyObject ¶
func (in *SonataFlowBuild) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowBuildList ¶
type SonataFlowBuildList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []SonataFlowBuild `json:"items"` }
SonataFlowBuildList is the Schema for the sonataflowbuildsList API +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:object:root=true +kubebuilder:object:generate=true
func (*SonataFlowBuildList) DeepCopy ¶
func (in *SonataFlowBuildList) DeepCopy() *SonataFlowBuildList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowBuildList.
func (*SonataFlowBuildList) DeepCopyInto ¶
func (in *SonataFlowBuildList) DeepCopyInto(out *SonataFlowBuildList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowBuildList) DeepCopyObject ¶
func (in *SonataFlowBuildList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowBuildSpec ¶
type SonataFlowBuildSpec struct {
BuildTemplate `json:",inline"`
}
SonataFlowBuildSpec an abstraction over the actual build process performed by the platform.
func (*SonataFlowBuildSpec) DeepCopy ¶
func (in *SonataFlowBuildSpec) DeepCopy() *SonataFlowBuildSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowBuildSpec.
func (*SonataFlowBuildSpec) DeepCopyInto ¶
func (in *SonataFlowBuildSpec) DeepCopyInto(out *SonataFlowBuildSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SonataFlowBuildStatus ¶
type SonataFlowBuildStatus struct { // The final image tag produced by this build instance ImageTag string `json:"imageTag,omitempty"` // Current phase of the build BuildPhase BuildPhase `json:"buildPhase,omitempty"` // Last error found during build Error string `json:"error,omitempty"` // InnerBuild is a reference to an internal build object, which can be anything known only to internal builders. // +kubebuilder:pruning:PreserveUnknownFields InnerBuild runtime.RawExtension `json:"innerBuild,omitempty" patchStrategy:"replace"` }
SonataFlowBuildStatus defines the observed state of SonataFlowBuild
func (*SonataFlowBuildStatus) DeepCopy ¶
func (in *SonataFlowBuildStatus) DeepCopy() *SonataFlowBuildStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowBuildStatus.
func (*SonataFlowBuildStatus) DeepCopyInto ¶
func (in *SonataFlowBuildStatus) DeepCopyInto(out *SonataFlowBuildStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowBuildStatus) GetInnerBuild ¶
func (k *SonataFlowBuildStatus) GetInnerBuild(innerBuild interface{}) error
GetInnerBuild fetch into the given inner build the value from unstructured.
func (*SonataFlowBuildStatus) SetInnerBuild ¶
func (k *SonataFlowBuildStatus) SetInnerBuild(innerBuilder interface{}) error
SetInnerBuild use to define a new object pointer to the inner build.
type SonataFlowList ¶
type SonataFlowList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []SonataFlow `json:"items"` }
SonataFlowList contains a list of SonataFlow +kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*SonataFlowList) DeepCopy ¶
func (in *SonataFlowList) DeepCopy() *SonataFlowList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowList.
func (*SonataFlowList) DeepCopyInto ¶
func (in *SonataFlowList) DeepCopyInto(out *SonataFlowList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowList) DeepCopyObject ¶
func (in *SonataFlowList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowPlatform ¶
type SonataFlowPlatform struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SonataFlowPlatformSpec `json:"spec,omitempty"` Status SonataFlowPlatformStatus `json:"status,omitempty"` }
SonataFlowPlatform is the descriptor for the workflow platform infrastructure. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:object:root=true +kubebuilder:object:generate=true +kubebuilder:subresource:status +kubebuilder:resource:shortName={"sfp", "sfplatform", "sfplatforms"} +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.status.cluster` +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=='Succeed')].status` +kubebuilder:printcolumn:name="Reason",type=string,JSONPath=`.status.conditions[?(@.type=='Succeed')].reason`
func (*SonataFlowPlatform) DeepCopy ¶
func (in *SonataFlowPlatform) DeepCopy() *SonataFlowPlatform
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowPlatform.
func (*SonataFlowPlatform) DeepCopyInto ¶
func (in *SonataFlowPlatform) DeepCopyInto(out *SonataFlowPlatform)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowPlatform) DeepCopyObject ¶
func (in *SonataFlowPlatform) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowPlatformList ¶
type SonataFlowPlatformList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []SonataFlowPlatform `json:"items"` }
SonataFlowPlatformList contains a list of SonataFlowPlatform +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:object:root=true +kubebuilder:object:generate=true
func NewSonataFlowPlatformList ¶
func NewSonataFlowPlatformList() SonataFlowPlatformList
NewSonataFlowPlatformList returns an empty list of Platform objects
func (*SonataFlowPlatformList) DeepCopy ¶
func (in *SonataFlowPlatformList) DeepCopy() *SonataFlowPlatformList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowPlatformList.
func (*SonataFlowPlatformList) DeepCopyInto ¶
func (in *SonataFlowPlatformList) DeepCopyInto(out *SonataFlowPlatformList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowPlatformList) DeepCopyObject ¶
func (in *SonataFlowPlatformList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SonataFlowPlatformSpec ¶
type SonataFlowPlatformSpec struct { // Attributes for building workflows in the target platform Build BuildPlatformSpec `json:"build,omitempty"` // Attributes for running workflows in devmode (immutable, no build required) DevMode DevModePlatformSpec `json:"devMode,omitempty"` }
SonataFlowPlatformSpec defines the desired state of SonataFlowPlatform
func (*SonataFlowPlatformSpec) DeepCopy ¶
func (in *SonataFlowPlatformSpec) DeepCopy() *SonataFlowPlatformSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowPlatformSpec.
func (*SonataFlowPlatformSpec) DeepCopyInto ¶
func (in *SonataFlowPlatformSpec) DeepCopyInto(out *SonataFlowPlatformSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SonataFlowPlatformStatus ¶
type SonataFlowPlatformStatus struct { api.Status `json:",inline"` // Cluster what kind of cluster you're running (ie, plain Kubernetes or OpenShift) Cluster PlatformCluster `json:"cluster,omitempty"` // Version the operator version controlling this Platform Version string `json:"version,omitempty"` // Info generic information related to the build Info map[string]string `json:"info,omitempty"` }
SonataFlowPlatformStatus defines the observed state of SonataFlowPlatform
func (*SonataFlowPlatformStatus) DeepCopy ¶
func (in *SonataFlowPlatformStatus) DeepCopy() *SonataFlowPlatformStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowPlatformStatus.
func (*SonataFlowPlatformStatus) DeepCopyInto ¶
func (in *SonataFlowPlatformStatus) DeepCopyInto(out *SonataFlowPlatformStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowPlatformStatus) GetTopLevelCondition ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) GetTopLevelCondition() *api.Condition
func (*SonataFlowPlatformStatus) GetTopLevelConditionType ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) GetTopLevelConditionType() api.ConditionType
func (*SonataFlowPlatformStatus) IsCreating ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) IsCreating() bool
func (*SonataFlowPlatformStatus) IsDuplicated ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) IsDuplicated() bool
func (*SonataFlowPlatformStatus) IsFailure ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) IsFailure() bool
func (*SonataFlowPlatformStatus) IsReady ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) IsReady() bool
func (*SonataFlowPlatformStatus) IsWarming ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) IsWarming() bool
func (*SonataFlowPlatformStatus) Manager ¶ added in v1.43.0
func (in *SonataFlowPlatformStatus) Manager() api.ConditionsManager
type SonataFlowSpec ¶
type SonataFlowSpec struct { // +kubebuilder:validation:Required Flow Flow `json:"flow"` // Resources workflow resources that are linked to this workflow definition. // For example, a collection of OpenAPI specification files. Resources WorkflowResources `json:"resources,omitempty"` }
SonataFlowSpec defines the desired state of SonataFlow
func (*SonataFlowSpec) DeepCopy ¶
func (in *SonataFlowSpec) DeepCopy() *SonataFlowSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowSpec.
func (*SonataFlowSpec) DeepCopyInto ¶
func (in *SonataFlowSpec) DeepCopyInto(out *SonataFlowSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SonataFlowStatus ¶
type SonataFlowStatus struct { api.Status `json:",inline"` // Address is used as a part of Addressable interface (status.address.url) for knative // +optional Address duckv1.Addressable `json:"address,omitempty"` // keeps track of how many failure recovers a given workflow had so far RecoverFailureAttempts int `json:"recoverFailureAttempts,omitempty"` LastTimeRecoverAttempt metav1.Time `json:"lastTimeRecoverAttempt,omitempty"` // Endpoint is an externally accessible URL of the workflow Endpoint *apis.URL `json:"endpoint,omitempty"` }
SonataFlowStatus defines the observed state of SonataFlow
func (*SonataFlowStatus) DeepCopy ¶
func (in *SonataFlowStatus) DeepCopy() *SonataFlowStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SonataFlowStatus.
func (*SonataFlowStatus) DeepCopyInto ¶
func (in *SonataFlowStatus) DeepCopyInto(out *SonataFlowStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SonataFlowStatus) GetTopLevelCondition ¶
func (s *SonataFlowStatus) GetTopLevelCondition() *api.Condition
func (*SonataFlowStatus) GetTopLevelConditionType ¶
func (s *SonataFlowStatus) GetTopLevelConditionType() api.ConditionType
func (*SonataFlowStatus) IsBuildFailed ¶
func (s *SonataFlowStatus) IsBuildFailed() bool
func (*SonataFlowStatus) IsBuildRunningOrUnknown ¶
func (s *SonataFlowStatus) IsBuildRunningOrUnknown() bool
func (*SonataFlowStatus) IsChildObjectsProblem ¶
func (s *SonataFlowStatus) IsChildObjectsProblem() bool
IsChildObjectsProblem indicates a problem during objects creation during reconciliation For example, a deployment that couldn't be created or a referenced object not found.
func (*SonataFlowStatus) IsReady ¶
func (s *SonataFlowStatus) IsReady() bool
func (*SonataFlowStatus) IsWaitingForBuild ¶
func (s *SonataFlowStatus) IsWaitingForBuild() bool
func (*SonataFlowStatus) IsWaitingForDeployment ¶
func (s *SonataFlowStatus) IsWaitingForDeployment() bool
func (*SonataFlowStatus) IsWaitingForPlatform ¶
func (s *SonataFlowStatus) IsWaitingForPlatform() bool
func (*SonataFlowStatus) Manager ¶
func (s *SonataFlowStatus) Manager() api.ConditionsManager
type WorkflowResources ¶
type WorkflowResources struct {
ConfigMaps []ConfigMapWorkflowResource `json:"configMaps,omitempty"`
}
WorkflowResources collection of local objects holding workflow resources, such as OpenAPI files that will be mounted in the workflow application.
func (*WorkflowResources) DeepCopy ¶
func (in *WorkflowResources) DeepCopy() *WorkflowResources
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowResources.
func (*WorkflowResources) DeepCopyInto ¶
func (in *WorkflowResources) DeepCopyInto(out *WorkflowResources)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.