Cloud Code for VS Code の 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 はアプリケーション コードと同じプロジェクト内にある必要があります。

  2. [Cloud Code] をクリックし、[Secret Manager] セクションを展開します。

  3. Secret Manager API を有効にしていない場合は、Secret Manager セクションで [Secret Manager API を有効にする] をクリックします。

Secret Manager ビューを使用したシークレットの作成

  1. [Cloud Code] をクリックし、[Secret Manager] セクションを展開します。

  2. [Secret Manager] セクションで [シークレットを作成] をクリックします。

    [Secret の作成] ダイアログで、Secret のプロジェクト、名前、値、リージョンを設定し、Secret を整理するラベルを指定します。

エディタビューを使用したシークレットの作成

  1. エディタで Secret として保存するテキストを含むファイルを開きます。
  2. Secret として保存するテキストをハイライト表示して右クリックし、[Secret Manager で Secret を作成] をクリックします。
  3. [Secret の作成] ダイアログで、Secret のプロジェクト、名前、値、リージョン、ラベルをカスタマイズします。

Secret Manager を使用した新しいバージョンの Secret の作成

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

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

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

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

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

  4. [バージョンを作成] をクリックします。バージョンが追加され、[バージョン] プルダウンに最新のシークレット バージョンと以前のバージョンが表示されます。

エディタを使用した新しいバージョンの Secret の作成

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

  1. エディタでファイルを開き、Secret として保存するテキストをハイライト表示します。
  2. ハイライト表示されたテキストを右クリックし、[Secret Manager の Secret にバージョンを追加] を選択します。

Secret の表示

  1. [Cloud Code] をクリックし、[Kubernetes] セクションを展開します。
  2. クラスタを展開し、[Secret] を展開します。
  3. Secret を展開して詳細を表示します。

Secret の削除

Cloud Code の Secret Manager を使用してシークレットを削除するには、次の手順に従います。

  1. [Cloud Code] をクリックし、[Secret Manager] セクションを展開します。

  2. 既存のシークレットを右クリックし、[Cloud Console で開く] を選択します。

  3. [Secret の詳細] ページで、[削除] をクリックし、プロンプトに従ってシークレットを削除します。

Secret の表示

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

シークレット バージョンの管理

Secret のバージョンを有効化、無効化、または破棄するには、Secret を右クリックして、実行するアクションのコマンドを選択します。Secret の有効なバージョンについては、バージョンの値を表示することもできます。

Google Cloud コンソールでのシークレットの管理

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

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

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

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

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

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

    1. [Cloud Code] をクリックし、[Cloud APIs] セクションを展開します。

    2. [Secret Manager] > [Secret Manager API] を展開し、使用している言語の [クライアント ライブラリをインストールする] の手順を行います。

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

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

  3. 認証設定を完了するには、クライアント ライブラリ認証ガイドに従ってください。

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

シークレットを環境変数として追加

既存の Kubernetes Secret を環境変数として Deployment に追加するには:

  1. [Cloud Code] をクリックし、[Kubernetes] セクションを展開します。
  2. minikube クラスタを展開し、[Secret] を展開します。
  3. デプロイメント オブジェクトを表す Secret を右クリックして、[Secret を環境変数として追加] をクリックします。

Secret をボリュームとしてマウントする

既存の Kubernetes Secret をボリュームとして Deployment のコンテナにマウントするには:

  1. [Cloud Code] をクリックし、[Kubernetes] セクションを展開します。
  2. minikube クラスタを展開し、[Secret] を展開します。
  3. デプロイメント オブジェクトを表す Secret を右クリックし、[Secret をボリュームとしてマウントする] をクリックします。

サポートの利用

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