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。

选择用例指南

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