Configuring the Migration Tool

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.

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.

The Migration Tool requires access to a Working Registry, which serves as storage for migrated snapshots. This registry must be installed and running separately.

To enable this, configure the following properties in the migration.tool.properties file:

registry.working.url

Specify the location of the Working Registry. This is equivalent to configuring a NiFi Registry Client.

If the Working Registry is secured (which is the recommended approach), authentication information must be provided, similar to configuring a StandardSSLContextService for a NiFi Registry Client. The required properties correspond to those of the StandardSSLContextService with matching names:

registry.working.ssl.keystore.file
registry.working.ssl.keystore.password
registry.working.ssl.keystore.type
registry.working.ssl.truststore.file
registry.working.ssl.truststore.password
registry.working.ssl.truststore.type
registry.working.ssl.key.password
registry.working.ssl.protocol

The only exception is registry.working.timeout.

registry.working.timeout

Specify the timeout (in milliseconds) for communication with the Working Registry, including both connection and read operations.

The default value is 300. If connection issues occur between the Migration Tool and the Working Registry, this value may need to be increased.

For the end-to-end workflow, see Migrating flows versioned with NiFi Registry [Technical Preview].