Deploying a ReadyFlow

Learn how to use the Deployment wizard to deploy a ReadyFlow using the information you collected using the prerequisites check list.

The CDF Catalog is where you manage the flow definition lifecycle, from initial import, to versioning, to deploying a flow definition.

  1. In DataFlow, from the left navigation pane, select Catalog.
    Flow definitions available for you to deploy are displayed, one definition per row.
  2. Launch the Deployment wizard.
    1. Click the row to display the flow definition details and versions.
    2. Click a row representing a flow definition version to display flow definition version details and the Deploy button.
    3. Click Deploy to launch the Deployment wizard.
  3. From the Deployment wizard, select the environment to which you want to deploy this version of your flow definition.
  4. From Overview, perform the following tasks:
    1. Give your flow a unique Deployment Name.
      You can use this name to distinguish between different versions of a flow definition, flow definitions deployed to different environments, and similar.
    2. Select a Target Project for your flow deployment from the list of Projects available to you.
      • If you do not want to assign the deployment to any of the available Projects, select Unassigned. Unassigned deployments are accessible to every user with DFFlowUser role for the environment.
      • This field is automatically populated if you import a configuration and the Project referenced there exists in your environment and you have access to it.
    3. If you have previously exported a deployment configuration that closely aligns with the one you are about to deploy, you can import it under Import Configuration to auto-fill as much of the wizard as possible.
      You can still modify auto-filled configuration values manually during deployment.
  5. Specify NiFi Configuration information.
    1. Pick the NiFi Runtime Version for your flow deployment.
      Cloudera recommends that you always use the latest available version, if possible.
    2. Specify whether you want to use Inbound Connections that allow your flow deployment receiving data from an external data source.

      If yes, specify the endpoint host name and listening port(s) where your flow deployment listens to incoming data.

      See Creating an inbound connection endpoint for complete information on endpoint configuration options.

    3. Specify whether you want to use NiFi Archives (NAR) to deploy custom NiFi processors or controller services.
      If yes, specify the CDP Workload Username and password, and cloud storage location you used when preparing to deploy custom processors.
    4. Specify whether you want the flow deployment to auto-start once deployed.
  6. In Parameters, specify parameter values like connection strings, usernames and similar, and upload files like truststores, jars, and similar.
  7. Specify your Sizing & Scaling configurations.
    NiFi node sizing
    • You can adjust the size of your cluster between Extra Small, Small, Medium, and Large.
    Number of NiFi nodes
    • You can set whether you want to automatically scale your cluster according to flow deployment capacity requirements. When you enable auto-scaling, the minimum NiFi nodes are used for initial size and the workload scales up or down depending on resource demands.
    • You can set the number of nodes from 1 to 32.
    • You can set whether you want to enable Flow Metrics Scaling.
    Storage Selection
    You can select whether you want your deployment to use storage optimized for cost or performance.
  8. From KPIs, you may choose to identify key performance indicators (KPIs), the metrics to track those KPIs, and when and how to receive alerts about the KPI metrics tracking.

    See Working with KPIs for complete information about the KPIs available to you and how to monitor them.

  9. Review a summary of the information provided and make any necessary edits by clicking Previous. When you are finished, complete your flow deployment by clicking Deploy.

Once you click Deploy, you are being redirected to the Alerts tab in the detail view for the deployment where you can track its progress.