Skip to main content
Iceberg

Iceberg

BETA
In this section, we provide guides and references to use the Iceberg connector. Configure and schedule Iceberg metadata from the OpenMetadata UI:

​
How to Run the Connector Externally

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.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

The requirements actually depend on the Catalog and the FileSystem used. In a nutshell, the used credentials must have access to reading the Catalog and the Metadata File.

​
Glue Catalog

Must have glue:GetDatabases, and glue:GetTables permissions to be able to read the Catalog. Must also have the s3:GetObject permission for the location of the Iceberg tables.

​
DynamoDB Catalog

Must have dynamodb:DescribeTable and dynamodb:GetItem permissions on the Iceberg Catalog table. Must also have the s3:GetObject permission for the location of the Iceberg tables.

​
Hive / REST Catalog

It depends on where and how the Hive / Rest Catalog is setup and where the Iceberg files are stored.

​
Python Requirements

We have support for Python versions 3.9-3.11
To run the Iceberg ingestion, you will need to install: 
pip3 install "openmetadata-ingestion[iceberg]"

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Iceberg. 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

​
1. Define the YAML Config

​
This is a sample config for Iceberg using a Glue Catalog:

​
This is a sample config for Iceberg using a DynamoDB Catalog:

​
This is a sample config for Iceberg using a Hive Catalog:

​
This is a sample config for Iceberg using a REST Catalog:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
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.

​
Securing Rest Catalog Connection with SSL in OpenMetadata

When using SSL to establish secure connections between OpenMetadata and Rest Catalog, you can specify the caCertificate to provide the CA certificate used for SSL validation. Alternatively, if both client and server require mutual authentication, you’ll need to use all three parameters: ssl_key, ssl_cert, and ssl_ca. In this case, ssl_cert is used for the client’s SSL certificate, ssl_key for the private key associated with the SSL certificate, and ssl_ca for the CA certificate to validate the server’s certificate. 
      ssl:
            caCertPath: ./ca_cert.pem
            clientCertPath: ./client_cert.crt
            privateKeyPath: ./private.key