如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .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 init -upgrade。

查看 Terraform 将执行的更改:

terraform plan

执行计划应显示将新增一个 openai_project 资源。请先检查执行计划,再应用配置:

terraform apply

出现提示时,确认应用配置。Terraform 会创建项目,并通过 project_id 输出项显示项目 ID。

选择适合您场景的指南

指南 用途
项目与访问权限 创建项目,并按角色和组配置访问权限。
服务账户 创建服务账户,用作工作负载身份,或用于通过 API 密钥进行身份验证。
速率限制与支出 使现有速率限制与配置保持一致,并设置支出提醒。
模型、工具和数据控制 配置模型访问权限、托管工具和数据保留设置。
导入资源与协调状态 将现有资源纳入 Terraform 管理,并检测配置漂移。

有关各项参数和导入格式,请参阅提供程序资源与数据源参考。