Glue (via Collector method) - v3.0.0

About Collectors

Pre-requisites

Collector Server Minimum Requirements

Glue Requirements

• Access to Glue

Step 1: Establish Glue Access

It is advised you create a new Role for the service user provided to KADA and have a policy that allows the below, see Identity and access management in Glue - Amazon Glue

The service user/account/role will require permissions to the following

1. Ability to GET and LIST s3 resources that you want the user to have access to if required.

2. Call the following Glue APIs

   1. get_tables

   2. get_databases

Example Role Policy to allow Glue Access with least privileges for actions. Note the YOUR-REGION and AWS-ACCOUNT-ID.

Note this is a Cloudformation Template and is a YAML not JSON file

AWSTemplateFormatVersion: "2010-09-09"
Description: 'AWS IAM Role - Glue Access to KADA'
Resources: 
  KadaGlueRole: 
    Type: "AWS::IAM::Role"
    Properties: 
      RoleName: "KadaGlueRole"
      MaxSessionDuration: 43200
      Path: "/"
      AssumeRolePolicyDocument: 
        Version: "2012-10-17"
        Statement: 
        - Effect: "Allow"
          Principal:
            AWS: "[ACCOUNT ARN]"
          Action: "sts:AssumeRole"

  KadaGluePolicy: 
    Type: 'AWS::IAM::Policy'
    Properties:
      PolicyName: root
      PolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: Allow
            Action: 
              - glue:GetTables
              - glue:GetDatabases
            Resource:
              - 'arn:aws:glue:YOUR-REGION:AWS-ACCOUNT-ID:catalog'
              - 'arn:aws:glue:your-region:your-account-id:database/*'
              - 'arn:aws:glue:YOUR-REGION:AWS-ACCOUNT-ID:table/*/*'
      Roles:
        - !Ref KadaGlueRole

Alternatively you may wish to just create the Policy using this example JSON

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "KadaGluePolicy",
            "Effect": "Allow",
            "Action": [
                "glue:GetDatabases",
                "glue:GetTables"
            ],
            "Resource": [
                "arn:aws:glue:YOUR-REGION:AWS-ACCOUNT-ID:catalog",
                "arn:aws:glue:YOUR-REGION:AWS-ACCOUNT-ID:database/*",
                "arn:aws:glue:YOUR-REGION:AWS-ACCOUNT-ID:table/*/*"
            ]
        }
    ]
}

Step 1 Optional: Creating Glue Crawlers over S3

See https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html for more details.

You may also wish to set up a crawler over your s3 data to ingest into Glue.

1. The crawler will need an IAM role with the direct policies attached

   1. AWSGlueServiceRole

   2. AWSS3FullAccessRole

2. Create a Database in the Glue Console

   1. In the left navigation pane, choose "Databases"

   2. Click "Add database" and provide a name for the database

3. Create a s3 Crawler

   1. In the left navigation pane, choose "Crawlers"

   2. Click "Add crawler" and provide a name for the crawler

   3. Choose "Data stores" and select "S3" as the data store type

   4. Specify the S3 path to the bucket you want to crawl

   5. Choose "Next" and select the IAM role you created earlier

   6. Choose "Next" and select the Database created in Step 2.

   7. Configure other settings like frequency etc.

   8. Choose "Next" to review settings then "Finish"

4. Run the Crawler

   1. Select the Crawler you created and click "Run Crawler" and wait for completion

Step 2: Create the Source in K

Create an Athena source in K

• Go to Settings, Select Sources and click Add Source

• Select "Load from File system" option

• Give the source a Name - e.g. Glue Production

• Add the Host name for the Athena Server, recommended to use the convention [AWS ACCOUNT ID]_glue e.g. 3255667_glue

• Click Finish Setup

Step 3: Getting Access to the Source Landing Directory

Step 4: Install the Collector

You can download the Latest Core Library and Athena whl via Platform Settings → Sources → Download Collectors

Run the following command to install the collector

pip install kada_collectors_extractors_<version>-none-any.whl

You will also need to install the common library kada_collectors_lib for this collector to function properly.

pip install kada_collectors_lib-<version>-none-any.whl

Under the covers this uses boto3 and may have OS dependencies see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html

Step 5: Configure the Collector

kada_glue_extractor_config.json

{
    "key": "",
    "secret": "",
    "server": "43234234_glue",
    "regions": ["ap-southeast-2"],
    "catalogId": "43234234",
    "role": "",
    "output_path": "/tmp/output",
    "mask": true,
    "compress": true,
    "meta_only": true
}

Step 6: Run the Collector

This is the wrapper script: kada_glue_extractor.py

import os
import argparse
from kada_collectors.extractors.utils import load_config, get_hwm, publish_hwm, get_generic_logger
from kada_collectors.extractors.glue import Extractor

get_generic_logger('root')

_type = 'glue'
dirname = os.path.dirname(__file__)
filename = os.path.join(dirname, 'kada_{}_extractor_config.json'.format(_type))

parser = argparse.ArgumentParser(description='KADA Glue Extractor.')
parser.add_argument('--config', '-c', dest='config', default=filename)
parser.add_argument('--name', '-n', dest='name', default=_type)
args = parser.parse_args()

start_hwm, end_hwm = get_hwm(args.name)

ext = Extractor(**load_config(args.config))
ext.test_connection()
ext.run(**{"start_hwm": start_hwm, "end_hwm": end_hwm})

publish_hwm(args.name, end_hwm)

Step 7: Check the Collector Outputs

K Extracts

A set of files (eg metadata, databaselog, linkages, events etc) will be generated in the output_path directory.

High Water Mark File

A high water mark file is created called glue_hwm.txt.

Step 8: Push the Extracts to K

Once the files have been validated, you can push the files to the K landing directory.

Example: Using Airflow to orchestrate the Extract and Push to K