ローカルの JetBrains IDE を使用してコードを開発する

Cloud Workstations プラグインを使用すると、IntelliJ IDEA Ultimate、PyCharm Professional、Rider、CLion、PhpStorm、WebStorm などの JetBrains IDE を使用して、Cloud Workstations のリモート開発セッションを開始できます。

サポートされているオペレーティング システム

Cloud Workstations プラグインは、次のオペレーティング システムをサポートしています。

  • Windows
  • macOS（Intel および Apple Silicon）
  • Linux

サポート対象バージョン

Cloud Workstations プラグインは、JetBrains IDE と JetBrains Gateway の最新バージョンと 1 つ前のバージョンをサポートします。新しい JetBrains IDE メジャー バージョンがリリースされると、次の Cloud Workstations プラグイン リリースは新しいバージョンをサポートし、以前にサポートされた最も古いバージョンのサポートは終了します。

JetBrains アプリを最新の状態に維持しやすくするために、JetBrains Toolbox をインストールすることもできます。

事前構成されたベースイメージの JetBrains IDE バージョンの詳細については、Cloud Workstations リリースノートをご覧ください。

準備

Cloud Workstations プラグインをインストールする前に、次の手順を実施してください。

  1. ワークステーションの作成の手順に従います。 [構成] のプロンプトが表示されたら、使用する JetBrains IDE に対応するイメージを選択します。

  2. ワークステーションの名前を入力したら、[作成] をクリックします。

  3. [ワークステーション] ページをクリックし、ワークステーションの作成が終了するまで待ちます。

  4. JetBrains Gateway のサポート対象のバージョンをダウンロードしてインストールします。

Cloud Workstations プラグインをインストールする

  1. Cloud Workstations プラグインをインストールします。

    1. JetBrains Gateway を開きます。

    2. [すべてのプロバイダ] を選択します。

    3. [プロバイダを追加] セクションで [Google Cloud] を見つけて、[インストール] をクリックし、Cloud Workstations プラグインをダウンロードします。

      Cloud Workstations に接続する

  2. インストール後、[IDE をリモートで実行] セクションに [Cloud Workstations] が表示されます。

Cloud Workstations プラグインを使用して接続する

プラグインを使用してワークステーションに接続するには、次の手順に沿って操作します。

  1. JetBrains Gateway を開きます。

  2. [IDE をリモートで実行] セクションで、[Google Cloud に接続] をクリックします。

  3. [ログイン] をクリックして Google アカウントにログインします。

    1. 表示された指示に従って、Cloud Workstations プラグインに Google Cloud へのアクセス権を付与します。

    2. [続行] をクリックしてログインを完了します。

  4. [参照] をクリックしてプロジェクト セレクタのダイアログを開き、クラウド プロジェクトを選択します。

    Cloud Workstations に接続する

  5. クラウド プロジェクトの下にあるワークステーションを選択し、[次へ] をクリックして、選択したワークステーションが開始するのを待ちます。

  6. IDE とプロジェクトを選択します。

    1. リモートホストの IDE バージョンを選択します。

    2. リモートホストの IDE プロジェクト パスを入力します。

      IDE を選択し、プロジェクト名を入力します。

  7. [接続] をクリックし、IDE とプロジェクトが開くのを待ちます。

ワークステーションに再接続する

ワークステーションと IDE プロジェクトにすばやく再接続するには:

  1. 最近の [接続] パネルを開きます。

  2. プロジェクト パスをクリックして、Cloud Workstations で IDE を開きます。

    最近使用したワークステーションのリスト

  3. IDE とプロジェクトが開くのを待ちます。

ポート転送を使用する

IDE とプロジェクトで JetBrains クライアントを開いたら、ローカルマシンから Cloud Workstations のリモートポートにアクセスできます。たとえばワークステーションで Python サーバーを実行する場合、python -m SimpleHTTPServer 8080。場合によっては、JetBrains Gateway が自動的にポート転送を行い、ローカル ブラウザからリモートで実行されているプロジェクトにアクセスできるようにします。

