PhpStorm 2020.2ヘルプ

Vagrant: 再現可能な開発環境の使用

PhpStormはVagrant(英語)と統合され、悪影響ファイル構成ファイルで定義された再現可能な開発環境の作成を支援します。仮想ボックスの作成と削除Vagrantボックスの初期化、Vagrant構成ファイルから設定を読み取ることによるリモートインタープリターの構成、およびIDEを移動せずに他のVagrantコマンドを実行できます。vagrant upコマンドを実行するときに、複数の仮想ボックスの中から選択することもできます(複数のVagrant構成)。

PhpStormの文脈では、以下の用語をバラント特有の概念を示すために使用します。

  • PhpStormユーザーインターフェースのVagrantボックスまたは現在のドキュメントのVagrantベースボックスは、ネイティブVagrant用語のボックス(英語)です。これは、特定の環境がマシン上でカスタマイズ、プロビジョニング、およびデプロイされるベースとなる純粋なイメージ、スケルトンを示します。

  • インスタンス仮想マシンです。つまり、Vagrantベースボックスをベースにして悪影響ファイルに従ってマシン上でカスタマイズ、プロビジョニング、およびデプロイされる特定の環境です。他の同様の製品やドキュメントでは、インスタンス仮想マシンと呼ばれます。

  • インスタンスフォルダーは、初期化後に関連する悪影響ファイルが格納され、PhpStormがそれを探すフォルダーです。デフォルトでは、プロジェクトのルートフォルダーです。

Vagrantでの作業の準備

始める前に、以下のステップとチェックが行われていることを確認してください。

  1. コンピューターにVagrant(英語)OracleのVirtualBox(英語)がインストールされていて、実行可能ファイルの親フォルダーがシステム PATH 変数に追加されていることを確認してください。標準インストール手順に従った場合、これらのフォルダーは自動的に追加されます。

  2. 次の実行可能ファイルの親フォルダーがシステムPATH 変数に追加されていることを確認します。
    • Vagrantインストールからのvagrant.batまたは浮浪者。これは、Vagrantインストーラーによって自動的に行われます。

    • OracleのVirtualBoxインストールからのVBoxManage.exeまたはVBoxManage

設定/環境設定ダイアログ Ctrl+Alt+Sで、Vagrant設定を確認または変更します。

  1. ツールVagrantをクリックします。Vagrantページページが開きます。

  2. Vagrant実行ファイルを指定してください。実行可能ファイルの親フォルダーはすでにシステムPATH変数に追加されているため、実行可能ファイルの名前だけを入力してください。

  3. インスタンス・フォルダーフィールドで、悪影響ファイルが初期化されて保存されているディレクトリへの完全修飾パスを指定します。悪影響ファイルは、必要なインスタンス仮想マシン)を定義する構成ファイルです。このファイルには、仮想IPアドレス、ポートマッピング、および割り当てるメモリサイズが含まれています。ファイルでは、共有するフォルダーとインストールするサードパーティソフトウェアを指定できます。悪影響ファイルに従って、インスタンス仮想マシン)が構成され、関連するVagrantベースボックスに対してプロビジョニングされ、コンピューターにデプロイされます。悪影響ファイルは、vagrant init コマンドによって作成されます。

    vagrant up コマンドまたはツール | Vagrant | Upメニューオプションを使用してインスタンス仮想マシン)の作成が呼び出されると、PhpStormはインスタンス・フォルダーフィールドで指定されたディレクトリで悪影響ファイルを探します。詳細については、http://docs.vagrantup.com/v2/vagrantfile/(英語)を参照してください。

    悪影響ファイルを任意のディレクトリに作成し、インスタンスフォルダーとして指定できます。フィールドが空の場合、PhpStormはプロジェクトルートインスタンスフォルダーとして扱い、その中で悪影響ファイルを探します。

  4. Vagrantボックス領域で、PhpStormで使用可能な事前定義のVagrantベースボックス(英語)のリストを設定します。各アイテムは、Vagrantがインスタンス仮想マシン)を構成して起動するVagrantベースボックスを示します。このリストのエントリは、コマンド vagrant box listの出力に対応しています。

    • 新しいベースボックスをダウンロードするには、追加ボタン Add the base boxをクリックします。開いたダイアログで、ベースボックスにアクセスするためのURLアドレスと、PhpStormで参照するための名前を指定します。デフォルトでは、PhpStormはlucid32ボックスへのURLを提案します。

      このコマンドは vagrant box add <name> <URL>に対応します。その結果、指定したベースボックスがマシンにダウンロードされます。

    • ベースボックスを削除するには、リストからボックスを選択し、除去ボタン Remove the base boxをクリックします。ベースボックスとネストされたファイルは、ディスクから物理的に削除されます。このコマンドは vagrant box remove <name>に対応します。

Vagrantファイルの初期化

