OpenMetadata/openmetadata-docs/content/v1.6.x/connectors/pipeline/airbyte/yaml.md

title	slug
Run the Airbyte Connector Externally	/connectors/pipeline/airbyte/yaml

{% connectorDetailsHeader name="Airbyte" stage="PROD" platform="OpenMetadata" availableFeatures=["Pipelines", "Pipeline Status", "Lineage"] unavailableFeatures=["Owners", "Tags"] / %}

In this section, we provide guides and references to use the Airbyte connector.

Configure and schedule Airbyte metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}

Requirements

Python Requirements

{% partial file="/v1.6/connectors/python-requirements.md" /%}

To run the Airbyte ingestion, you will need to install:

pip3 install "openmetadata-ingestion[airbyte]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Airbyte.

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 Airbyte:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

hostPort: Pipeline Service Management UI URL

{% /codeInfo %}

{% codeInfo srNumber=2 %}

username: Username to connect to Airbyte.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

password: Password to connect to Airbyte.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

apiVersion: Version of the Airbyte REST API by default api/v1.

{% /codeInfo %}

{% partial file="/v1.6/connectors/yaml/pipeline/source-config-def.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: airbyte
  serviceName: airbyte_source
  serviceConnection:
    config:
      type: Airbyte

      hostPort: http://localhost:8000

      username: <username>

      password: <password>

      apiVersion: api/v1

{% partial file="/v1.6/connectors/yaml/pipeline/source-config.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}

{% /codeBlock %}

{% /codePreview %}

{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}