https://github.com/airbytehq/terraform-provider-airbyte

Terraform Provider for Airbyte API
https://github.com/airbytehq/terraform-provider-airbyte

airbyte api terraform terraform-provider

Last synced: 5 days ago
JSON representation

Terraform Provider for Airbyte API

• Host: GitHub
• URL: https://github.com/airbytehq/terraform-provider-airbyte
• Owner: airbytehq
• License: mit
• Created: 2023-03-24T17:03:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T00:50:04.000Z (3 months ago)
• Last Synced: 2025-01-15T09:53:51.323Z (12 days ago)
• Topics: airbyte, api, terraform, terraform-provider
• Language: Go
• Homepage: https://api.airbyte.com/
• Size: 14.9 MB
• Stars: 50
• Watchers: 9
• Forks: 20
• Open Issues: 77
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


    

        

    

    
Programatically control Airbyte Cloud through an API.

    

    

  



## Authentication

Developers will need to create an API Key within your [Developer Portal](https://portal.airbyte.com/) to make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see a [walkthrough demo here](https://www.loom.com/share/7997a7c67cd642cc8d1c72ef0dfcc4bc)🎦

The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.

## Summary

airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.

## Table of Contents

* [Installation](#installation)

* [Available Resources and Data Sources](#available-resources-and-data-sources)

* [Testing the provider locally](#testing-the-provider-locally)

## SDK Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.

```hcl

terraform {

  required_providers {

    airbyte = {

      source  = "airbytehq/airbyte"

      version = "0.13.0"

    }

  }

}

provider "airbyte" {

  # Configuration options

}

```

## SDK Example Usage

### Testing the provider locally

Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.

This also allows for debuggers (e.g. delve) to be attached to the provider.

### Example

```sh

go run main.go --debug

# Copy the TF_REATTACH_PROVIDERS env var

# In a new terminal

cd examples/your-example

TF_REATTACH_PROVIDERS=... terraform init

TF_REATTACH_PROVIDERS=... terraform apply

```

## Available Resources and Operations

Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.

Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.

```

provider_installation {

  dev_overrides {

      "registry.terraform.io/airbyte/scaffolding" = ""

  }

  # For all other providers, install them directly from their origin provider

  # registries as normal. If you omit this, Terraform will _only_ use

  # the dev_overrides block, and so no other providers will be available.

  direct {}

}

```

Your `` may vary depending on how your Go environment variables are configured. Execute `go env GOBIN` to set it, then set the `` to the value returned. If nothing is returned, set it to the default location, `$HOME/go/bin`.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.

Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

### Provider Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)