悪影響ファイルは、必要なインスタンス仮想マシン)を定義する構成ファイルです。このファイルには、仮想IPアドレス、ポートマッピング、および割り当てるメモリサイズが含まれています。ファイルでは、共有するフォルダーとインストールするサードパーティソフトウェアを指定できます。悪影響ファイルに従って、インスタンス仮想マシン)が構成され、関連するVagrantベースボックスに対してプロビジョニングされ、コンピューターにデプロイされます。悪影響ファイルは、vagrant init コマンドによって作成されます。

悪影響ファイルは任意のフォルダーで初期化できます。このフォルダーは、設定 環境設定ダイアログのVagrantページでインスタンスフォルダーとして指定する必要があることに注意してください。そうしないと、インスタンス仮想マシン)の作成中にPhpStormが関連する悪影響ファイルを見つけることができません。

悪影響ファイルを初期化するには、次のいずれかを行います。

Vagrantファイルを初期化する

  1. 悪影響ファイルをプロジェクトルートに作成するには、メインメニューでツール | Vagrant | プロジェクトルートの初期化を選択し、開いたリストからターゲットプロジェクトルートを選択します。 init コマンドの出力は、実行ツールウィンドウに表示されます。

  2. 悪影響ファイルを特定のフォルダーに作成するには、埋め込まれたターミナルAlt+F12)を開き、次のコマンドを入力します。

    cd <directory to initialize the Vagrantfile in> vagrant init <base box name> <base box url>

悪影響ファイルが作成された後、エディターでそれをプレビューすることができます:それは利用可能な設定オプションの詳細なリストを含みます。必要に応じて構成設定を変更または追加します。コード補完がVagrantfileに対して有効になっていることに注意してください。

The initial view of the newly created Vagrantfile

悪影響ファイルの初期化が正常に完了すると、ベースボックスをインポートし、悪影響ファイルに従ってプロビジョニングしてデプロイし、独自のインスタンス仮想マシン)を作成する準備が整います。

インスタンスの作成と起動 (仮想マシン)

インスタンス仮想マシン)の作成とは、インスタンスフォルダーにある悪影響ファイルに従ってベースボックスをインポートおよびプロビジョニングすることです。

インスタンスを作成し、次の手順に従います。

  1. 以下のいずれか 1 つを実行します:

    • インスタンスをプロジェクトルートに作成するには、ツール | Vagrant | Upに進みます。

    • 特定のフォルダーにインスタンスを作成するには、埋め込みターミナルAlt+F12)を開き、次のコマンドを入力します。

      cd <instance folder> vagrant up
  2. 候補リストから目的の仮想マシン構成を選択します。

    Select VM configuration

インスタンスの停止、一時停止、再開、再ロード、破棄 (仮想マシン)

インスタンスをリロードする

  • 悪影響ファイルに何らかの変更を加え、それに従って実行中の仮想マシンを更新したい場合は、メインメニューでツール | Vagrant | 再ロードを選択するか、内蔵ターミナルで次のコマンドを実行してください。

    vagrant reload
    詳細は、http://docs.vagrantup.com/v2/cli/reload.html(英語)を参照してください。

インスタンスを中断する

  • 実行中の仮想マシン( ゲストマシン)のオペレーティングシステムを一時停止し、この時点での環境の正確な状態を保存して、この時点から正確に再開できるようにするには、メインメニューでツール | Vagrant | 中断を選択するか、次のコマンドを実行します。埋め込まれたターミナルで:

    vagrant suspend
    詳細は、http://docs.vagrantup.com/v2/cli/suspend.html(英語)を参照してください。

インスタンスを再開する

  • 仮想マシン( ゲストマシン)で以前にサスペンドされたオペレーティングシステムを再開し、サスペンド時に保存された状態から実行するには、メインメニューでツール | Vagrant | 再開を選択するか、埋め込まれたターミナルで次のコマンドを実行します。

    vagrant resume
    詳細は、http://docs.vagrantup.com/v2/cli/resume.html(英語)を参照してください。

インスタンスをシャットダウンする

  • 仮想マシン( ゲストマシン)のオペレーティングシステムをシャットダウンするには、メインメニューでツール | Vagrant | 停止を選択するか、埋め込まれたターミナルで次のコマンドを実行します。

    vagrant halt
    詳細は、http://docs.vagrantup.com/v2/cli/halt.html(英語)を参照してください。

  • 仮想マシン( ゲストマシン)のオペレーティングシステムをシャットダウンし、仮想マシン自体を停止して、vagrant upの作成中にプロビジョニングされたリソースを削除するには、メインメニューでツール | Vagrant | 破棄を選択するか、組み込みターミナルで次のコマンドを実行します。

    vagrant destroy
    詳細は、http://docs.vagrantup.com/v2/cli/destroy.html(英語)を参照してください。

最終更新日: 2020年8月19日