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.
1. Visit the Services Page
The first step is ingesting the metadata from your sources. Under Settings you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.
To visit the Services page, select Services from the Settings menu.
Navigate to Settings >> Services
2. Create a New Service
Click on the Add New Service button to start the Service creation.
Add a New Service from the Database Services Page
3. Select the Service Type
Select ClickHouse as the service type and click Next.
Provide a name and description for your service as illustrated below.
OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other ClickHouse services that you might be ingesting metadata from.
5. Configure the Service Connection
In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your ClickHouse service as desired.
6. Configure the Metadata Ingestion
Once the service is created, we can add a Metadata Ingestion Workflow, either directly from the Add Ingestion button in the figure above, or from the Service page:
Metadata Ingestion Options
7. Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.
Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.
If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.
After configuring the workflow, you can click on Deploy to create the pipeline.
Schedule the Ingestion Pipeline and Deploy
8. View the Ingestion Pipeline
Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.
9. Workflow Deployment Error
If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.
You can then edit the Ingestion Pipeline and Deploy it again.
Edit and Deploy the Ingestion Pipeline
From the Connection tab, you can also Edit the Service if needed.
Query Usage and Lineage Ingestion
You can learn more about how to configure the Usage Workflow to ingest Query and Lineage information from the UI below: