Skip to content

Commit

Permalink
Update Docs: adding Orchestra to the 'Integrating with Airbyte' secti…
Browse files Browse the repository at this point in the history
…on (#44701)
  • Loading branch information
willdavies0 authored Sep 8, 2024
1 parent 06f8a2b commit 4420264
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/operator-guides/using-orchestra-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
description: Trigger Airbyte jobs with Orchestra in seconds
products: oss-*
---

# Using an Orchestra Task

[Orchestra](https://getorchestra.io) supports both Airbyte Cloud and Airbyte server instances. This guide will show you how to trigger Airbyte jobs with Orchestra in seconds.

## 1. Connect to Airbyte

Navigate to [Orchestra](https://app.getorchestra.io/integrations) and create a new integration credential. Select Airbyte Cloud or Airbyte Server, depending on your setup. You will need to create a Client ID and Client Secret to authenticate with Airbyte. Instructions for this can be found [here](/using-airbyte/configuring-api-access).

![orchestra_airbyte_integration](./assets/OrchestraAirbyteIntegration.png)

## 2. Create an Orchestra Task

Create an Orchestra pipeline containing an Airbyte task. You can trigger both 'Sync' and 'Reset' jobs with the Airbyte task. The task requires the following parameters:

- **Connection ID**: The ID of the connection you want to trigger.
- **Job Type**: The type of job you want to trigger. This can be either 'Sync' or 'Reset'.

![orchestra_airbyte_task](./assets/OrchestraAirbyteTask.png)

## 3. Run the Pipeline

You can manually run your pipeline from the Orchestra UI. Alternatively, you can trigger the pipeline on a cron schedule or via an API call. Once the job is triggered, you can monitor the status of the job in the Orchestra UI.

![orchestra_airbyte_run](./assets/OrchestraAirbyteRun.png)

## Next Steps

You can now trigger Airbyte jobs using Orchestra. For more information on using Orchestra, check out the [Orchestra documentation](https://orchestra-1.gitbook.io/orchestra-portal/integrations/ingestion-elt/airbyte-cloud).
1 change: 1 addition & 0 deletions docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,7 @@ module.exports = {
"operator-guides/using-prefect-task",
"operator-guides/using-dagster-integration",
"operator-guides/using-kestra-plugin",
"operator-guides/using-orchestra-task",
],
},
{
Expand Down

0 comments on commit 4420264

Please sign in to comment.