Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Terraform-Provider

Verwalte die Ressourcen deiner OpenAI-Organisation mit Infrastructure as Code.

Mit dem offiziellen Terraform-Provider von OpenAI kannst du die Ressourcen deiner OpenAI-Organisation mit Infrastructure as Code verwalten. Über die Administration API verwaltet der Provider Projekte, Benutzerkonten, Gruppen, Rollen, Dienstkonten, Zertifikate, Ratenlimits, Ausgabenwarnungen und zugehörige Projekteinstellungen.

In dieser Anleitung erstellst du ein OpenAI-Projekt. In den weiterführenden Anleitungen erfährst du, wie du den Projektzugriff, Dienstkonten, Betriebslimits und Projekteinstellungen verwaltest und bestehende Ressourcen importierst.

Voraussetzungen

Du benötigst:

  • Terraform ab Version 1.0. Für die Importbeispiele benötigst du Terraform ab Version 1.5.
  • Eine OpenAI-Organisation, in der du einen Admin-API-Schlüssel erstellen darfst.

Für die Endpunkte der Administration API benötigst du einen Admin-API-Schlüssel. An anderen Endpunkten der OpenAI API funktionieren diese Schlüssel nicht. Speichere den Schlüssel in einer Umgebungsvariablen oder einem Secrets Manager. Nimm ihn weder in deine Terraform-Konfiguration noch in die Versionsverwaltung auf.

Provider konfigurieren

Erstelle ein neues Verzeichnis und lege darin die Datei main.tf mit folgender Konfiguration an:

terraform {
  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
}

Die Versionsvorgabe lässt Provider-Versionen ab 1.0.0 zu. Lies vor einem Upgrade die Versionshinweise zum Provider.

Setze deinen Admin-API-Schlüssel als Umgebungsvariable:

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

Der Provider liest standardmäßig OPENAI_ADMIN_KEY aus. Du kannst zusätzlich OPENAI_ORG_ID und OPENAI_PROJECT_ID setzen, damit der Provider die Header OpenAI-Organization und OpenAI-Project bei API-Anfragen mitsendet. Ohne diese optionalen Variablen ermittelt OpenAI die Organisation und das Projekt anhand des API-Schlüssels. Setze die Variablen, wenn du ausdrücklich angeben möchtest, welche Organisation oder welches Projekt du mit deiner Terraform-Konfiguration verwaltest. Alle verfügbaren Argumente findest du in der Referenz zur Provider-Konfiguration.

Arbeitsverzeichnis initialisieren und Konfiguration anwenden

Initialisiere das Arbeitsverzeichnis. Formatiere und prüfe anschließend die Konfiguration:

terraform init
terraform fmt
terraform validate

Terraform lädt den Provider herunter und erstellt die Datei .terraform.lock.hcl. Nimm diese Lockdatei in die Versionsverwaltung auf, damit Terraform bei späteren Ausführungen dieselbe Provider-Version auswählt. Führe terraform init -upgrade aus, um die neueste Provider-Version auszuwählen, die deine Versionsvorgabe zulässt.

Prüfe, welche Änderungen Terraform vornehmen wird:

terraform plan

Der Plan sollte anzeigen, dass Terraform eine Ressource vom Typ openai_project hinzufügen wird. Wende die Konfiguration erst an, wenn du den Plan geprüft hast:

terraform apply

Bestätige die Ausführung, wenn Terraform dich dazu auffordert. Terraform erstellt das Projekt und gibt dessen ID über project_id aus.

Anleitung für deinen Anwendungsfall auswählen

Anleitung Was du damit tun kannst
Projekte und Zugriff Projekte erstellen und den Zugriff anhand von Rollen und Gruppen konfigurieren.
Dienstkonten Dienstkonten für die Authentifizierung per Workload-Identität oder API-Schlüssel erstellen.
Ratenlimits und Ausgaben Bestehende Ratenlimits abgleichen und Ausgabenwarnungen einrichten.
Einstellungen für Modelle, Tools und Daten Den Modellzugriff, gehostete Tools und die Datenaufbewahrung konfigurieren.
Import und Abgleich Bestehende Ressourcen in die Verwaltung mit Terraform übernehmen und Abweichungen von der Konfiguration erkennen.

Einzelheiten zu den Argumenten und Importformaten findest du in der Referenz zu den Ressourcen und Datenquellen des Providers.