Terraformプロバイダのトラブルシューティング

更新不可能なリソース・プロパティをTerraform構成で更新しようとすると、既存のOCIリソースが破棄され、再作成されることがあります。変更によってリソースが破棄される場合、Terraformによって警告が表示されます。変更を適用する前に必ずterraform planを実行し、影響を受けるリソースを確認してください。詳細は、破壊的な変更を参照してください。

OCIリソースを更新するときにリソースを強制的に破棄してから再作成する必要がある場合がありますが、別のリソースがそのリソースに依存しているために操作を実行できません。

たとえば、oci_core_instance_configurationリソースを更新する必要があるが、インスタンス・プールがそのインスタンス構成を使用している場合などです。必須の引数でインスタンス・プールがインスタンス構成を参照しているため、このインスタンス構成は削除できません。

このタイプの動作を回避するには、リソース・ブロックでlifecycleおよびcreate_before_destroyメタ引数を使用できます。

この例では、Terraformは更新を含む2番目のoci_core_instance_configurationリソースを作成してから、新しいインスタンス構成を関連インスタンス・プールに割り当てます。最終的に、Terraformは元のインスタンス構成を破棄します。例:

resource "oci_core_instance_configuration" "test_instance_configuration" {
...

 lifecycle {
    create_before_destroy = true
  }
}

詳細は、lifecycleメタ引数および破壊的な変更を参照してください。

Terraform構成ファイルのresourceブロックにlifecycleおよびprevent_destroy = trueメタ引数を指定すると、OCIリソースが破棄されなくなります。たとえば、次の構成では、オブジェクト・ストレージ・バケットを破棄できません:

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

  lifecycle {
    prevent_destroy = true
  }
} 

このメタ引数は、terraform destroyを使用できないようにします。特定の構成の更新では、適用前にリソースを破棄する必要があるため、この設定では更新も適用できなくなる可能性があります。この例では、nameは、リソースを破棄して再作成しないと更新できないプロパティです。そのため、lifecycleメタ引数を削除または変更しないと、バケットの名前を更新できません。

詳細は、「The lifecycle Meta-Argument」を参照してください。

OCI Terraformプロバイダで管理されるOracle Cloud Infrastructureリソースの多くでは、オプションの構成引数を使用できます。一度設定すると、リソースの作成時であるか後続の更新時であるかに関係なく、空の文字列を渡したり、構成から引数を削除したりしても、これらの引数の設定を解除することはできません。これらの引数の設定を解除しようとしても、Terraformでは無視されます。

Terraform v0.14以降では、構成ファイル内のグローバル変数を、ローカル変数とトリガーの組合せに置換することが必要な場合があります。lifecycleおよびignore_changesメタ引数のトリガーを参照し、後続のTerraform適用操作で構成が実行されないようにするには、次のようにしてトリガーを参照します:

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

デフォルトでは、destroyコマンドを使用しても、Terraformプロバイダではコンパートメントは削除されません。

プロバイダでコンパートメントの削除を試行するには、enable_delete引数をtrueに設定する必要があります。例:

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

    enable_delete = true
}

Terraform CLIで次のようなエラー・メッセージが返された場合:

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)

この場合、指定されたOCIサービスは、しばらくポーリングした後で、リソースがまだ予定された状態になっていないことを示しています。

状況によっては、さらにポーリングを続行するため、リソースの操作タイムアウトを増やす必要があります。この実行方法の詳細は、操作タイムアウトを参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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>

この場合、指定されたOCIサービスで不明なエラーが発生しています。再試行するか、そのサービスに関してサポートに連絡してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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

インストールされているTerraformバイナリと互換性のないOCI Terraformプロバイダのバージョンを使用している可能性があります。OCIプロバイダ・バージョンがv3.x.x以上の場合、v.0.10.1以上のTerraformバージョンが必要です。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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

この場合、プロキシ設定が正しく構成されていない可能性があります。OCI Terraformプロバイダでは、http_proxy、https_proxyおよびno_proxy変数がサポートされており、包含リストまたは除外リストを次のように定義できます:

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

Terraform CLIで次のようなエラー・メッセージが返された場合:

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

Terraformが信頼できるTLS証明書を使用しており、証明書チェーンが有効であることを確認してください。詳細は、「x509: certificate signed by unknown authority」エラーで失敗するTerraformの実行を参照してください。MacOS Catalinaを使用している場合、証明書問題の解決の詳細は、ドキュメントのMacOSの項を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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

このメッセージは、新しいGPGキーで署名されたTerraformプロバイダのバージョンが、Terraformレジストリで除外されていることを意味します。Terraform CLIでは、正常に検証できるOCI Terraformプロバイダの最新バージョンがインストールされますが、それが最新バージョンではない場合があります。

