Skip to main content
This section provides guides and references for the Rill connector. Configure and run the Rill metadata workflow externally:

​
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 Rill connector reads metadata from a Rill runtime over its representational state transfer (REST) application programming interface (API). It works with both deployment styles:
  • Rill Developer: a local or self-hosted Rill runtime. Set hostPort to the runtime URL (for example, http://localhost:9009). A token is optional.
  • Rill Cloud: a hosted project. Set hostPort to the project endpoint (for example, https://api.rilldata.com/v1/orgs/<org>/projects/<project>) and provide a token.
The connector doesn’t support Rill Cloud branch-level routing yet. If your project URL includes a /branch/<name> segment, remove it before configuring the connection. The token must have read access to the project’s resources. OpenMetadata uses that access to list dashboards, charts, and data models.

​
Python Requirements

Use a Python version supported by the openmetadata-ingestion package that matches your OpenMetadata server. To find the supported range for your release, check the Requires-Python metadata of that release’s ingestion package. To run the Rill ingestion, install:

​
Metadata Ingestion

All connectors are defined as JSON Schemas. See the Rill connection JSON Schema for the structure of a Rill connection. To create and run a metadata ingestion workflow, create a YAML configuration that connects to the source, processes entities if needed, and sends the metadata to the OpenMetadata server. The workflow is modeled around the following JSON Schema

​
1. Define the YAML Config

This is a sample config for Rill:

​
2. Run with the CLI

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.