Cloudera Docs

Configuring the Migration Tool

Learn how to set up and customize the Migration Tool's properties file to ensure the proper operation of the Cloudera Flow Management Migration Tool.

  1. Locate migration.tool.properties configuration file in the conf directory of the Migration Tool root.
  2. Configure the directory paths by updating the following mandatory properties in the configuration file.
    embedded.nifi.v1.nar.directory

    • Specify the read-only directory containing the NAR files associated with the source NiFi version.

    • It can be a lib folder of an actual NiFi instance with a matching version or a different directory containing all NAR artifacts from a given Cloudera distribution. For example: /etc/nifi1/lib

    • Although the Migration Tool does not need a running NiFi instance and does not modify the contents of this directory, it requires read access to these files.

    embedded.nifi.v1.working.directory

    • Designate an empty workspace for the Migration Tool when it is working with the source NiFi version.

    • It should be initially empty and the Migration Tool must have write access to it, allowing the Migration Tool to perform all necessary operations.

    • It must be separate from the source NiFi instance’s working directory and should not be used for any other purposes to avoid potential conflicts.

    • After the migration is complete, it can be cleaned up if needed.

    embedded.nifi.v2.nar.directory

    • Specify the read-only directory containing the NAR files associated with the target NiFi version.

    • It can be a lib folder of an actual NiFi instance with a matching version or a different directory containing the required NAR artifacts.

    • Although the Migration Tool does not need a running NiFi instance and does not modify the contents of this directory, it requires read access to these files.

    embedded.nifi.v2.working.directory

    • Designate an empty workspace for the Migration Tool when it is working with the target NiFi version.

    • It should be initially empty and the Migration Tool must have write access to it, allowing the Migration Tool to perform all necessary operations.

    • It must be separate from the target NiFi instance’s working directory and should not be used for any other purposes to avoid potential conflicts.

    • After the migration is complete, it can be cleaned up if needed.

  3. To configure the sensitive properties, update the following mandatory properties in the configuration file.
    embedded.nifi.sensitive.props.key

    • Provide the nifi.sensitive.props.key from the source NiFi instance for handling sensitive properties.

    • This key is used to decrypt sensitive values during migration and re-encrypt them for the target NiFi instance.

    • During migration, the target NiFi must use the same nifi.sensitive.props.key as the source, as configured in the Migration Tool properties.

    • If the target NiFi requires a different sensitive properties key than the source NiFi, update the value only after completing the migration.

    embedded.nifi.sensitive.props.algorithm

    • Provide the nifi.sensitive.props.algorithm from the source NiFi instance required for handling sensitive properties.

    • This algorithm is used to decrypt sensitive values during migration and re-encrypt them for the target NiFi instance.

    • During migration, the target NiFi must use the same nifi.sensitive.props.algorithm as the source, as configured in the Migration Tool properties.

    • If the target NiFi requires a different sensitive properties algorithm than the source NiFi, update the value only after completing the migration.

  4. Save the modifications of the migration.tool.properties file.