Terraform 供應器

官方 OpenAI Terraform 供應器可讓你透過基礎架構即程式碼管理 OpenAI 組織資源。此供應器使用管理 API 管理專案、使用者、群組、角色、服務帳戶、憑證、速率限制、支出警示及相關專案設定。

本指南將帶你建立 OpenAI 專案。接著，你可以參閱各使用案例指南，了解專案存取權、服務帳戶、運作限制、專案控管及匯入方式。

開始之前

你需要：

• Terraform 1.0 或更新版本。匯入範例需要 Terraform 1.5 或更新版本。
• 一個 OpenAI 組織，且你具備建立管理 API 金鑰的權限。

管理 API 端點需要使用管理 API 金鑰，這類金鑰無法用於非管理用途的 OpenAI API 端點。請將金鑰儲存在環境變數或密鑰管理工具中。不要將金鑰寫入 Terraform 組態或提交至原始碼版本控制系統。

設定供應器

建立新目錄，並新增包含下列組態的 main.tf 檔案：

1234567891011121314151617181920terraform {
  required_version = ">= 1.0"

  required_providers {
    openai = {
      source  = "openai/openai"
      version = ">= 1.0.0"
    }
  }
}

provider "openai" {}

resource "openai_project" "example" {
  name = "terraform-managed"
}

output "project_id" {
  value = openai_project.example.project_id
}

此版本限制允許使用供應器 1.0.0 及更新版本。升級前，請先查看供應器版本資訊。

在環境中設定管理 API 金鑰：

export OPENAI_ADMIN_KEY="<your-admin-api-key>"

供應器預設會讀取 OPENAI_ADMIN_KEY。你也可以設定 OPENAI_ORG_ID 和 OPENAI_PROJECT_ID，讓 API 請求帶上 OpenAI-Organization 和 OpenAI-Project 標頭。若未設定這些選用變數，OpenAI 會根據 API 金鑰判定組織和專案。若要明確指定 Terraform 組態管理的組織或專案，請設定這些變數。如需所有可用引數，請參閱供應器組態參考資料。

初始化並套用

初始化工作目錄，然後格式化並檢查組態：

123terraform init
terraform fmt
terraform validate

Terraform 會下載供應器並建立 .terraform.lock.hcl。請將鎖定檔提交至原始碼版本控制系統，讓後續執行時選用相同的供應器版本。執行 terraform init -upgrade 即可選用版本限制允許的最新供應器版本。

審查 Terraform 即將進行的變更：

terraform plan

執行計畫應顯示將新增一個 openai_project 資源。請務必先審查執行計畫，再套用組態：

terraform apply

出現提示時，確認套用。Terraform 會建立專案，並透過 project_id 輸出值顯示專案 ID。

選擇使用案例指南

如需個別引數和匯入格式，請參閱供應器資源與資料來源參考資料。