Provedor do Terraform

Com o provedor oficial da OpenAI para Terraform, você pode gerenciar os recursos da sua organização na 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 de projeto relacionadas.

Neste guia, você vai criar um projeto na OpenAI. Em seguida, consulte os guias por caso de uso para gerenciar o acesso a projetos, as contas de serviço, os limites operacionais, os controles de projeto e as importações.

Antes de começar

Você precisa de:

• Terraform 1.0 ou posterior. Os exemplos de importação exigem o Terraform 1.5 ou posterior.
• Uma organização na OpenAI em que você tenha permissão para criar uma chave de API de administrador.

Os endpoints da API de administração exigem chaves de API de administrador. Essas chaves não funcionam nos demais endpoints da API da OpenAI. Armazene a chave em uma variável de ambiente ou em um gerenciador de segredos. Não inclua a chave na configuração do Terraform nem faça commit dela no sistema de 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 do provedor ou qualquer versão posterior. Antes de atualizar, consulte as versões publicadas do provedor.

Defina sua chave de API de administrador como variável de ambiente:

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

Por padrão, o provedor lê a variável 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. Se você não definir essas variáveis opcionais, a OpenAI identifica a organização e o projeto com base na chave de API. Defina essas variáveis quando quiser indicar explicitamente qual organização ou projeto a configuração do Terraform gerencia. Para ver todos os argumentos disponíveis, consulte a referência de configuração do provedor.

Inicialize o diretório e aplique a configuração

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

123terraform init
terraform fmt
terraform validate

O Terraform baixa o provedor e cria o arquivo .terraform.lock.hcl. Faça commit desse arquivo no sistema de controle de versão para que as próximas execuções usem a mesma versão do provedor. Execute terraform init -upgrade para selecionar a versão mais recente do provedor permitida pela restrição de versão.

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

terraform plan

O plano deve indicar a adição de um recurso openai_project. Aplique a configuração somente depois de revisar o plano:

terraform apply

Quando o Terraform pedir confirmação, confirme a aplicação das alterações. O Terraform cria o projeto e exibe o ID fornecido pela saída project_id.

Escolha um guia por 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.