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

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

Configure and schedule NiFi metadata workflows from the OpenMetadata UI:

- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Troubleshooting](/connectors/pipeline/nifi/troubleshooting)

{% partial file="/v1.10/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/nifi/yaml"} /%}

## Requirements

### Metadata
OpenMetadata supports 2 types of connection for the NiFi connector:
- **basic authentication**: use username/password to authenticate to NiFi. 
- **client certificate authentication**: use CA, client certificate and client key files to authenticate.

The user should be able to send request to the NiFi API and access the `Resources` endpoint.

## Metadata Ingestion

{% partial 
  file="/v1.10/connectors/metadata-ingestion-ui.md" 
  variables={
    connector: "Nifi", 
    selectServicePath: "/images/v1.10/connectors/nifi/select-service.png",
    addNewServicePath: "/images/v1.10/connectors/nifi/add-new-service.png",
    serviceConnectionPath: "/images/v1.10/connectors/nifi/service-connection.png",
} 
/%}

{% stepsContainer %}
{% extraContent parentTagName="stepsContainer" %}

#### Connection Details

{% collateContent %}

{% note %} 

When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format: 

```
password: secret:/my/database/password
``` 

This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon). 

For a complete guide on managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).

{% /note %}

{% /collateContent %}

- **Host and Port**: Pipeline Service Management/UI URI. This should be specified as a string in the format 'hostname:port'.  

- **NiFi Config**: OpenMetadata supports username/password or client certificate authentication.
    1. Basic Authentication
        - Username: Username to connect to NiFi. This user should be able to send request to the Nifi API and access the `Resources` endpoint.
        - Password: Password to connect to NiFi.
        - Verify SSL: Whether SSL verification should be perform when authenticating.
    2. Client Certificate Authentication
        - Certificate Authority Path: Path to the certificate authority (CA) file. This is the certificate used to store and issue your digital certificate. This is an optional parameter. If omitted SSL verification will be skipped; this can present some sever security issue.
        **important**: This file should be accessible from where the ingestion workflow is running. For example, if you are using OpenMetadata Ingestion Docker container, this file should be in this container.
        - Client Certificate Path: Path to the certificate client file.
        **important**: This file should be accessible from where the ingestion workflow is running. For example, if you are using OpenMetadata Ingestion Docker container, this file should be in this container.
        - Client Key Path: Path to the client key file.
        **important**: This file should be accessible from where the ingestion workflow is running. For example, if you are using OpenMetadata Ingestion Docker container, this file should be in this container.

{% /extraContent %}

{% partial file="/v1.10/connectors/test-connection.md" /%}

{% partial file="/v1.10/connectors/pipeline/configure-ingestion.md" /%}

{% partial file="/v1.10/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}


Connect Apache NiFi to OpenMetadata seamlessly. Complete setup guide for NiFi pipeline connector with step-by-step configuration and metadata extraction.

NiFi

Ingestion Deployment

Run Connectors from the OpenMetadata UI

Run the Connector Externally

External Schedulers

Requirements

Metadata

Metadata Ingestion

1. Visit the Services Page

2. Create a New Service

3. Select the Service Type

4. Name and Describe your Service

Service Name

5. Configure the Service Connection

Connection Details