0.17
There's a lot of open issues
No release in over a year
Gem containing apis used by Enterprise Search and implementations of Connectors
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

Build status

Elastic connectors

search-icon

Connectors

This repository contains the source code for all Elastic connectors, developed by the Search team at Elastic. Use connectors to sync data from popular data sources to Elasticsearch.

These connectors are available as:

ℹ️ For an overview of the steps involved in deploying connector clients refer to Connector clients in the official Elastic documentation.

To get started quickly with self-managed connectors using Docker Compose, check out this README file.

Connector documentation

The main documentation for using connectors lives in the Search solution's docs. Here are the main pages:

You'll also find the individual references for each connector there. For everything to do with developing connectors, you'll find that here in this repo.

API documentation

Since 8.12.0, you can manage connectors and sync jobs programmatically using APIs. Refer to the Connector API documentation in the Elasticsearch docs.

Command-line interface

Learn about our CLI tool in docs/CLI.md.

Connector service code

In addition to the source code for individual connectors, this repo also contains the connector service code, which is used for tasks like running connectors, and managing scheduling, syncs, and cleanup. This is shared code that is not used by individual connectors, but helps to coordinate and run a deployed instance/process.

Connector framework

This repo is also the home of the Elastic connector framework. This framework enables developers to build Elastic-supported connector clients. The framework implements common functionalities out of the box, so developers can focus on the logic specific to integrating their chosen data source.

The framework ensures compatibility, makes it easier for our team to review PRs, and help out in the development process. When you build using our framework, we provide a pathway for the connector to be officially supported by Elastic.

Running a self-managed stack

This repo provides a set of scripts to allow a user to set up a full Elasticsearch, Kibana, and Connectors service stack using Docker. This is useful to get up and running with the Connectors framework with minimal effort, and provides a guided set of prompts for setup and configuration. For more information, instructions, and options, see the README file in the stack folder.

Framework use cases

The framework serves two distinct, but related use cases:

  • Customizing an existing Elastic connector client
  • Building a new connector client

Guides for using the framework