Fehlerbehebung beim Terraform-Provider

Vorhandene OCI-Ressourcen können zerstört und neu erstellt werden, wenn Terraform-Konfigurationen versuchen, eine Ressourceneigenschaft zu aktualisieren, die nicht aktualisierbar ist. Terraform warnt Sie, wenn Änderungen eine Ressource zerstören. Führen Sie immer terraform plan aus, bevor Sie Änderungen anwenden, um zu ermitteln, welche Ressourcen betroffen sind. Weitere Informationen finden Sie unter Zerstörende Änderungen.

In einigen Fällen muss eine Aktualisierung einer OCI-Ressource das Löschen und erneute Erstellen der Ressource erzwingen, aber die Abhängigkeit einer anderen Ressource von dieser Ressource lässt den Vorgang nicht zu.

Beispiel: Sie möchten eine oci_core_instance_configuration-Ressource aktualisieren, aber diese Instanzkonfiguration wird von einem Instanzpool verwendet. Die Instanzkonfiguration kann nicht gelöscht werden, weil sie vom Instanzpool in einem erforderlichen Argument referenziert wird.

Um dieses Verhalten zu umgehen, können Sie die Metaargumente lifecycle und create_before_destroy im Ressourcenblock verwenden.

In diesem Beispiel erstellt Terraform eine zweite oci_core_instance_configuration-Ressource, die Ihre Aktualisierungen enthält, und weist dann die neue Instanzkonfiguration dem zugehörigen Instanzpool zu. Schließlich zerstört Terraform die ursprüngliche Instanzkonfiguration. Beispiele:

resource "oci_core_instance_configuration" "test_instance_configuration" {
...

 lifecycle {
    create_before_destroy = true
  }
}

Weitere Informationen finden Sie unter Metaargument lifecycle und Zerstörende Änderungen.

Sie können verhindern, dass eine OCI-Ressource zerstört wird, indem Sie die Metadaten lifecycle und prevent_destroy = true in den Ressourcenblock der Terraform-Konfigurationsdatei aufnehmen. Die folgende Konfiguration führt beispielsweise zu einem Objektspeicher-Bucket, der nicht zerstört werden kann:

resource "oci_objectstorage_bucket" "test_bucket" {
  #Required
  compartment_id = var.tenancy
  name = "test"
  namespace = "exampleNamespace"

  lifecycle {
    prevent_destroy = true
  }
} 

Dieses Metaargument verhindert die Verwendung von terraform destroy. Da bei bestimmten Konfigurationsupdates Ressourcen zerstört werden müssen, bevor sie eingespielt werden können, kann diese Einstellung bewirken, dass auch einige Updates nicht mehr eingespielt werden können. In diesem Beispiel ist name eine Eigenschaft, die nicht aktualisiert werden kann, ohne dass die Ressource zerstört und neu erstellt wird. Daher können Sie den Namen des Buckets nicht aktualisieren, ohne das Metaargument lifecycle zu entfernen oder zu ändern.

Weitere Informationen finden Sie unter dem Metargument lifecycle.

Viele vom OCI-Terraform-Provider verwaltete Oracle Cloud Infrastructure-Ressourcen akzeptieren optionale Konfigurationsargumente. Nachdem diese Argumente bei der Erstellung der Ressource oder bei einer späteren Aktualisierung festgelegt wurden, können sie nicht mehr aufgehoben werden, indem eine leere Zeichenfolge übergeben oder das Argument aus der Konfiguration entfernt wird. Versuche, diese Argumente aufzuheben, werden von Terraform ignoriert.

Möglicherweise müssen Sie in Terraform v0.14 und höher globale Variablen in Ihren Konfigurationsdateien durch eine Kombination aus lokalen Variablen und Triggern ersetzen. Um einen Trigger in den Metaargumenten lifecycle und ignore_changes zu referenzieren und die Durchführung der Konfiguration bei nachfolgenden Terraform-Anwendungsvorgängen zu vermeiden, referenzieren Sie den Trigger wie folgt:

