Terraform
Terraform(英語) は、開発者と運用チームが手動設定ではなく宣言型構成ファイルを使用してクラウドのリソースとインフラストラクチャを定義、管理、プロビジョニングできるようにする、インフラストラクチャアズコードツールです。
Terraform を使用すると、仮想マシン、ネットワーク、ストレージなどのインフラストラクチャリソースをコードで記述できます。 Terraform は、これらのリソースを自動的に作成および管理します。 このアプローチにより、インフラストラクチャのバージョン管理、レビュー、再現が容易になり、開発、テスト、本番環境全体で一貫性のある環境を維持できるようになります。
Terraform and HCL プラグインをインストールする
この機能は、インストールして有効にする必要がある Terraform と HCL(英語) プラグインに依存しています。
Ctrl+Alt+S を押して設定を開き、 を選択します。
Terraform and HCL プラグインを見つけて、 インストール をクリックします。 プロンプトが表示されたら IDE を再起動します。
Terraform 実行パスを指定する
実行構成を使用して IDE から Terraform コマンドを実行するには、マシンに Terraform がインストールされている必要があります。
Ctrl+Alt+S を押して設定を開き、 を選択します。
ほとんどの場合、PhpStorm は Terraform 実行ファイルへのパスを自動的に検出します。 IDE が実行ファイルのバージョンとパスを検出しない場合は、 検出とテスト をクリックしてください。
マシンに Terraform がインストールされていない場合は、 インストール をクリックします。

必要に応じて、 Terraform 実行可能パス フィールドに Terraform へのパスを手動で指定できます。
Terraform ファイルの作成
PhpStorm では、いくつかの Terraform ファイル形式に対してあらかじめ設定されたテンプレートが提供されています。 ファイルを作成するには、 Project ツールウィンドウでディレクトリを右クリックし、 を選択します。 これにより、使用可能な Terraform ファイルテンプレートから選択できるダイアログが開きます。

ファイル拡張子 | ファイルテンプレート | 説明 |
|---|---|---|
.tf | 構成 | Terraform 構成ファイル。 |
.tfcomponent.hcl | コンポーネント | Terraform コンポーネントファイル。 |
.tfdeploy.hcl | デプロイ | Terraform デプロイファイル。 |
.tftest.hcl | テスト | Terraform テストファイル。 |
Terraform の構成には、複数の環境や相互接続されたコンポーネントが含まれることがよくあります。 設定は Terraform ワークスペース(英語)と Terraform スタック(英語)として構成でき、どちらも PhpStorm でサポートされています。
Terraform スタック
Terraform Stacks は、 .tfstack.hcl 、 .tfcomponent.hcl 、 .tfdeploy.hcl の拡張機能を利用します。
PhpStorm は、スタック固有の構成要素に対するコーディング支援を提供します。 IDE では、スタックのルートブロックやプロパティの補完、必要なプロパティの自動挿入、欠落プロパティのハイライトが行われます。
Terraform テスト
PhpStorm は、インフラストラクチャコードのテストのために Terraform テストフレームワークをサポートしています。
PhpStorm は、Terraform テストファイル( .tftest.hcl )と、テストから参照できる再利用可能なモック定義( .tfmock.hcl )を認識し、コーディング支援を行います。
Terraform テンプレートファイル
IntelliJ IDEA は、通常 .tftpl 拡張子を使用する Terraform テンプレートファイルのサポートを提供します。
ライブテンプレートを使用するには、Terraform テンプレートファイルに if または for と入力し始めます。

テンプレートファイルへ移動
Terraform ファイルでは、 templatefile(英語) 関数を使用してテンプレートを挿入できます。 IntelliJ IDEA を使用すると、Terraform ファイルからテンプレートファイルにすばやく移動できます。
Terraform ファイルで、
templatefile関数を見つけます。キャレットをテンプレートファイル名に置き、 Ctrl+B を押します。
テンプレートデータの言語を選択
テンプレートファイルの拡張子 (file.<lang>.tftpl) で言語が指定されている場合、この言語がデータ言語として使用されます。 例: file.js.tftpl では、JavaScript が使用されます。 データ言語が指定されていない場合 (たとえば、 file.tftpl )、テンプレートファイルはプレーンテキストとして認識されます。
ファイル構文がそれに応じて認識されるようにしたい場合は、データ言語を選択(または検出された言語を変更)できます。
エディターでファイルタブを右クリックし、 <Language> テンプレートデータ言語を次のように変更します (たとえば、 JavaScript テンプレートデータ言語を次のように変更します または プレーンテキストテンプレートのデータ言語 を) を選択します。
または、ファイル内の Alt+Enter (コンテキストアクションの表示) を押して、 テンプレートデータ言語の選択 を選択します。
開いた言語リストから、言語を選択します。
Terraform 変数
Terraform 変数定義ファイルは、通常 .tfvars 拡張機能を使用します。 これらのファイルを使用して、Terraform 構成で宣言された変数の値を設定します。
Terraform ファイルの編集
IDE は、コアとなる Terraform 要素とプロバイダ定義の概念に関するスマートなコードインサイトを提供することで、生産性を維持し、インフラストラクチャコードをより迅速に、より少ない注意散漫で記述できるように支援します。 これには、次の機能が含まれます。
設定 ダイアログ (Ctrl+Alt+S) の ページと ページで色設定をカスタマイズできます。
PhpStorm は、既知のプロバイダ、プロバイダ関数、リソース、データソース、アクション、引数など、Terraform ファイル内での補完機能を提供します。