次のようにして、Cloud Workstations からローカルマシンに手動でポート転送を行うこともできます。

  1. Windows または Linux の場合は、メインメニューから [ファイル] > [設定] を選択します。

    macOS の場合は、メインメニューから [IntelliJ IDEA] > [設定] を選択します。

  2. [ツール] > [ポート転送] に移動し、ポート 8080 の TCP を転送する新しいルールを追加します。

  3. このルールを設定すると、http://localhost:8080 で Cloud Workstations のポート 8080 にローカルでアクセスできます。

API エンドポイントをオーバーライドする

API エンドポイントをオーバーライドする必要がある Virtual Private Cloud ユーザーの場合、プラグインがクラウド サービスに接続できることを確認してください。API エンドポイントをオーバーライドする手順は次のとおりです。

  1. Windows と Linux で、[設定] オプション メニュー > [設定] をクリックします。

    macOS から [設定] [オプション メニュー] > [設定] をクリックします。

  2. 省略可: IntelliJ とその他の IDE の JetBrains 設定にアクセスするには、プロジェクト設定の構成をご覧ください。

  3. [ツール] > [Google Cloud Workstations] > [詳細] に移動します。

  4. API エンドポイントのオーバーライド URL を追加します。

  5. [Apply]（適用）をクリックします。

Google Cloud でのエンドポイントの使用について詳しくは、エンドポイントを介した Google API へのアクセスの Virtual Private Cloud の説明をご覧ください。

BYOID ユーザー向けの代替接続手順

BYOID を使用する場合は、Jetbrains Gateway に接続するための追加手順を行う必要があります。以下の手順に沿って登録してください。

ワークステーションを起動して TCP 接続を開く

次の手順でワークステーションを起動し、TCP 接続を開きます。

  1. 「始める前に」セクションの手順を実施します。

  2. ワークステーションが実行されていることを確認します。次の gcloud CLI コマンドで起動できます。

    gcloud workstations start WORKSTATION_ID –-project=PROJECT \
  --cluster=WORKSTATION_CLUSTER_ID --config=WORKSTATION_CONFIG_ID \
  --region=WORKSTATION_CLUSTER_REGION

  3. ポート 22 でワークステーションへの TCP トンネルを開始します。

    gcloud workstations start-tcp-tunnel --project=PROJECT \
    --cluster=WORKSTATION_CLUSTER_ID \
    --config=WORKSTATION_CONFIG_ID \
    --region=WORKSTATION_CLUSTER_REGION \
    WORKSTATION_ID 22 --local-host-port=127.0.0.1:2222

初期設定とインストールが完了したら、次のステップとして Jetbrains Gateway を起動します。

Jetbrains Gateway を起動する

  1. Jetbrains Gateway を起動したら、[SSH で接続] を選択します。

  2. [SSH で接続] ページで、 [設定] をクリックして新しい接続を設定します。

    SSH 構成ページで:

    1. [Add a new connection] をクリックします。
    2. 接続情報を入力します。例: Local Host=127.0.0.1、Port=2222、Username=user。必ず、ローカルホスト、ポート、ユーザー名の構成に適した値を使用してください。
    3. [認証タイプ] を [パスワード] に設定し、パスワード フィールドを空白のままにします。
    4. [Parse config file ~/.ssh/config] のオプションをクリアします。
    5. [OK] をクリックして接続を作成します。
    6. [Check Connection and Continue] をクリックします。

  3. [Choose IDE and Project] ページで、以下を選択します。

    1. 使用する IDE を選択します。

    2. more_horiz [その他] をクリックして、プロジェクトを含むディレクトリを選択します。このメニューからプロジェクトを作成することはできません。プロジェクトを開くことしかできません。新しいプロジェクトを作成するには、[Open an SSH Terminal] を選択し、コマンドを実行して JetBrains プロジェクトのディレクトリを作成します。

      あるいは、[Open an SSH Terminal] をクリックして、ワークステーション内で git コマンドを実行することもできます。たとえば、次のコマンドは、Cloud Code のサンプル プロジェクトのクローンをホーム ディレクトリに作成します。

      git clone https://github.com/GoogleCloudPlatform/cloud-code-samples.git

    3. プロジェクト ディレクトリを選択したら、[Download and Start IDE] をクリックします。

  4. IDE に接続すると、Jetbrains IDE からワークステーションのファイルに直接アクセスできます。Jetbrains IDE では、コードのビルドと実行を支援する Cloud Workstations の拡張機能を使用することもできます。