Importiere bestehende OpenAI-Ressourcen, statt sie neu zu erstellen. Für eine sichere Übernahme bildest du zunächst die aktuellen Einstellungen der Ressource in deiner Terraform-Konfiguration ab. Prüfe den geplanten Import und führe ihn aus. Bevor du gezielt etwas änderst, sollte ein weiterer Plan bestätigen, dass keine Änderungen anstehen.
Importblöcke setzen Terraform 1.5 oder höher voraus.
Ressourcen deklarieren und importieren
Deklariere jede bestehende Ressource mit ihren aktuellen Einstellungen. Füge dann einen import-Block hinzu und verwende das ID-Format aus der Provider-Referenz.
resource "openai_project" "existing" {
name = "existing-project"
}
resource "openai_group" "existing" {
name = "existing-group"
}
resource "openai_project_service_account" "existing" {
project_id = openai_project.existing.project_id
name = "existing-service-account"
}
import {
to = openai_project.existing
id = "proj_123"
}
import {
to = openai_group.existing
id = "group_123"
}
import {
to = openai_project_service_account.existing
id = "proj_123/svc_acct_123"
}
Speichere den Plan und prüfe die vorgesehenen Importe.
terraform plan -out=tfplan
terraform show tfplan
Der Plan sollte die Importe anzeigen, ohne Änderungen an den Ressourcen bei OpenAI vorzuschlagen. Falls er Änderungen vorschlägt, passe die Konfiguration an die aktuellen Einstellungen an, bevor du fortfährst. Wende den gespeicherten Plan an, um die Importe auszuführen, und erstelle anschließend einen weiteren Plan.
terraform apply tfplan
terraform plan
Der zweite Plan sollte keine Änderungen anzeigen. Du kannst die Importblöcke in der Konfiguration belassen. So bleibt nachvollziehbar, wie Terraform die Ressourcen übernommen hat.
Die folgende Tabelle zeigt häufig verwendete Formate für Import-IDs.
| Ressource | Format der Import-ID |
|---|---|
| Projekt | <project_id> |
| Organisationsgruppe | <group_id> |
| Projektrolle | <project_id>/<role_id> |
| Dienstkonto eines Projekts | <project_id>/<service_account_id> |
| Projektrolle einer Gruppe | <project_id>/<group_id>/<role_id> |
| Projektrolle eines Benutzerkontos | <project_id>/<user_id>/<role_id> |
| Ratenlimit eines Projekts | <project_id>/<rate_limit_id> |
Das genaue Format für jede Ressource findest du in der Provider-Referenz.
Ressourcen auslesen, ohne sie zu übernehmen
Verwende Datenquellen, wenn Terraform aktuelle Informationen benötigt, aber ein anderes System die Ressource verwaltet. Der Provider bietet Datenquellen für Projekte, Gruppen, Rollen, Benutzerkonten, Rollenzuweisungen, Ratenlimits, Modellberechtigungen, Berechtigungen für gehostete Tools, Ausgabenwarnungen, Datenaufbewahrung und Zertifikate.
Das folgende Beispiel liest ein bestehendes Projekt und seine aktuellen Gruppen aus.
data "openai_project" "existing" {
project_id = var.project_id
}
data "openai_project_groups" "existing" {
project_id = data.openai_project.existing.project_id
}
output "project_groups" {
value = data.openai_project_groups.existing.groups
}
Der Provider kann ein bestehendes Dienstkonto eines Projekts anhand seiner ID importieren. Eine Datenquelle für Dienstkonten bietet er derzeit nicht an. Wenn du ein bestehendes Dienstkonto übernehmen musst, halte die IDs des Projekts und des Dienstkontos in deinem freigegebenen Inventar fest. Die Anleitung zu Dienstkonten beschreibt, wie du den API-Schlüssel für die Ersteinrichtung erhältst und in welcher Reihenfolge du den Import durchführst.
Konfigurationsabweichungen erkennen und beheben
Erstelle einen regulären Plan. Dabei liest Terraform die aktuellen Einstellungen bei OpenAI aus und vergleicht sie mit den Sollwerten in deiner Terraform-Konfiguration.
terraform plan -detailed-exitcode
Der Exit-Code 0 bedeutet, dass keine Änderungen anstehen. Bei 2 enthält der Plan Änderungen. Bei 1 ist in Terraform ein Fehler aufgetreten.
Wenn der Plan zeigt, dass eine Einstellung außerhalb von Terraform geändert wurde, gehe wie folgt vor.
- Kläre, ob die Änderung beabsichtigt war.
- Wenn du die Änderung bei OpenAI beibehalten möchtest, passe die Terraform-Konfiguration entsprechend an.
- Wenn du die Änderung bei OpenAI rückgängig machen möchtest, prüfe den Plan und wende ihn an. Damit stellst du den konfigurierten Wert wieder her.
- Erstelle einen weiteren Plan und stelle sicher, dass er keine Änderungen anzeigt.
Was beim Entfernen von Ressourcen passiert
Wenn du einen Ressourcenblock entfernst und den Plan anwendest, entfernt Terraform die Ressource aus dem Terraform-State. Ob Terraform das zugehörige Objekt bei OpenAI löscht oder eine Einstellung zurücksetzt, hängt vom Ressourcentyp ab.
| Ressourcentyp | Verhalten beim Entfernen |
|---|---|
openai_project |
Terraform archiviert das Projekt. Ein archiviertes Projekt kannst du nicht wiederherstellen. |
openai_project_service_account |
Terraform löscht das Dienstkonto. |
| Ressourcen für Rollen, Gruppen, Mitgliedschaften und Zuweisungen | Terraform löscht das zugehörige verwaltete Objekt oder die entsprechende Zuweisung. |
openai_project_model_permissions |
Terraform löscht die Konfiguration der Modellberechtigungen für das Projekt. |
| Ressourcen für Projekt-Ratenlimits, Berechtigungen für gehostete Tools und Datenaufbewahrung | Terraform entfernt die Ressource aus dem Terraform-State, ohne die Einstellung bei OpenAI zurückzusetzen. |