Version: v0.6.1

NiFi Dataflow

NifiDataflow is the Schema for the NiFi dataflow API.

apiVersion: nifi.orange.com/v1alpha1
kind: NifiDataflow
metadata:
name: dataflow-lifecycle
spec:
parentProcessGroupID: "16cfd2ec-0174-1000-0000-00004b9b35cc"
bucketId: "01ced6cc-0378-4893-9403-f6c70d080d4f"
flowId: "9b2fb465-fb45-49e7-94fe-45b16b642ac9"
flowVersion: 2
runOnce: false
skipInvalidControllerService: true
skipInvalidComponent: true
clusterRef:
name: nc
namespace: nifikop
registryClientRef:
name: squidflow
namespace: nifikop
parameterContextRef:
name: dataflow-lifecycle
namespace: nifikop
updateStrategy: drain

NifiDataflow

FieldTypeDescriptionRequiredDefault
metadataObjectMetadatais metadata that all persisted resources must have, which includes all objects dataflows must create.Nonil
specNifiDataflowSpecdefines the desired state of NifiDataflow.Nonil
statusNifiDataflowStatusdefines the observed state of NifiDataflow.Nonil

NifiDataflowsSpec

FieldTypeDescriptionRequiredDefault
parentProcessGroupIDstringthe UUID of the parent process group where you want to deploy your dataflow, if not set deploy at root level.No-
bucketIdstringthe UUID of the Bucket containing the flow.Yes-
flowIdstringthe UUID of the flow to run.Yes-
flowVersion*int32the version of the flow to run, if not present or equals to -1, then the latest version of flow will be used.Yes-
runOnceboolif the flow will be ran once or continuously checked.Yestrue
skipInvalidControllerServiceboolwhether the flow is considered as ran if some controller services are still invalid or not.Yesfalse
skipInvalidComponentboolwhether the flow is considered as ran if some components are still invalid or not.Yesfalse
updateStrategyDataflowUpdateStrategydescribes the way the operator will deal with data when a dataflow will be updated : Drop or DrainYesdrain
clusterRefClusterReferencecontains the reference to the NifiCluster with the one the user is linked.Yes-
parameterContextRefParameterContextReferencecontains the reference to the ParameterContext with the one the dataflow is linked.No-
clusterRefRegistryClientReferencecontains the reference to the NifiRegistry with the one the dataflow is linked.Yes-

NifiDataflowStatus

FieldTypeDescriptionRequiredDefault
processGroupIDstringprocess Group ID.Yes-
stateDataflowState)the dataflow current state.Yes-
latestUpdateRequestUpdateRequestthe latest update request sent.Yes-
latestDropRequestDropRequestthe latest queue drop request sent.Yes-

DataflowUpdateStrategy

NameValueDescription
DrainStrategydrainleads to shutting down only input components (Input processors, remote input process group) and dropping all flowfiles from the flow.
DropStrategydropleads to shutting down all components and dropping all flowfiles from the flow.

DataflowState

NameValueDescription
DataflowStateCreatedCreateddescribes the status of a NifiDataflow as created.
DataflowStateStartingStartingdescribes the status of a NifiDataflow as starting.
DataflowStateRanRandescribes the status of a NifiDataflow as running.
DataflowStateOutOfSyncOutOfSyncddescribes the status of a NifiDataflow as out of sync.
DataflowStateInSyncInSyncdescribes the status of a NifiDataflow as in sync.

UpdateRequest

FieldTypeDescriptionRequiredDefault
typeDataflowUpdateRequestTypedefines the type of versioned flow update request.Yes-
idstringthe id of the update request.Yes-
uristringthe uri for this request.Yes-
lastUpdatedstringthe last time this request was updated.Yes-
completeboolwhether or not this request has completed.Yesfalse
failureReasonstringan explication of why the request failed, or null if this request has not failed.Yes-
percentCompletedint32the percentage complete of the request, between 0 and 100.Yes0
statestringthe state of the request.Yes-

DropRequest

FieldTypeDescriptionRequiredDefault
connectionIdstringthe connection id.Yes-
idstringthe id for this drop request.Yes-
uristringthe uri for this request.Yes-
lastUpdatedstringthe last time this request was updated.Yes-
finishedboolwhether the request has finished.Yesfalse
failureReasonstringan explication of why the request failed, or null if this request has not failed.Yes-
percentCompletedint32the percentage complete of the request, between 0 and 100.Yes0
currentCountint32the number of flow files currently queued.Yes0
currentSizeint64the size of flow files currently queued in bytes.Yes0
currentstringthe count and size of flow files currently queued.Yes-
originalCountint32the number of flow files to be dropped as a result of this request.Yes0
originalSizeint64the size of flow files to be dropped as a result of this request in bytes.Yes0
originalstringthe count and size of flow files to be dropped as a result of this request.Yes-
droppedCountint32the number of flow files that have been dropped thus far.Yes0
droppedSizeint64the size of flow files currently queued in bytes.Yes0
Droppedstringthe count and size of flow files that have been dropped thus far.Yes-
statestringthe state of the request.Yes-

DataflowUpdateRequestType

NameValueDescription
RevertRequestTypeRevertdefines a revert changes request.
UpdateRequestTypeUpdatedefines an update version request.
Last updated on by Alexandre Guitton