Cloud Code for IntelliJ で Secret Manager を使用してシークレットを管理する

Secret Manager を使用すると、コードベースにシークレットを保存しないようにできます。その代わりに、シークレットを Secret Manager に保存し、必要に応じてプログラムでこれを取得します。Cloud Code の Secret Manager 統合を使用すると、シークレットを簡単に作成、表示、更新、使用できます。

このページでは、IDE 内で Secret Manager にアクセスする方法と、Secret の作成と管理を開始する方法について説明します。

Secret Manager を有効にする

Secret はアプリケーション コードと同じプロジェクトに配置する必要があり、プロジェクトに対して Secret Manager API を有効にする必要があります。

  1. Secret Manager を起動するには、Cloud Code の右側のサイドバーで [Secret Manager] タブをクリックするか、[Tools] > [Cloud Code] > [Cloud Secret Manager] に移動します。

    右側のサイドバーでハイライト表示されている Cloud Code の [Secret Manager] タブと [Secret Manager] ペインが開き、3 つの Secret が一覧表示され、下部のペインに「テスト」という名前の Secret のバージョンに関する詳細情報が表示される

  2. Secret Manager API を有効にしていない場合は、Cloud Code のプロンプトで [API を有効にする] をクリックして有効にします。

    Secret Manager ペイン内の API リンクを有効にする

Secret の作成と表示

Secret の作成

次のいずれかの方法で Secret を作成できます。

[Secret Manager] ペインの使用

  1. [Secret Manager] ペインに移動します。

  2. [+ Add] をクリックします。

  3. [Secret の作成] ダイアログで、Secret を構成して [OK] をクリックします。

    [名前] フィールドに「life」、[Secret の値] フィールドに「42」と入力された [Secret を作成] ダイアログが開きます。

エディタを使用する

  1. エディタで Secret として保存するテキストを含むファイルを開きます。
  2. Secret として保存するテキストをハイライト表示し、テキストを右クリックして、[Secret Manager で Secret を作成] をクリックします。
  3. [Secret の作成] ダイアログで、Secret を構成して [OK] をクリックします。

プロジェクト エクスプローラを使用する

  1. プロジェクト エクスプローラで、テキストをハイライト表示せずに右クリックし、[Create Secret in Secret Manager] をクリックします。

  2. [Secret の作成] ダイアログで、Secret を構成して [OK] をクリックします。

Secret の新しいバージョンを作成する

既存の Secret を更新するには、Secret の新しいバージョンを作成します。

  1. [Secret Manager] ペインでシークレットを右クリックして、[新しいバージョン] をクリックします。

  2. [新しいバージョンを追加] ダイアログで、[Secret の値] フィールドを使用するか、ファイルをインポートして、既存の Secret の値を設定します。

    Secret の Secret 値フィールド「test-secret」が「bar」に更新された新しいバージョン ダイアログを追加する

  3. Secret の以前のすべてのバージョンを削除して、作成する新しいバージョンのみを保持するには、[過去のバージョンをすべて無効にする] を選択します。

  4. [OK] をクリックします。バージョンを追加すると、最新のシークレット バージョンを確認できます。該当する場合は、[バージョン] タブにシークレットのすべてのバージョンが一覧表示されます。

Secret の表示

Secret を表示するには、[Secret Manager] ペインで、[Secret Name] セクションに表示されているリストから Secret を選択します。名前、レプリケーション ポリシー、作成タイムスタンプ、リソース ID などの詳細は、[概要] タブに一覧表示されています。

ブラウザで Secret を表示および管理するには、Secret を右クリックして [Cloud Console で開く] を選択します。

アプリケーションから Secret にアクセスする

Secret を作成したら、コードに追加して認証を設定できます。

コード内で Secret にアクセスする手順を示した Secret Manager ペインの [Code] タブ

新しく作成した Secret にアプリケーションからアクセスする方法は次のとおりです。

  1. [Secret Manager] ペインで、コードでアクセスする Secret の名前をクリックし、[コード] タブをクリックします。
  2. Secret Manager クライアント ライブラリをインストールします。
  3. [Secret Manager API] ページで、Google Cloud プロジェクトを設定し、Secret Manager API を有効にします（まだ有効にしていない場合）。
  4. 使用している言語に応じて、クライアント ライブラリのインストールの手順に従います。
  5. 関連するコード スニペットをカスタマイズして、アプリケーションのコードに追加します。
  6. サービス アカウントを使用している場合は、Secret Manager のシークレットにアクセスするために必要なロールを Google サービス アカウントに割り当てます。Secret Manager で使用できる IAM ロールの詳細については、Secret Manager のアクセス制御ガイドをご覧ください。
  7. 認証設定を完了するには、認証の設定の手順に従ってください。

サポートを受ける

IntelliJ IDE でフィードバックを送信するか、問題を報告するには、[Tools] > [Cloud Code] > [Help / About] > [Submit feedback or report an issue] を選択します。ここから、GitHub で問題を報告したり、Stack Overflow で質問したりできます。