このメッセージを削除し、最新バージョンのOCI Terraformプロバイダを使用できることを確認するには、使用している主なTerraformバージョンで使用可能な最新のメンテナンス・リリースにTerraform CLIをアップグレードします。たとえば、Terraform v0.12.21を使用している場合は、使用可能な最新バージョンであるv0.12にアップグレードします。

モジュールを使用していて、Terraform CLIから次のようなエラー・メッセージが返された場合:

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

各モジュールが独自のプロバイダ要件を宣言していることを確認します。詳細は、「モジュール内のプロバイダ」を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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>

• user_ocid、tenancy_ocid、fingerprintおよびprivate_key_pathが正しく設定されていることを確認します。
• private_key_pathが、対応する公開キーではなく、秘密キーを指していることを確認します。
• user_ocidで指定したユーザー・アカウントに、対応する公開キーが追加されていることを確認します。
• 使用している公開キーと秘密キーのペアが正しいフォーマットであることを確認します。正しいフォーマットおよびキーの生成方法の詳細は、必要なキーを参照してください。
• ユーザー・アカウントが、実行中のプランでアクションを実行するための適切な権限を持つグループに含まれていることを確認します。
• テナンシが、プランでターゲット指定しているリージョンにサブスクライブされていることを確認します。
• モジュールを使用している場合は、各モジュールが独自のプロバイダ要件を宣言していることを確認します。詳細は、「モジュール内のプロバイダ」を参照してください。

Terraform CLIが次のようなメッセージを返す場合、環境に問題があることを示している可能性があります:

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

プロバイダ構成に別名が含まれている場合は、provider = "oci.alias_name"を使用して、リソースでプロバイダ別名を明示的に指定する必要があります。リソースでプロバイダの指定に別名を使用しない場合、Terraformでは、そのようなリソースで使用するデフォルトのプロバイダが作成されます。デフォルトのプロバイダでは、環境変数または~/.oci/configファイルから構成値がロードされます。これらの値は、別名で指定されたプロバイダで使用される値と異なる場合があり、構成エラーの原因になります。

プロバイダ構成の別名を削除するか、すべてのリソースで適切な別名でプロバイダが指定されていることを確認してください。aliasの使用方法の詳細はTerraformの公式ドキュメントで確認し、Terraformで環境変数やOCI構成ファイルがどのように使用されるかについての詳細は、「プロバイダの構成」を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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

OCI Terraformプロバイダの古いバージョンを使用している可能性があります。設定しようとしているフィールドは、より新しいバージョンでリリースされています。次のコマンドを使用して、Terraformプロバイダのバージョンを確認してください。

terraform -version

OCI Terraformプロバイダのドキュメントは、最新バージョンを反映しています。

インポート中のoci_database_db_systemにプライマリのdb_homeがない場合は、Terraform状態ファイルにdb_homeの空のプレースホルダが設定されます。インポートされた状態と構成の一貫性を保つため、db_homeの空のプレースホルダを構成に追加します。例:

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

リソース検出の使用時に、Terraform CLIから次のようなエラー・メッセージが返された場合:

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

この場合は、provider_bin_path環境変数で既存のローカル・プロバイダ・バイナリの場所を指定することにより、Terraformでは確実にそのバイナリが使用されます。例:

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

リソース検出を使用すると、Terraformでは、OCI Terraformプロバイダの最新バージョンのダウンロードが試行されます。

terraform applyの実行時に、OCI Terraformプロバイダで、既存のタグのデフォルトがリソースから予期せず削除されることがあります。この問題は、特にOracle-Tagsの自動タグのデフォルトに影響します。

この問題を回避するには、プロバイダ・ブロックにignore_defined_tags属性を追加できます。

ignore_defined_tags属性を使用すると、Terraformが計画の一部として無視するか適用する定義済タグのキーをリストアウトできます。ignore_defined_tags属性はプロバイダ・レベルでのみ指定でき、最大許容サイズは100です。この属性で指定したタグは、そのTerraformファイル内のすべてのリソースで無視されます。

次の例で、"Oracle-Tags.CreatedOn"と"Oracle-Tags.CreatedBy"は、リモート・リソースに関連付けられたdefined_tagsマップ内のキーです:

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

詳細は、プロバイダ定義および関連するGitHubの問題を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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>

エラー・メッセージで指定されたパラメータを、リソースのTerrform構成で更新します。

Terraformの使用中に、リソースのサービス制限に達したか制限を超えたことを示すエラーが発生する場合があります。例:

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>

OCIサービス制限および制限の引上げをリクエストする方法の詳細を理解するには、サービス制限を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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>

ユーザー・アカウントが、実行中のプランでアクションを実行するための適切な権限を持つグループに含まれていることを確認します。詳細は、サービスの「ポリシー・リファレンス」を参照してください。

Terraform CLIで次のようなエラー・メッセージが返された場合:

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>

サービスは、Terraformプロバイダからのリクエストに内部エラーで応答しています。この問題についてサポートに連絡する場合は、メッセージ内の情報を参照してください。