プロバイダ要件を設定する際、IDE は
required_providersブロック内のsourceやversionなどの関連属性とともに、利用可能なプロバイダを提案します。 これにより、Terraform 仕様に従って要件を定義できます。 プロバイダ要件の詳細については、 Terraform のドキュメント(英語)を参照してください。Terraform スタックファイルでは、PhpStorm がスタックルートブロックとそのプロパティの補完機能を提供します。 必要なプロパティは自動的に挿入され、不足しているプロパティは IDE によってハイライトされます。
.tfcomponent.hcl ファイルでは、PhpStorm はプロバイダ宣言と構成、および
componentおよびstackブロックで使用されるモジュール変数とプロバイダの補完をサポートします。ローカルで実行されるディープラーニングモデルを使用して、コード行全体を補完します。

ページの 設定 ダイアログ (Ctrl+Alt+S) で、Terraform の行全体コード補完を無効にすることができます。
要素とそのすべての使用箇所の名前を変更するには、 Shift+F6 を押します。
構造 ツールウィンドウを使用して、Terraform ファイルをすばやくプレビューおよび移動します。

ツールウィンドウは、 または Alt+7 を押すことで使用できます。
引数の上にマウスを置くと、その引数に関する簡単なドキュメントが表示されます。

詳細については、 Shift+F1 を押して、Terraform レジストリ (このドキュメントのソース) を開くこともできます。
Terraform インスペクションを使うことで、重複、競合、非推奨または欠落している要素、未解決の参照、不明なリソースなどを検出できます。

の 設定 ダイアログ (Ctrl+Alt+S) で、すべての Terraform、インスペクションを確認できます。
コーディング支援には、ブレースマッチング Ctrl+Shift+M 、コードの折りたたみ Ctrl+NumPad +/Ctrl+NumPad - 、行コメントの追加 Ctrl+/ 、ブロックコメントの追加 Ctrl+Shift+/ 、および Terraform ファイルへの コピーライト テキストの挿入 も含まれます。
Terraform の実行
Terraform と HCL プラグインは、Terraform 専用の実行構成を提供します。 これらの実行構成を使用すると、引数の追加や環境変数の受け渡しなど、 terraform コマンドの実行をカスタマイズできます。
ガターアイコンを使用して Terraform を実行する
Terraform ファイルで、ガターの
をクリックします。
開いたウィンドウで、実行プランを作成する場合は プラン を選択し、すでに Terraform プランがありそれを適用する場合は 適用 を選択します。

このディレクトリに対して Terraform 初期化手順が実行されていない場合は、 実行 ガターアイコンに警告サインが表示されます。 この場合、IntelliJ IDEA は、 terraform plan または terraform apply を実行する前に terraform init コマンドを実行することを提案します。
ガターアイコンから Terraform を実行すると、一時的な実行構成が作成されます。 実行ウィジェットで をクリックし、 Save Configuration を選択すると、永続的な構成として保存できます。
Terraform 実行構成を手動で作成する
に進みます。 または、 Alt+Shift+F10 を押してから 0 を押します。
新規構成の追加 ボタン (
) をクリックし、 Terraform の入力を開始します。

