dwarszawski / amundsen-atlas-types

Atlas custom type definitions

⚠️ DEPRECATED

This project has been deprecated and it's contents were migrated to Amundsen core repo.

Any new developments on entity types required for Amundsen <> Atlas integration will be continued in aforementioned repository.

How can I use this after migration?

Install databuilder

pip3 install amundsen-databuilder

Kickstart Amundsen

from apache_atlas.client.base_client import AtlasClient

from databuilder.types.atlas import AtlasEntityInitializer

client = AtlasClient('http://localhost:21000', ('admin', 'admin'))

init = AtlasEntityInitializer(client)

init.create_required_entities()

---

Amundsen Atlas Types

Kickstart your Apache Atlas to support Amundsen using the prebuilt functions and required entity definitions.

Installation:

The package is available on PyPi, which you can install using below.

    pip install amundsenatlastypes

Usage:

Connecting to Apache Atlas:

amundsenatlastypes uses environment variables to connect to Apache Atlas.

Following are the environment variables need to be set in order to connect to Apache Atlas.

- ATLAS_HOST                [default = localhost]
- ATLAS_PORT                [default = 21000]
- ATLAS_USERNAME            [default = admin]
- ATLAS_PASSWORD            [default = admin]

Kickstart Apache Atlas

A single python function is available that you can use to apply all required entity definitions. You can run this function as many times as you want, and it will not break any existing functionality, that means that it can also be implemented in your pipelines.

from amundsenatlastypes import Initializer
    
init = Initializer()
init.create_required_entities()

There also is a functionality to initiate your existing data to work accordingly with Amundsen. To create required relations you need to set fix_existing_data=True while calling the create_required_entities().

from amundsenatlastypes import Initializer
    
init = Initializer()
init.create_required_entities(fix_existing_data=True)

Sample Data

amundsenatlastypes provides sample data so you can populate your Atlas not only with entity definitions but also concrete entities.

Prerequisites

pip install amundsenatlastypes[samples]

Table Sample Data

from amundsenatlastypes.schema.table.sample_data import SampleTableData

table_loader = SampleTableData()
table_loader.create()

Dashboard Sample Data

from amundsenatlastypes.schema.dashboard.sample_data import SampleDashboardData

# Fill below variables with appropriate values
table_guid = ''
user_guid = ''

loader = SampleDashboardData(table_guid, user_guid)

loader.create()

Functionality:

amundsenatlastypes provides a number of functions that can be used separately to implement/apply entity definitions of Apache Atlas, which are available here.

You can also simply access the individual entity definitions in JSON format by importing them from here.

Sample Data

amundsenatlastypes provides sample data so you can populate your Atlas not only with entity definitions but also concrete entities.

amundsen-atlas-types's Issues

"Given typename StatisticsEntry was invalid" when creating types

Steps:

1. Install Apache Atlas release-2.1.0-rc1 by building from source (not sure if it matters).
2. Run the Atlas quick start to create some sample data and types as bin/quick_start.py
3. Install amundsen-atlas-types from source (python3 setup.py install) and run the following from a Python shell:

from amundsenatlastypes import Initializer
  
init = Initializer()
init.create_required_entities(fix_existing_data=True)

4. This logs the following at the start but then is able to create other entities without any error.

Trying to create Column Entity                                            
Already Exists, updating Column Entity
Something wrong happened: HTTP request failed for PUT http://localhost:21000/api/atlas/v2/types/typedefs: Not found 404: {"errorCode":"ATLAS-404-
00-001","errorMessage":"Given typename StatisticsEntry was invalid"}       
Applied Column Entity Definition

Now trying to get the type shows:

$ curl -X GET http://localhost:21000/api/atlas/v2/types/structdef/name/StatisticsEntry -u admin:admin
{"errorCode":"ATLAS-404-00-001","errorMessage":"Given typename StatisticsEntry was invalid"}

Is there something I'm doing wrong or can someone else reproduce this?

Enriching `User` with Amundsen metadata like names, reporting structure

Hi,

We're working on an Atlas + Amundsen deployment on Docker Compose.
We are interested in syncing users from Active Directory to Atlas using the User model that exists on this repo.
I'm however wondering how we can add more attributes to the User, so that we could achieve parity with what the amundsendatabuilder supports for Neo4J.

Does anyone have guidance on what we would need to do?
Thanks

no license file for the repo?

It would be good to have one. thanks. cc @verdan @dwarszawski @mgorsk1

Consider moving the repo to https://github.com/amundsen-io ?

cc @mgorsk1