Create a plugin

Owned by Jay Jin
Last updated: Aug 12, 2020 by Robin Rielley
1 min read

This page is a step-by-step guide on developing a new plugin for CDAP. At the end, the user should have deployed the new plugin onto CDAP and created a pipeline using it.

Doing a task

  1. In your command line, run the command below to set up a project.

mvn archetype:generate -DarchetypeGroupId=io.cdap.cdap -DarchetypeArtifactId=cdap-data-pipeline-plugins-archetype -DarchetypeVersion=6.0.0 -DgroupId=org.example.plugin

Alternatively, you can git clone the Hydrator repo.

2. Write the plugin of your choice. Be sure to implement the methods found here. For examples of plugins already written, check out the Hydrator repo.

3. Build the plugin: mvn clean package.

4. Upload the plugin jar and json to CDF. To do this, click the green circle and then select upload plugin. Then select both the jar and json created.

5. Your plugin should now be available to use! Click create pipeline and use the plugin how you desire.

Related articles

For more information related to developing pipelines for CDAP, please see here.