Control-M for Airflow Plug-in Migration Tool
The Control-M for Airflow Plug-in Migration Tool converts the Control-M for Airflow plug-in to the following Application Integrator based plug-ins:
-
Control-M for Apache Airflow
-
Control-M for GCP Composer
Migrating Control-M for Airflow to Control-M for Apache Airflow or Control-M for GCP ComposerLink copied to clipboard
This procedure describes how to migrate the Control-M for Airflow plug-in to either the Control-M for Apache Airflow or Control-M for GCP Composer plug-in.
Before You Begin
Install Control-M for Apache Airflow or Control-M for GCP Composer and create a connection profile.
Begin
-
In Control-M SaaS, from the Configuration domain, click the orange drop-down arrow button and select Plug-ins.
-
Click Install Plug-in.
-
Select Airflow.
-
In the textual instructions on the right, click Download the Control-M for Airflow Plug-in Migration Tool.
-
Export the workspace with Control-M for Airflow jobs to a JSON file, as described in Exporting a Workspace.
-
Edit the configuration file with the following steps:
-
Navigate to the Control-M Migration Tool for Integrations directory that you downloaded.
-
Open the migration_configuration_file.json in a text editor.
-
Add the job type, connection profiles, and hosts that you want to convert. See Configuration File Parameters.
-
-
Do one of the following to run the migration tool:
-
Windows: Run the following command:
plugins_migration_tool.exe -i <Exported_Workspace_Pathname> -c <Migration_Configuration_File_Pathname> -o <Output_File_Pathname>
For more information, see Control-M Migration Tool Parameters.
-
UNIX: Do the following:
-
Run the following command to ensure the migration tool has execution permissions:
chmod +x plugins_migration_tool
-
Run the following command:
./plugins_migration_tool -i <Exported_Workspace_Pathname> -c <Migration_Configuration_File_Pathname> -o <Output_File_Pathname>
For more information, see Control-M Migration Tool Parameters.
-
-
-
Import the output file with the updated job definitions, as described in Importing a Workspace.
Configuration File ParametersLink copied to clipboard
Control-M Migration Tool for Integrations contains the migration_configuration_file.json file that instructs the Control-M Migration Tool how to handle the different job types in the exported JSON file.
You must edit the configuration file with the job type, connection profiles, and hosts that you want to convert. The Control-M Migration Tool only converts the job types, connection profiles, or hosts that you define in the configuration file.
The following example shows a configuration file to migrate the original Control-M for Airflow to Control-M for Apache Airflow:
[
{
"Type": "Job:Airflow",
"SubType": "Airflow",
"ConnectionProfile": "{Airflow1:ApacheAirflow1},{Airflow2:ApacheAirflow2}",
"Host": "{Airflow_Agent1:ApacheAirflow_Agent1},{Airflow_Agent2:ApacheAirflow_Agent2}"
}
]
The following example shows a configuration file to migrate the original Control-M for Airflow to Control-M for GCP Composer:
[
{
"Type": "Job:Airflow",
"SubType": "Composer",
"ConnectionProfile": "{Airflow1:GCPComposer1},{Airflow2:GCPComposer2}",
"Host": "{Airflow_Agent1:GCPComposer_Agent1},{Airflow_Agent2:GCPComposer_Agent2}"
}
]
The following table describes the migration_configuration_file.json file parameters.
Parameter |
Description |
---|---|
Type |
Determines the Control-M for Airflow job type to convert. |
SubType |
Determines whether this connection profile is connected to the one of the following:
|
ConnectionProfile |
Maps the connection profiles of the original Control-M for Airflow plug-in to the connection profiles of the Control-M for Apache Airflow or Control-M for GCP Composer Application Integrator-based plug-in. The following examples maps the Control-M for Airflow plug-in to the relevant connection profiles:
You can include an asterisk (*) as a wildcard. "{*:ApacheAirflow}" instructs the tool to convert all connection profiles listed in the exported JSON file to an Apache Airflow connection profile. "{*:GCPComposer}" instructs the tool to convert all connection profiles listed in the exported JSON file to a GCP Composer connection profile. |
Host |
Maps the Agents associated with the Control-M for Airflow plug-in to the Agents associated with the Control-M for Apache Airflow or Control-M for GCP Composer Application-Integrator-based plug-in. The following examples maps the Control-M for Airflow plug-in to the relevant hosts:
You can include an asterisk (*) as a wildcard. "{*:ApacheAirflow_Agent_1}" instructs the tool to convert all Agents listed in the exported JSON file to an Agent associated with the Control-M for Apache Airflow plug-in. "{*:GCPComposer_Agent_1}" instructs the tool to convert all Agents listed in the exported JSON file to an Agent associated with the Control-M for GCP Composer plug-in. |
Control-M Migration Tool ParametersLink copied to clipboard
The following table describes the migration tool parameters.
Parameter |
Description |
---|---|
-i |
Defines the input file pathname. The input file is the exported workspace in JSON format. |
-c |
Defines the configuration file that instructs the Control-M Migration Tool how to handle the different job types in the input file. The migration_configuration_file.json file is downloaded with the Control-M Migration Tool. |
-o |
(Optional) Defines the path to the file with the converted job definitions. If you do not specify an output file, the Control-M Migration Tool creates the migration_output_file.json file as a default output file. |