Provedor Terraform

O provedor Terraform oficial da OpenAI permite gerenciar recursos da organização OpenAI com infraestrutura como código. O provedor usa a API de administração para gerenciar projetos, usuários, grupos, funções, contas de serviço, certificados, limites de taxa, alertas de gastos e configurações relacionadas aos projetos.

Neste guia, você cria um projeto OpenAI. Depois, consulte os guias de casos de uso sobre acesso a projetos, contas de serviço, limites operacionais, controles de projetos e importações.

Antes de começar

Você precisa de:

• Terraform 1.0 ou posterior. Os exemplos de importação exigem Terraform 1.5 ou posterior.
• Uma organização OpenAI com permissão para criar uma chave da API de administração.

Os endpoints da API de administração exigem chaves da API de administração, que não funcionam com endpoints não administrativos da API da OpenAI. Armazene a chave em uma variável de ambiente ou em um gerenciador de segredos. Não inclua a chave em commits da configuração do Terraform nem no controle de versão.

Configure o provedor

Crie um diretório e adicione um arquivo main.tf com a seguinte configuração:

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
}

A restrição de versão permite usar a versão 1.0.0 ou posterior do provedor. Confira as versões do provedor antes de atualizar.

Defina sua chave da API de administração no ambiente:

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

Por padrão, o provedor lê OPENAI_ADMIN_KEY. Você também pode definir OPENAI_ORG_ID e OPENAI_PROJECT_ID para enviar os cabeçalhos OpenAI-Organization e OpenAI-Project nas solicitações à API. Quando essas variáveis opcionais não estão definidas, a OpenAI identifica a organização e o projeto com base na chave de API. Defina-as quando quiser identificar explicitamente qual organização ou projeto sua configuração do Terraform gerencia. Consulte a referência de configuração do provedor para ver todos os argumentos disponíveis.

Inicialize e aplique

Inicialize o diretório de trabalho e, em seguida, formate e verifique a configuração:

123terraform init
terraform fmt
terraform validate

O Terraform baixa o provedor e cria .terraform.lock.hcl. Adicione o arquivo de bloqueio ao controle de versão com um commit para que as próximas execuções selecionem a mesma versão do provedor. Execute terraform init -upgrade para selecionar a versão mais recente do provedor permitida pela restrição.

Revise as alterações que o Terraform fará:

terraform plan

O plano deve mostrar um recurso openai_project a ser adicionado. Aplique a configuração somente depois de revisar o plano:

terraform apply

Confirme a aplicação quando solicitado. O Terraform cria o projeto e exibe seu ID na saída project_id.

Escolha um guia de caso de uso

Para consultar argumentos específicos e formatos de importação, use a referência de recursos e fontes de dados do provedor.