Proveedor de Terraform

El proveedor oficial de Terraform de OpenAI te permite administrar los recursos de tu organización de OpenAI con infraestructura como código. El proveedor usa la API de administración para administrar proyectos, usuarios, grupos, roles, cuentas de servicio, certificados, límites de solicitudes, alertas de gasto y ajustes relacionados de los proyectos.

En esta guía crearás un proyecto de OpenAI. Después, consulta las guías por caso de uso para configurar el acceso a los proyectos, las cuentas de servicio, los límites operativos y los controles de los proyectos, o para importar recursos.

Antes de empezar

Necesitas lo siguiente:

• Terraform 1.0 o posterior. Los ejemplos de importación requieren Terraform 1.5 o posterior.
• Una organización de OpenAI en la que tengas permiso para crear una clave de la API de administración.

Los puntos de acceso de la API de administración requieren claves de esa API. Estas claves no funcionan con los demás puntos de acceso de la API de OpenAI. Guarda la clave en una variable de entorno o en un gestor de secretos. No la incluyas en tu configuración de Terraform ni la agregues al sistema de control de versiones.

Configura el proveedor

Crea un directorio nuevo y agrega un archivo main.tf con la siguiente configuración:

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
}

La restricción de versión permite usar la versión 1.0.0 del proveedor o cualquier versión posterior. Revisa las versiones publicadas del proveedor antes de actualizarlo.

Define la clave de la API de administración en el entorno:

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

De forma predeterminada, el proveedor lee OPENAI_ADMIN_KEY. También puedes definir OPENAI_ORG_ID y OPENAI_PROJECT_ID para enviar los encabezados OpenAI-Organization y OpenAI-Project con las solicitudes a la API. Si no defines estas variables opcionales, OpenAI identifica la organización y el proyecto a partir de la clave de API. Defínelas cuando quieras indicar explícitamente qué organización o proyecto administra tu configuración de Terraform. Consulta la referencia de configuración del proveedor para ver todos los argumentos disponibles.

Inicializa el directorio y aplica la configuración

Inicializa el directorio de trabajo. Luego, da formato a la configuración y valídala:

123terraform init
terraform fmt
terraform validate

Terraform descarga el proveedor y crea .terraform.lock.hcl. Agrega este archivo de bloqueo al sistema de control de versiones para que las próximas ejecuciones seleccionen la misma versión del proveedor. Ejecuta terraform init -upgrade para seleccionar la versión más reciente del proveedor que permita la restricción.

Revisa los cambios que hará Terraform:

terraform plan

El plan debería indicar que se agregará un recurso openai_project. Aplica la configuración solo después de revisar el plan:

terraform apply

Confirma los cambios cuando Terraform te lo pida. Terraform crea el proyecto y muestra su ID en la salida project_id.

Elige una guía según tu caso de uso

Para consultar los argumentos específicos de cada recurso y los formatos de importación, usa la referencia de recursos y fuentes de datos del proveedor.