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 la configuración relacionada de los proyectos.

En esta guía crearás un proyecto de OpenAI. Luego, consulta las guías de casos de uso sobre acceso a proyectos, cuentas de servicio, límites operativos, controles de proyectos e importaciones.

Antes de comenzar

Necesitas:

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

Los puntos de acceso de la API de administración requieren claves de la API de administración, que no funcionan con los puntos de acceso de la API de OpenAI que no son de administración. Guarda la clave en una variable de entorno o en un administrador de secretos. No la incluyas en tu configuración de Terraform ni en el 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 la versión 1.0.0 del proveedor y las posteriores. Revisa las versiones del proveedor antes de actualizar.

Establece tu clave de la API de administración en el entorno:

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

El proveedor lee OPENAI_ADMIN_KEY de forma predeterminada. También puedes establecer OPENAI_ORG_ID y OPENAI_PROJECT_ID para enviar los encabezados OpenAI-Organization y OpenAI-Project con las solicitudes a la API. Cuando estas variables opcionales no están definidas, OpenAI determina la organización y el proyecto a partir de la clave de API. Defínelas cuando quieras identificar 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 y aplica

Inicializa el directorio de trabajo y luego da formato a la configuración y verifícala:

123terraform init
terraform fmt
terraform validate

Terraform descarga el proveedor y crea .terraform.lock.hcl. Incluye el archivo de bloqueo en un commit en el control de versiones para que las ejecuciones futuras 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 mostrar un recurso openai_project por agregar. Aplica la configuración solo después de revisar el plan:

terraform apply

Confirma la aplicación de los cambios cuando se te solicite. Terraform crea el proyecto y muestra su ID mediante la salida project_id.

Elige una guía de casos de uso

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