mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-31 10:39:30 +00:00
d91273a30d
* wip * feat: trigger external apps with override config - Added in openmetadata-airflow-apis functionality to trigger DAG with feature. - Modified openmetadata-airflow-apis application runner to accept override config from params. - Added overloaded runPipeline with `Map<String,Object> config` to allow triggering apps with configuration. We might want to expand this to all ingestion pipelines. For now its just for apps. - Implemented an example external app that can be used to test functionality of external apps. The app can be enabled by setting the `ENABLE_APP_HelloPipelines=true` environment variable. * fix class doc for application * fixed README for airflow apis * fixes * set HelloPipelines to disabeld by default * fixed basedpywright errros * fixed app schema * reduced airflow client runPipeline to an overload with null config removed duplicate call to runPipeline in AppResource * Update openmetadata-docs/content/v1.7.x-SNAPSHOT/developers/applications/index.md Co-authored-by: Matias Puerta <matias@getcollate.io> * deleted documentation file --------- Co-authored-by: Matias Puerta <matias@getcollate.io>
113 lines
3.8 KiB
Python
113 lines
3.8 KiB
Python
# Copyright 2025 Collate
|
|
# Licensed under the Collate Community License, Version 1.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
# https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/LICENSE
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""
|
|
Generic Workflow entrypoint to execute Applications
|
|
"""
|
|
import json
|
|
|
|
from airflow import DAG
|
|
from openmetadata_managed_apis.utils.logger import set_operator_logger
|
|
from openmetadata_managed_apis.workflows.ingestion.common import (
|
|
build_dag,
|
|
build_workflow_config_property,
|
|
execute_workflow,
|
|
)
|
|
|
|
from metadata.generated.schema.entity.applications.configuration.applicationConfig import (
|
|
AppConfig,
|
|
PrivateConfig,
|
|
)
|
|
from metadata.generated.schema.entity.services.ingestionPipelines.ingestionPipeline import (
|
|
IngestionPipeline,
|
|
)
|
|
from metadata.generated.schema.metadataIngestion.application import (
|
|
OpenMetadataApplicationConfig,
|
|
)
|
|
from metadata.generated.schema.metadataIngestion.applicationPipeline import (
|
|
ApplicationPipeline,
|
|
)
|
|
from metadata.workflow.application import ApplicationWorkflow
|
|
|
|
|
|
def application_workflow(workflow_config: OpenMetadataApplicationConfig, **context):
|
|
"""
|
|
Task that creates and runs the ingestion workflow.
|
|
|
|
The workflow_config gets cooked form the incoming
|
|
ingestionPipeline.
|
|
|
|
This is the callable used to create the PythonOperator
|
|
"""
|
|
|
|
set_operator_logger(workflow_config)
|
|
|
|
# set overridden app config
|
|
config = json.loads(
|
|
workflow_config.model_dump_json(exclude_defaults=False, mask_secrets=False)
|
|
)
|
|
params = context.get("params") or {}
|
|
config["appConfig"] = {
|
|
**(config.get("appConfig") or {}),
|
|
**(params.get("appConfigOverride") or {}),
|
|
}
|
|
workflow = ApplicationWorkflow.create(config)
|
|
execute_workflow(workflow, workflow_config)
|
|
|
|
|
|
def build_application_workflow_config(
|
|
ingestion_pipeline: IngestionPipeline,
|
|
) -> OpenMetadataApplicationConfig:
|
|
"""
|
|
Given an airflow_pipeline, prepare the workflow config JSON
|
|
"""
|
|
|
|
# Here we have an application pipeline, so the Source Config is of type ApplicationPipeline
|
|
application_pipeline_conf: ApplicationPipeline = (
|
|
ingestion_pipeline.sourceConfig.config
|
|
)
|
|
|
|
application_workflow_config = OpenMetadataApplicationConfig(
|
|
sourcePythonClass=application_pipeline_conf.sourcePythonClass,
|
|
# We pass the generic class and let each app cast the actual object
|
|
appConfig=AppConfig(
|
|
root=application_pipeline_conf.appConfig.root,
|
|
)
|
|
if application_pipeline_conf.appConfig
|
|
else None,
|
|
appPrivateConfig=PrivateConfig(
|
|
root=application_pipeline_conf.appPrivateConfig.root
|
|
)
|
|
if application_pipeline_conf.appPrivateConfig
|
|
else None,
|
|
workflowConfig=build_workflow_config_property(ingestion_pipeline),
|
|
ingestionPipelineFQN=ingestion_pipeline.fullyQualifiedName.root,
|
|
)
|
|
|
|
return application_workflow_config
|
|
|
|
|
|
def build_application_dag(ingestion_pipeline: IngestionPipeline) -> DAG:
|
|
"""
|
|
Build a simple metadata workflow DAG
|
|
"""
|
|
application_workflow_config = build_application_workflow_config(ingestion_pipeline)
|
|
dag = build_dag(
|
|
task_name="application_task",
|
|
ingestion_pipeline=ingestion_pipeline,
|
|
workflow_config=application_workflow_config,
|
|
workflow_fn=application_workflow,
|
|
params={
|
|
"appConfigOverride": None # Default to None, will be overridden by trigger conf
|
|
},
|
|
)
|
|
|
|
return dag
|