如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

Terraform 提供者

以基礎架構即程式碼的方式管理 OpenAI 組織資源。

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

本指南說明如何建立 OpenAI 專案。完成後,可參閱各情境指南,瞭解如何設定專案存取權、管理服務帳戶、設定運作限制與專案控制項,以及匯入資源。

開始之前

請先確認您具備下列條件:

  • 已安裝 Terraform 1.0 或更新版本。匯入範例需要 Terraform 1.5 或更新版本。
  • 您所屬的 OpenAI 組織已授予您建立管理員 API 金鑰的權限。

管理 API 端點必須使用管理員 API 金鑰。這類金鑰無法用於非管理用途的 OpenAI API 端點。請將金鑰存放在環境變數或機密管理工具中。切勿將金鑰寫入 Terraform 設定或提交至版本控制系統。

設定提供者

建立新目錄,並在其中新增 main.tf 檔案,內容如下:

terraform {
  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 設定所管理的組織或專案,請設定對應的變數。如需查看所有可用引數,請參閱提供者設定參考文件。

初始化並套用設定

初始化工作目錄,接著將設定檔格式化並驗證設定:

terraform init
terraform fmt
terraform validate

Terraform 會下載提供者並建立 .terraform.lock.hcl。請將這個鎖定檔提交至版本控制系統,讓 Terraform 日後執行時選用相同版本的提供者。若要選用版本限制允許的最新提供者版本,請執行 terraform init -upgrade。

查看 Terraform 即將執行的變更:

terraform plan

執行計畫應顯示將新增一個 openai_project 資源。請先檢閱計畫,再套用設定:

terraform apply

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

選擇適用情境的指南

指南 用途
專案與存取權 建立專案,並依角色與群組設定存取權。
服務帳戶 建立服務帳戶,以使用工作負載身分或透過 API 金鑰進行驗證。
速率限制與支出 使現有速率限制與設定一致,並設定支出警示。
模型、工具與資料控制項 設定模型存取權、託管工具及資料保留方式。
匯入與調整 將現有資源納入 Terraform 管理,並偵測實際狀態與設定之間的差異。

如需查詢個別引數和匯入格式,請參閱提供者的資源與資料來源參考文件。