Octopus Deploy
Octopus DeployでシークレットにアクセスするためのKeeperシークレットマネージャーのステップテンプレート
機能
Keeperボルトからシークレットを取得し、Octopus Deployのライブラリで利用
認証情報をOctopus Deployのプロジェクトに直接挿入
Keeperボルトからファイルを取得
Keeperシークレットマネージャーの機能一覧については、概要をご参照ください。
要件
本ページでは、シークレットマネージャーとOctopus Deployの連携について取り扱います。本連携を利用するには、以下が必要です。
Keeperシークレットマネージャーへのアクセス (クイックスタートガイドをご参照ください)
Keeperのサブスクリプションでシークレットマネージャーアドオンが有効になっていること
シークレットマネージャーポリシーが有効なロールに所属していること
シークレットが共有されているKeeper シークレットマネージャーアプリケーション
アプリケーションの作成手順については、クイックスタートガイドをご参照ください
初期化済みのKeeper シークレットマネージャー構成
Octopus Deploy連携では、Base64形式の構成を受け付けます
概説
KeeperのOctopus Deployステップテンプレートでは、Keeperシークレットマネージャーを通じて、Keeperボルトに保存されたシークレットの認証情報を利用できます。このスクリプトを使用することで、Keeperのゼロ知識基盤を活用しながら、シークレットを安全にOctopus Deployのプロジェクトへ直接組み込むことが可能です。
インストール
コミュニティステップテンプレート
コミュニティステップテンプレートから直接ステップテンプレートを使用します。
場所: Library (ライブラリ) > Step Templates (ステップテンプレート) > Community Step Templates (コミュニティステップテンプレート) > Browse Library (ライブラリを参照)
検索: 「Keeper Secrets Manager - Retrieve Secrets」を検索し、インストールしてから保存します。
カスタムステップテンプレート
カスタムステップテンプレートとして追加します。
場所: Library (ライブラリ) > Step Templates (ステップテンプレート) > Custom Step Templates (カスタムステップテンプレート) > Import (インポート)
コミュニティで提供されているテンプレートライブラリから取得したJSONを貼り付けます。
ステップの構成
設定
名前: Keeper Secrets Manager - Retrieve Secrets 説明: このステップでは、Keeperボルトから1件以上のシークレットを取得し、取得した各値に対して機密出力変数を作成します。作成された変数は、デプロイやランブックの他のステップで利用できます。 シークレットの取得にはKeeper表記法URIを使用でき、各シークレットごとに出力変数名を任意に指定できます。 要件:
Keeperボルトからシークレットを取得する権限を持つKeeperシークレットマネージャーアプリケーション
PowerShell 6.0以降
Microsoft.Powershell.SecretManagementモジュール対象マシンまたはワーカーに
SecretManagement.Keeper.ExtensionPowerShellモジュールがインストールされている必要があります。このモジュールが見つからない場合、ステップは失敗します。SecretManagement.Keeperモジュールは PowerShellギャラリー からインストールできますSecretManagement.Keeper.ExtensionはSecretManagement.Keeperモジュール内に含まれています
パラメータ
Keeperシークレットマネージャー構成 (種類: 機密)
変数名: #{Keeper.SecretsManager.RetrieveSecrets.Config}
Keeperボルトからシークレットを取得する権限を持つ KSMアプリケーション 用のKeeperシークレットマネージャー 構成 です。ウェブボルトでKSM構成を生成するには、[シークレットマネージャー] → KSMアプリケーション名 → [編集] → [デバイスを追加] の順に進み、方式を [構成ファイル] に切り替えます。形式はBase64を推奨します。
取得するボルトシークレット (種類: 複数行テキストボックス)
変数名: #{Keeper.SecretsManager.RetrieveSecrets.VaultSecrets}
Keeperボルトから取得するシークレットは、Keeper表記法 を使用して SecretsManagerNotation URI | OutputVariableName 形式で指定します。
OutputVariableNameは、シークレットの値を保存するOctopus出力変数名 (任意) です。指定しない場合は、出力変数名が自動的に生成されます
複数のフィールドを取得する場合は、それぞれを1行ずつ入力します。各行の形式は Notation | variable です。変数名は任意で、省略した場合は KsmSecret1、KsmSecret2 などの自動生成された変数名が使用されます。
出力変数名を表示 (種類: チェックボックス)
変数名: #{Keeper.SecretsManager.RetrieveSecrets.PrintVariableNames}
Octopus出力変数名をタスクログに書き出します。
デフォルト: False
最終更新