Dataflow CRD

API Reference

Packages:

bytewax.io/v1alpha1

Resource Types:

Dataflow

↩ Parent

Dataflow is the Schema for the dataflows API

Name Type Description Required
apiVersion string bytewax.io/v1alpha1 true
kind string Dataflow true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object DataflowSpec defines the desired state of Dataflow
false
status object DataflowStatus defines the observed state of Dataflow
false

Dataflow.spec

↩ Parent

DataflowSpec defines the desired state of Dataflow

Name Type Description Required
image object
true
pythonFileName string
true
chartValues string
false
configMapName string
false
env []object
false
jobMode boolean

Default: false
false
keepAlive boolean

Default: false
false
processesCount integer

Default: 1
false
recovery object
false
tarName string
false
workersPerProcess integer

Default: 1
false

Dataflow.spec.image

↩ Parent

Name Type Description Required
tag string
true
pullPolicy string

Default: Always
false
pullSecret string

Default: default-credentials
false
repository string
false

Dataflow.spec.env[index]

↩ Parent

Name Type Description Required
name string
true
value string
true

Dataflow.spec.recovery

↩ Parent

Name Type Description Required
cloudBackup object
false
enabled boolean

Default: false
false
partsCount integer

Default: 1
false
persistence object
false
singleVolume boolean

Default: false
false

Dataflow.spec.recovery.cloudBackup

↩ Parent

Name Type Description Required
enabled boolean

Default: false
false
s3 object
false

Dataflow.spec.recovery.cloudBackup.s3

↩ Parent

Name Type Description Required
url string
true
accessKeyId string
false
secretAccessKey string
false
secretName string
false

Dataflow.spec.recovery.persistence

↩ Parent

Name Type Description Required
size string

Default: 10Gi
false
storageClassName string
false

Dataflow.status

↩ Parent

DataflowStatus defines the observed state of Dataflow

Name Type Description Required
conditions []object INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file
false

Dataflow.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status enum status of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
type string type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
Minimum: 0
false