実行構成のタイプを選択します:
テラフォーム初期化 は
terraform initコマンドを実行しますTerraform 検証 は
terraform validateコマンドを実行しますTerraform 計画 は
terraform planコマンドを実行しますTerraform 適用 は
terraform applyコマンドを実行しますTerraform 破壊 は
terraform destroyコマンドを実行しますTerraform は、他の Terraform コマンドを提供することができます。
Command リストで、Terraform コマンドを選択します。 このリストに含まれていないコマンドを実行するには、 カスタム を選択し、 プログラム引数 フィールドに指定します。
実行構成に名前を付け、必要に応じて作業ディレクトリを変更します。 環境変数を使用する場合は、 環境変数 フィールドに指定するか、ファイルを選択してそこから変数を使用します。
Terraform コードを再フォーマットする
IntelliJ IDEA を使用すると、Terraform ファイルにコードスタイルを適用できます。 IntelliJ IDEA には 2 つのフォーマットツールが含まれています。
Terraform フォーマッタを使用する
Terraform フォーマットツール (terraform fmt) は Terraform コードスタイル(英語)に基づいています。 .tf および .tfvars ファイルに適用されます。
Terraform フォーマットツールを使用するには、 Terraform をインストールするが必要です。
メインメニューで へ移動します。
または、 Ctrl+Alt+Shift+F を押します。
Terraform フォーマッタ terraform fmt はファイル全体に適用されますが、 IntelliJ IDEA フォーマッターは選択したコード部分に適用することもできます。
PhpStorm フォーマッタを使用する
IntelliJ IDEA フォーマッタは、 Terraform と HCL プラグインによって提供される IntelliJ IDEA コードスタイルに基づいています。 このコードスタイルは、IDE 設定の でカスタマイズできます。
.tf および .tfvars に加えて、 .hcl ファイルにも適用されます。
ファイルを再度フォーマットするには、エディターでファイルを開き、メインメニューで に移動します。 または、 Ctrl+Alt+Shift+L を押します。
または、 アクションの検索… (Ctrl+Shift+A) ダイアログで
ファイルの整形と入力し始め、リストからアクションを選択します。コードの一部を再フォーマットするには、コードの一部を選択し、メインメニューで に移動します。 または、 Ctrl+Alt+L を押します。
または、 アクションの検索… (Ctrl+Shift+A) ダイアログで
コードの整形と入力し始め、リストからアクションを選択します。
Terraform プロバイダーのメタデータをリフレッシュ
Terraform と HCL プラグインには特定のバージョンのプロバイダーメタデータが付属しており、既知のプロパティやインスペクションの補完などのコーディング支援が可能になります。
プロジェクトで異なるプロバイダーバージョンを使用する場合 (たとえば、 required_providers ブロックで変更した後)、 terraform init を実行してプロジェクトを初期化します。
で ローカルメタデータを自動的にビルドするオプションが有効になっている場合、PhpStorm はローカルプロバイダーのメタデータを自動的に再生成します。 このオプションが無効になっている場合は、メタデータを手動でリフレッシュできます。
プロバイダーのメタデータを手動でリフレッシュする
プロジェクトを初期化した後、次のいずれかを実行します。
Terraform 構成ファイルを開き、エディター内の任意の場所を右クリックします。
Project ツールウィンドウ (Alt+1) を開き、Terraform 構成ファイルを右クリックします。
コンテキストメニューから を選択します。

詳細設定
- Terraform ドキュメントを自動的にダウンロードする
デフォルトでは、IntelliJ IDEA は Terraform Registry から Terraform プロパティのクイックドキュメントをダウンロードします。 ネットワークやパフォーマンスに問題がある場合は無効化でき、代わりに IntelliJ IDEA がメタデータから説明を表示します。 このような説明を利用できるかどうかは、リソースの開発者によって異なります。
- ローカルメタデータを自動的にビルドする
有効化すると、
terraform initを実行した後に IntelliJ IDEA がローカルプロバイダーのメタデータを自動的に再生成します。 これにより、コーディング支援で構成ファイルに定義されたプロバイダーのバージョンが使用されるようになります。- 変数を深く検索する
Terraform で変数を使用する場合、IntelliJ IDEA はプロジェクト内のすべての Terraform ファイルで変数定義をチェックします。 IntelliJ IDEA でルートディレクトリ(
.terraform.lock.hclがあるディレクトリ)内のファイルのみ確認したい場合は、チェックボックスをオフにしてください。
Terraform コードスタイル設定
Terraform 固有のコードスタイル設定は で使用できます。
- 整形しながらプロパティの位置を揃える
プロパティとその値の配置方法を選択します: 等号を揃える、値を揃える、または何も揃えない。
- 行コメンターのシンボル
Ctrl+/ を押したときに単一行コメントに使用するシンボルを選択します。
- 補完時にプロバイダーを自動的にインポートする
リソース名を入力したら、現在のファイルにプロバイダー要件を挿入します。
required_providersブロックが不足している場合は追加してください。- 整形に 'terraform/tofu fmt' を起動する
を呼び出すときに Terraform (または OpenTofu) フォーマッターを実行します。
