entity-onboarding.md

How to onboard an entity?

Currently, DataHub only has a support for 3 entity types: datasets, users and groups. If you want to extend DataHub with your own use cases such as metrics, charts, dashboards etc, you should follow the below steps in order.

1. Define URN

Refer to here for URN definition.

2. Model your metadata

Refer to metadata modelling section. Make sure to do the following:

1. Define Aspect models.
2. Define aspect union model. Refer to DatasetAspect as an example.
3. Define Snapshot model. Refer to DatasetSnapshot as an example.
4. Add your newly defined snapshot to Snapshot Union model.
5. Define Entity model. Refer to DatasetEntity as an example.

3. GMA search onboarding

Refer to search onboarding.

4. GMA graph onboarding

Refer to graph onboarding.

5. UI for entity onboarding [WIP]