2019-12-19 13:17:53 -08:00
|
|
|
# How to onboard an entity?
|
|
|
|
|
|
2019-12-20 02:36:24 -08:00
|
|
|
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](../what/urn.md) for URN definition.
|
|
|
|
|
|
|
|
|
|
## 2. Model your metadata
|
|
|
|
|
Refer to [metadata modelling](metadata-modelling.md) 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](search-onboarding.md).
|
|
|
|
|
|
|
|
|
|
## 4. GMA graph onboarding
|
|
|
|
|
Refer to [graph onboarding](graph-onboarding.md).
|
|
|
|
|
|
|
|
|
|
## 5. UI for entity onboarding [WIP]
|
|
|
|
|
|
|
|
|
|
[Aspect]: ../what/aspect.md
|
|
|
|
|
[DatasetAspect]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/aspect/DatasetAspect.pdsc
|
|
|
|
|
[Snapshot]: ../what/snapshot.md
|
|
|
|
|
[DatasetSnapshot]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/snapshot/DatasetSnapshot.pdsc
|
|
|
|
|
[Snapshot Union]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/snapshot/Snapshot.pdsc
|
|
|
|
|
[Entity]: ../what/entity.md
|
|
|
|
|
[DatasetEntity]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/entity/DatasetEntity.pdsc
|
