Adding Custom Actions to the Datahub Action Registry: Steps and Guidelines

ingestion
1

Original Slack Thread

<@U06TM7M40RK> Do we need to add custom actions to action registry in order to be discoverable by Datahub actions framework?

2

To make custom actions discoverable by the DataHub Actions framework, you need to ensure that they are properly installed and configured within the Python runtime environment. According to the <https://datahubproject.io/docs/0.13.1/actions/guides/developing-an-action|Developing an Action guide>, here are the steps you should follow:

  1. Define the Custom Action: Extend the Action base class in Python and implement the required methods (create, act, and close).

  2. Install the Custom Action: Make the custom action available in the Python environment. This can be done by placing the Python file in the same directory as your configuration file or by installing it as a package using a setup.py file.

  3. Configure the Action: Create a YAML configuration file that references the custom action using the fully-qualified Python module and class name.

  4. Run the Action: Use the datahub actions command to run the action with the specified configuration file.

There is no explicit mention of an “action registry” in the provided data sources. Instead, the discoverability of the action is achieved by ensuring that the Python module is accessible and correctly referenced in the configuration file.

Would you like more details on any of these steps?

Sources:

3

Hi <@U07GU0BJG4Q>, how did my answer work out for you? Need any more assistance? You can also tag <@U07FV3UHE4D> to let your fellow community members know you’re still looking for guidance.