[ATLAS-3924] Add documentation for Hive Metastore hook

• Type: Improvement
• Status: Open
• Priority: Blocker
• Resolution: Unresolved
• Affects Version/s: 2.1.0
• Component/s: atlas-core
• Assignee: Unassigned
• Reporter: Mihail Yonchev
• Created: 19/Aug/20 12:47
• Updated: 19/Aug/20 12:51

Description

Atlas Metastore Hook have been implemented after issue ATLAS-3148 requested a new feature to create a hook to be registered as post-listener (hive.metastore.event.listeners) and DDL operations to be captured and send to atlas kafka topic for processing by Atlas server. 

The implementation has been done and merged to master, however no documentation or information on how the hook can be used is present at https://atlas.apache.org/#/HookHive . This makes the usage of the hook highly inefficient as it may require to go through the code of the hook, which may result in a big loss of time bearing in mind that lots of dependencies are present in the code too. 

This Jira will create a paragraph about the Hive Metastore Hook listener at https://atlas.apache.org/#/HookHive which explains its purpose, configuration ( such as where the atlas-application.properties files is expected ) and usage.