Secret Manager でシークレットを管理する

Cloud Code の Secret Manager 統合を使用すると、コードベースで Secret を作成せずに、IDE 内で Secret を作成、表示、更新、使用できます。

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

Secret Manager を有効にする

Cloud Code で Secret を管理する場合、Secret は Secret Manager に安全に保存され、必要に応じてプログラムで取得できます。必要な要件は、Secret Manager API が有効になっており、Secret を管理するための適切な権限が付与されていることのみです。

  1. Secret Manager を起動するには、アクティビティ バーにある Secret Manager ビュー Secret Manager のアイコン をクリックします。

  2. Secret Manager API を有効にしていない場合は、Cloud Code では、Secret Manager パネル内で有効にするよう求められます。

    Secret は、アプリケーション コードと同じプロジェクトに配置されている必要があります。正しいプロジェクトを選択していることを確認するか、[Secret Manager] パネルのプロジェクト セレクタを使用して切り替えてください。

    Secret Manager ビュー内の API リンクを有効にする

Secret の作成と表示

Secret の作成

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

Secret Manager ビューの使用

  1. Secret Manager ビュー Secret Manager のアイコン を選択します。

  2. 追加アイコンをクリックします。

    [Secret の作成] ダイアログが開きます。このダイアログで、Secret のプロジェクト、名前、値を設定できます。また、Secret を保存するリージョンと Secret の整理に使用するラベルを選択することもできます。

    [名前] フィールドに「test-secret-2」、[Secret の値] に「42」と入力されている [Secret を作成] ダイアログ

エディタを使用する

  1. エディタで Secret として保存するテキストを含むファイルを開きます。

  2. このテキストをハイライト表示して右クリックします。

    メニューから、[Secret Manager で Secret を作成] メニュー項目を選択します。ハイライト表示されたテキストで記入された Secret の値を示す [Secret を作成] ダイアログが開きます。ここで Secret のプロジェクト、名前、値、リージョン、ラベルをカスタマイズできます。

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

既存の Secret を更新する場合は、Secret Manager ビュー内で更新できます。

  1. 既存の Secret を右クリックし、[Create Secret Version] を選択します。

    [バージョンの作成] ダイアログが開き、ここで、Secret の値フィールドを使用して、またはファイルをインポートして、既存の Secret の値を設定できます。

    Secret 値フィールドで Secret「test-secret」が「bar」に更新されている [Secret バージョンの作成] ダイアログ

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

  3. [バージョンを作成] をクリックしてバージョンを追加すると、最新の Secret バージョンと [バージョン] の下に表示されていたすべての Secret バージョンが表示されます。プルダウンを選択します。

または、エディタを使用して [バージョンの作成] ダイアログを起動するには、ファイルを開き、Secret で保存するテキストをハイライト表示します。ハイライト表示されたテキストを右クリックし、[Secret Manager の Secret にバージョンを追加] メニュー オプションを選択します。

シークレットの管理

Secret を表示するには、Secret Manager ビュー内で表示されるリストから Secret を選択します。名前、レプリケーション ポリシー、作成タイムスタンプ、リソース ID などの詳細は、[プロパティ] プルダウンに表示されています。

このビューでは、シークレットを右クリックして、シークレットのバージョンを有効化、無効化、破棄することもできます。Secret の有効なバージョンについては、バージョンの値を表示することもできます。

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

Secret Manager の Secret を右クリックして、[Cloud Console で開く] オプションを表示します。Secret Manager ビューにも [プロパティ] プルダウンが表示されます。

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

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

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

  1. Secret Manager クライアント ライブラリをインストールします。

    アクティビティ バーから Cloud Code - Cloud APIs アイコン Cloud Code - Cloud APIs アイコン をクリックします。その後、Google Cloud APIs Explorer ツリー内で Secret Manager > Secret Manager API を選択します。[クライアント ライブラリのインストール] セクションに記載されている言語別の手順に従います。

  2. 関連するコード スニペットをカスタマイズして、アプリケーションのコードに追加します。

    コードで使用する Secret のバージョン名を取得するには、Secret Manager パネルで Secret を選択し、右クリックして [リソース ID をコピー] を選択します。

  3. 最後に、認証の設定を完了するには、クライアント ライブラリ認証ガイドに従う必要があります。

    • ローカルでの開発: ローカル クラスタ（minikube、Docker Desktop など）またはローカル エミュレータで開発を行う場合は、ワークフローに関連するローカル開発セクションに示されている手順を完了する必要があります。
    • リモート開発: アプリケーションで GKE クラスタまたは Cloud Run サービスを使用している場合は、ワークフローに関連するリモート開発セクションに示されている手順を完了する必要があります。これには、サービス アカウントで必要なロールを設定するための Secret Manager 固有の手順も含まれます。

サポートの利用

フィードバックを送信するには、GitHub で問題を報告します。または、Stack Overflow で質問します。