Installing Airbyte (On-Prem) and Connecting Sources

This document outlines how to configure your own Airbyte instance to send your data to a dedicated database for use with TargetBoard.

Before You Begin

• You will need an Airbyte Open-Source On-Prem instance deployed and accessible. See Airbyte's documentation for how to this if needed.
• A dedicated target database will need to be created using credentials provided by TargetBoard (host, port, database name, username, password), and then verified by the TargetBoard team.
• Verify that the Airbyte instance has network access to the database server.

1. Open your Airbyte instance in a web browser and login with admin credentials.
2. Navigate to Connections > New Connection.
3. Choose a source connector (eg: Zendesk, Salesforce, Jira, GitHub etc.)
4. Configure the source connector by entering the required API credentials, authentication tokens or other connection details as prompted. Refer to Airbyte documentation for specific guidance on each connector.
5. Test the connection to ensure it is successful.
6. Choose the destination connector as your dedicated database (PostgreSQL).
7. Configure the destination with the credentials sent to you by TargetBoard (host, portm database name, username, password).
8. Test the connection to verify that the destination is reachable.
9. After configuring the source and destination connectors, create a connection.
   1. Define the sync settings:
      1. Streams: Select the data streams to sync (e.g., tickets, issues, events).
      2. Sync Mode: Choose between Full Refresh, Incremental, or Append.
      3. Destination Namespace: Define how the data will be organized in the destination (e.g., schema per stream or a single schema).
   2. Save the connection.
10. Schedule the sync by setting frequency (Hourly or Daily), ensuring that this schedule aligns with your data refresh requirements.
11. Save the configuration.