Skip to content

Latest commit

 

History

History
171 lines (121 loc) · 7.26 KB

source_github.md

File metadata and controls

171 lines (121 loc) · 7.26 KB
page_title subcategory description
airbyte_source_github Resource - terraform-provider-airbyte
SourceGithub Resource

airbyte_source_github (Resource)

SourceGithub Resource

Example Usage

resource "airbyte_source_github" "my_source_github" {
  configuration = {
    additional_properties = "{ \"see\": \"documentation\" }"
    api_url               = "https://github.com"
    branch                = "airbytehq/airbyte/master airbytehq/airbyte/my-branch"
    branches = [
      "..."
    ]
    credentials = {
      personal_access_token = {
        personal_access_token = "...my_personal_access_token..."
      }
    }
    max_waiting_time = 10
    repositories = [
      "..."
    ]
    repository = "airbytehq/airbyte airbytehq/another-repo"
    start_date = "2021-03-01T00:00:00Z"
  }
  definition_id = "eed1fe5e-7311-4b8b-9ce8-186629287c2f"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "8cc76dd7-521b-4116-ab6d-3a729514b42f"
}

Schema

Required

  • configuration (Attributes) The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. (see below for nested schema)
  • name (String) Name of the source e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • resource_allocation (Attributes) actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level. (see below for nested schema)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • credentials (Attributes) Choose how to authenticate to GitHub (see below for nested schema)
  • repositories (List of String) List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.

Optional:

  • additional_properties (String) Parsed as JSON.
  • api_url (String) Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
  • branch (String) (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
  • branches (List of String) List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
  • max_waiting_time (Number) Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
  • repository (String) (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
  • start_date (String) The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the docs for more info

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.o_auth

Required:

  • access_token (String, Sensitive) OAuth access token

Optional:

  • client_id (String, Sensitive) OAuth Client Id
  • client_secret (String, Sensitive) OAuth Client secret

Nested Schema for configuration.credentials.personal_access_token

Required:

  • personal_access_token (String, Sensitive) Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

Nested Schema for resource_allocation

Read-Only:

Nested Schema for resource_allocation.default

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Nested Schema for resource_allocation.job_specific

Read-Only:

  • job_type (String) enum that describes the different types of jobs that the platform runs.
  • resource_requirements (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see below for nested schema)

Nested Schema for resource_allocation.job_specific.resource_requirements

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Import

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

import {
  to = airbyte_source_github.my_airbyte_source_github
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_github.my_airbyte_source_github "..."