https://github.com/antonbabenko/terraform-provider-openai

Terraform provider for OpenAI (experimental as hell)
https://github.com/antonbabenko/terraform-provider-openai

openai terraform terraform-provider

Last synced: 5 days ago
JSON representation

Terraform provider for OpenAI (experimental as hell)

• Host: GitHub
• URL: https://github.com/antonbabenko/terraform-provider-openai
• Owner: antonbabenko
• License: mit
• Created: 2023-07-06T11:12:56.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-11T00:13:27.000Z (about 2 months ago)
• Last Synced: 2024-09-20T06:44:28.973Z (15 days ago)
• Topics: openai, terraform, terraform-provider
• Language: Go
• Homepage: https://registry.terraform.io/providers/antonbabenko/openai
• Size: 489 KB
• Stars: 26
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

        

    

   
Programmatically control resources in the OpenAI API.

   

  



## Authentication

Developers will need to create an API Key within their OpenAI [organisation](https://platform.openai.com/) to make API requests.

## SDK Installation

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

```hcl

terraform {

  required_providers {

    openai = {

      source  = "antonbabenko/openai"

      version = "2.3.2"

    }

  }

}

provider "openai" {

  # 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/openai/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)