Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 2.11 KB

entity-onboarding.md

File metadata and controls

40 lines (31 loc) · 2.11 KB
Raw

How to onboard an entity?

Refer to this doc if you're only interested in adding a new aspect to an existing 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.

3. GMA search onboarding

Refer to search onboarding.

4. GMA graph onboarding

Refer to graph onboarding.

5. Add rest.li resource endpoints

See CorpUsers for an example of top-level resource endpoint. Optionally add aspect-specific sub-resource endpoint such as CorpUsersEditableInfoResource.

6. UI for entity onboarding [WIP]