In this section, we provide guides and references to use the DynamoDB connector.
Configure and schedule DynamoDB metadata workflows from the OpenMetadata UI:
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.OpenMetadata 0.12 or later
To deploy OpenMetadata, check the Deployment guides.
The DynamoDB connector ingests metadata using the DynamoDB boto3 client.
OpenMetadata retrieves information about all tables in the AWS account, the user must have permissions to perform the
Below defined policy grants the permissions to list all tables in DynamoDB:
For more information on Dynamodb permissions visit the AWS DynamoDB official documentation.
To run the DynamoDB ingestion, you will need to install:
All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to DynamoDB.
In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.
The workflow is modeled around the following JSON Schema
This is a sample config for DynamoDB:
awsAccessKeyId: Enter your secure access key ID for your DynamoDB connection. The specified key ID should be authorized to read all databases you want to include in the metadata ingestion workflow.
awsSecretAccessKey: Enter the Secret Access Key (the passcode key pair to the key ID from above).
awsSessionToken: The AWS session token is an optional parameter. If you want, enter the details of your temporary session token.
awsRegion: Enter the location of the amazon cluster that your data and account are associated with.
endPointURL: Your DynamoDB connector will automatically determine the AWS DynamoDB endpoint URL based on the region. You may override this behavior by entering a value to the endpoint URL.
databaseName: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
sourceConfig is defined here:
markDeletedTables: To flag tables as soft-deleted if they are not present anymore in the source system.
includeTables: true or false, to ingest table data. Default is true.
includeViews: true or false, to ingest views definitions.
databaseFilterPattern, schemaFilterPattern, tableFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here
To send the metadata to OpenMetadata, it needs to be specified as
The main property here is the
openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.
You can specify the
loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with
DEBUG will give you far more traces for identifying issues.
JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.
You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.
If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set
ignore, or have it as
validate, which will require you to set the
sslConfig.certificatePath with a local path where your ingestion runs that points to the server certificate file.
Find more information on how to troubleshoot SSL issues here.
Connection Options (Optional): Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
- In case you are using Single-Sign-On (SSO) for authentication, add the
authenticatordetails in the Connection Arguments as a Key-Value pair as follows:
"authenticator" : "sso_login_url"
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.