resource "null_resource" "exampleB" {
  depends_on = [null_resource.exampleA]
  triggers = {
    os_user = var.os_user
  }
  lifecycle {
    ignore_changes = [
      triggers["os_user"]
    ]
  }

Standardmäßig löscht der Terraform-Provider kein Compartment, wenn der Befehl destroy verwendet wird.

Sie müssen das Argument enable_delete auf true setzen, damit der Provider versucht, das Compartment zu löschen. Beispiele:

resource "oci_identity_compartment" "test_compartment" {
    compartment_id = var.compartment_id
    description = var.compartment_description
    name = var.compartment_name

    enable_delete = true
}

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: Operation Timeout
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current. 
Service: <service>
Error Message: timeout while waiting for state to become 'SUCCEEDED, FAILED, CANCELED' (last state: 'IN_PROGRESS', timeout: 15m)

Damit gibt der angegebene OCI-Service an, dass die Ressource nach einiger Polling-Zeit den erwarteten Status noch nicht erreicht hat.

Möglicherweise müssen Sie den Timeoutwert für den Vorgang erhöhen, damit das Polling länger fortgesetzt wird. Details hierzu finden Sie unter Operation Timeouts.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: Unexpected LifeCycle state
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current. 
Service: <service>
Error Message: During deletion, Terraform expected the resource to reach state: TERMINATED, but the service reported unexpected state: RUNNING.
Resource OCID: exampleuniqueID
Suggestion: Please retry or contact support for help with service: <service>

Bei dem angegebenen OCI-Service ist ein unbekannter Fehler aufgetreten. Wiederholen Sie den Vorgang, oder wenden Sie sich an den Support für diesen Service.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error asking for user input: 1 error(s) occurred:

* provider.oci: dial unix /var/folders/6r/8fk5dmbj4_z3sl0mc_y_fhjw0000gn/T/plugin811254328|netrpc: connect: no such file or directory

Wahrscheinlich verwenden Sie eine Version des OCI-Terraform-Providers, die nicht mit der installierten Terraform-Binärdatei kompatibel ist. Für OCI-Providerversionen v3.x.x und höher ist mindestens die Terraform-Version v.0.10.1 erforderlich.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

* provider.oci: ... dial tcp 134.70.16.0:443: i/o timeout

In diesem Fall haben Sie Ihre Proxyeinstellungen möglicherweise nicht richtig konfiguriert. Der OCI-Terraform-Provider unterstützt die Variablen http_proxy, https_proxy und no_proxy. Dabei können die Ein- oder Ausschlusslisten wie folgt definiert werden:

export http_proxy=http://www.your-proxy.com:80/
export https_proxy=http://www.your-proxy.com:80/
export no_proxy=localhost,127.0.0.1

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: Get https://iaas.<region>.oraclecloud.com/20160918/services: x509: certificate signed by unknown authority
  on ../modules/network/modules/main/main.tf line 3...

Stellen Sie sicher, dass Terraform vertrauenswürdige TLS-Zertifikate verwendet und die Zertifikatskette gültig ist. Weitere Informationen finden Sie unter Terraform-Ausführung mit Fehler "x509: certificate signed by unknown authority" nicht erfolgreich. Wenn Sie MacOS Catalina verwenden, finden Sie im Abschnitt MacOS des Dokuments genauere Informationen zur Lösung von Zertifikatsproblemen.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Warning: registry.terraform.io: 
This version of Terraform has an outdated GPG key and is unable to verify new provider releases.
Please upgrade Terraform to at least <version> to receive new provider updates.
For details see: https://discuss.hashicorp.com/t/hcsec-2021-12-codecov-security-event-and-hashicorp-gpg-key-exposure/23512

Diese Meldung bedeutet, dass die Terraform-Registry die Terraform-Providerversionen auslässt, die von einem neuen GPG-Schlüssel signiert wurden. Die Terraform-CLI installiert die letzte Version des OCI-Terraform-Providers, die sie erfolgreich verifizieren kann. Dabei handelt es sich nicht unbedingt um die neueste Version.

Um diese Nachricht zu entfernen und sicherzustellen, dass Sie die neueste Version des OCI-Terraform-Providers verwenden können, upgraden Sie die Terraform-CLI auf das neueste Wartungsrelease, das für die verwendete Terraform-Hauptversion verfügbar ist. Beispiel: Wenn Sie Terraform v0.12.21 verwenden, führen Sie ein Upgrade auf die neueste verfügbare Version von v0.12 durch.

Wenn Sie Module verwenden und die Terraform-CLI eine Fehlermeldung wie die Folgende zurückgibt:

Error: 401-NotAuthenticated, The required information to complete authentication was not provided or was incorrect.

Stellen Sie sicher, dass jedes Modul seine eigenen Provider-Anforderungen deklariert. Weitere Informationen finden Sie in Provider in Modulen.

Symptom: Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: 401-NotAuthenticated
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current.
Service: <service>
Error Message: The required information to complete authentication was not provided or was incorrect.
OPC request ID: exampleuniqueID
Suggestion: Please retry or contact support for help with service: <service>

Mögliche Ursachen: Falsche Konfiguration.

Lösung: Prüfen Sie Folgendes:

• Korrekt konfigurierte Attribute:
  • user_ocid
  • tenancy_ocid
  • fingerprint
  • private_key_path: Stellen Sie sicher, dass er auf einen Private Key und nicht auf den entsprechenden Public Key verweist
• Der Public Key, der private_key_path entspricht, wurde dem als user_ocid angegebenen Benutzeraccount hinzugefügt.
• Die Public und Private Key-Paare verwenden das richtige Format. Details und die Schritte zum Generieren von Schlüsseln finden Sie unter Erforderliche Schlüssel und OCIDs.
• Der Benutzeraccount ist Teil einer Gruppe mit den entsprechenden Berechtigungen, um die Aktionen im gewünschten Plan auszuführen.
• Der Mandant abonniert die im Plan bestimmte Region.
• Wenn Sie Module verwenden, stellen Sie sicher, dass jedes Modul seine eigenen Provideranforderungen deklariert. Weitere Informationen finden Sie in Provider in Modulen.

Wenn die Terraform-CLI eine Meldung wie die Folgende zurückgibt, kann dies auf ein Problem mit Ihrer Umgebung hinweisen:

Error: can not create client, bad configuration: did not find a proper configuration for tenancy

Wenn Ihre Providerkonfiguration einen Alias enthält, müssen Ihre Ressourcen den Provideralias explizit mit provider = "oci.alias_name" angeben. Wenn eine Ressource den Provider nicht mit dem Alias angibt, erstellt Terraform einen Standardprovider, der mit diesen Ressourcen verwendet werden soll. Der Standardprovider lädt Konfigurationswerte aus Umgebungsvariablen oder der Datei ~/.oci/config. Diese Werte können sich von den Werten unterscheiden, die von Ihrem mit Alias angegebenen Provider verwendet werden, und den Konfigurationsfehler verursachen.

Entfernen Sie entweder den Alias in der Providerkonfiguration, oder stellen Sie sicher, dass jede Ressource den Provider durch den richtigen Alias angibt. Weitere Informationen zur Verwendung von alias finden Sie in der offiziellen Terraform-Dokumentation. Informationen zur Verwendung von Umgebungsvariablen und der OCI-Konfigurationsdatei finden Sie unter Provider konfigurieren.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

* Error: "field_name": this field cannot be set

Sie verwenden wahrscheinlich eine ältere Version des OCI-Terraform-Providers, und das gewünschte Feld wurde in einer späteren Version veröffentlicht. Prüfen Sie die Terraform-Providerversion mit dem folgenden Befehl.

terraform -version

Die Dokumentation des OCI-Terraform-Providers gilt für die aktuelle Version.

Wenn für das importierte oci_database_db_system ein primäres db_home fehlt, wird ein leerer Platzhalter für db_home in der Terraform-Statusdatei festgelegt. Um Konfigurationen mit dem importierten Status konsistent zu halten, fügen Sie der Konfiguration einen leeren Platzhalter für db_home hinzu. Beispiele:

# Add this placeholder into your oci_database_db_system configuration to indicate that the primary db home is empty. 
db_home {
 database { 
  admin_password = "" 
  } 
}

Die Terraform-CLI gibt beim Verwenden der Ressourcen-Discovery eine Fehlermeldung wie die Folgende zurück:

Failed to query available provider packages
 
Could not retrieve the list of available versions for provider hashicorp/oci:
the previously-selected version is no longer available

Sie können sicherstellen, dass Terraform eine vorhandene Binärdatei eines lokalen Providers verwendet, indem Sie ihren Speicherort mit der Umgebungsvariablen provider_bin_path angeben. Beispiele:

export provider_bin_path=/Users/user/go/bin/

Terraform versucht, die neueste Version des OCI-Terraform-Providers herunterzuladen, wenn Sie die Ressourcenerkennung verwenden.

In einigen Fällen kann der OCI-Terraform-Provider vorhandene Tagstandards unerwarteterweise aus einer Ressource löschen, wenn terraform apply ausgeführt wird. Dieses Problem betrifft insbesondere die automatischen Oracle-Tags-Tagstandardwerte.

Um dieses Problem zu umgehen, können Sie dem Providerblock das Attribut ignore_defined_tags hinzufügen.

Mit dem Attribut ignore_defined_tags können Sie die Schlüssel der definierten Tags auflisten, die Terraform beim Planen oder Anwenden ignoriert. Das Attribut ignore_defined_tags kann nur auf Providerebene angegeben werden und hat eine maximal zulässige Größe von 100. Die in diesem Attribut angegebenen Tags werden für alle Ressourcen in dieser Terraform-Datei ignoriert.

Im folgenden Beispiel sind "Oracle-Tags.CreatedOn" und "Oracle-Tags.CreatedBy" die Schlüssel in der defined_tags-Zuordnung, die mit einer Remoteressource verknüpft ist:

provider "oci" {
    ignore_defined_tags = ["Oracle-Tags.CreatedBy", "Oracle-Tags.CreatedOn"]
}

Weitere Informationen finden Sie unter Providerdefinitionen und im zugehörigen GitHub-Problem.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: 400-InvalidParameter
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current. 
Service: <service>
Error Message: <error_message>
OPC request ID: exampleuniqueID
Suggestion: Please update the parameter(s) in the Terraform config as per error message: <error_message>

Aktualisieren Sie den Parameter, der in der Fehlermeldung angegeben ist, in der Terraform-Konfiguration für die Ressource.

Bei der Verwendung von Terraform können Fehler auftreten, die darauf hinweisen, dass Sie die Servicelimits für eine Ressource erreicht oder überschritten haben. Beispiele:

Error: 400-LimitExceeded
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current. 
Service: <service>
Error Message: Fulfilling this request exceeds the Oracle-defined limit for this tenancy for this resource type.
OPC request ID: exampleuniqueID
Suggestion: Request a service limit increase for this resource <service>

Weitere Informationen zu OCI-Servicelimits und zum Beantragen einer Limiterhöhung finden Sie unter Service Limits.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: 404-NotAuthorizedOrNotFound
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current.
Service: <service>
Error Message: Authorization failed or requested resource not found.
OPC request ID: exampleuniqueID
Suggestion: Either the resource has been deleted or service <service> need policy to access this resource. Policy reference: <link>

Stellen Sie sicher, dass der Benutzeraccount zu einer Gruppe mit den entsprechenden Berechtigungen gehört, um die Aktionen im gewünschten Plan auszuführen. Weitere Informationen zu dem Service finden Sie in der Policy-Referenz.

Die Terraform-CLI gibt eine Fehlermeldung wie die Folgende zurück:

Error: 500-InternalError
Provider version: <provider_version>, released on <release_date>. This provider is <n> updates behind to current. 
Service: <service>
Error Message: Internal error occurred
OPC request ID: exampleuniqueID
Suggestion: The service for this resource encountered an error. Please contact support for help with service <service>

Der Service hat mit einem internen Fehler auf die Anforderung des Terraform-Providers geantwortet. Wenn Sie mit diesem Problem den Support kontaktieren, verweisen Sie auf die Informationen in der Meldung.