stack retrieval augmented generation
v2.1.0
以下のデプロイ可能なアーキテクチャーは、基盤となるすべての IBM Cloud および WatsonX インフラストラクチャーを含む、IBM Cloud 上のサンプル生成 AI パターンのデプロイメントを自動化します。このアーキテクチャーは、リファレンス・アーキテクチャーで説明されているように、IBM Cloud 上で watsonx gen AI パターンをデプロイするためのベスト・プラクティスを実装します。
この展開可能なアーキテクチャは、信頼性、可観測性、セキュリティ、および規制遵守のための包括的な基盤を提供します。このアーキテクチャーは、コンプライアンス設定に合わせて IBM Cloud アカウントを構成します。また、キー管理およびシークレット管理サービスと、アプリケーションのライフサイクルを安全に管理するための継続的インテグレーション (CI)、継続的デリバリー (CD)、継続的コンプライアンス (CC) パイプラインをサポートするインフラストラクチャも展開します。また、WatsonX サービス スイートと IBM Cloud Elasticsearch をデプロイして、RAG パターンを容易にします。これらのパイプラインは、アプリケーションのデプロイメントを容易にし、脆弱性と監査可能性をチェックし、IBM Cloud 上での生成 AI アプリケーションの安全かつ信頼できるデプロイメントを確保するのに役立ちます。
この展開可能なアーキテクチャには 2 つのバリエーションが利用可能です。
基本的なバリエーション:
標準バリエーション:
このデプロイ可能なアーキテクチャーは、IBM Cloud プロジェクトを通じて、検索拡張生成アプリケーションの完全に自動化されたデプロイメントを紹介するように設計されています。これは、IBM Cloud 上で独自の watsonx アプリケーションに柔軟でカスタマイズ可能な基盤を提供します。このアーキテクチャでは、デフォルトで次のサンプル アプリケーションがデプロイされます。
このアーキテクチャを使用すると、展開を加速し、ビジネス ニーズや企業の目標に合わせて調整できます。
このアーキテクチャは、次の目標を達成するのに役立ちます。
デプロイ可能なアーキテクチャをデプロイする前に、次のアクションを完了していることを確認してください。
重要
ユーザーに関連付けられた API キーを使用する必要があります。サービス ID キーや信頼できるプロファイルは使用できません。
API キーの値をコピーします。次の手順で必要になります。
テスト環境または評価環境では、次のサービスに対する管理者ロールを付与できます。
User API key creatorロールを明示的に割り当てます。運用環境に対してアクセスの範囲をより制限するには、この展開可能なアーキテクチャの権限タブで最小権限レベルを参照してください。
gpg --gen-key実行して、署名キーを作成または取得します (有効期限が切れていない場合は、以前に生成したキーを使用できます)。gpg --export-secret-key <email address> | base64実行して、署名キーをエクスポートします。 gpg --export-secret-key <email address> | base64 。キーの保存の詳細については、「GPG キーの生成」を参照してください。名前と説明を追加します。
プロジェクトのリージョンとリソース グループを選択します。たとえば、評価の目的で、自分に最も近いリージョンとデフォルトのリソース グループを選択できます。
エンタープライズ アカウント構造の詳細については、サーバーの全体管理アカウントのホワイト ペーパーを参照してください。
構成名を入力します。たとえば、「RAG」、「dev」、「prod」などです。この名前は、後で展開ターゲットと一致させるのに役立ちます。
変数を設定して構成を作成できるようになりました。
「セキュリティ」パネルから、アーキテクチャのデプロイに使用する認証方法を選択します。
「始める前に」の前提条件から API キーを追加します。
[設定]セクションの[セキュリティ] > [認証]タブで、API キーを選択します。
「必須」タブから必須フィールドに値を入力します。
「オプション」タブからオプションのフィールドの値を確認します。
signing_key変数を指定します。「保存」をクリックします。入力値が検証されると、ボタンが[スタック構成の表示]に変わります。
IBM Cloud コンソールを介して、以下の 2 つの方法で、スタックされたデプロイ可能なアーキテクチャーをデプロイできます。
自動デプロイを使用する : このデプロイメント方法は、デモンストレーション環境や非実稼働環境に役立ちます。自動デプロイでは、すべてのスタック メンバー構成が検証され、承認されてデプロイされます。
[管理] > [設定] をクリックすると、プロジェクトの自動デプロイ設定を確認できます。自動展開をオンにすると、プロジェクト内のすべての構成の設定が有効になります。
各メンバー構成を個別に展開します。手動による方法は、実稼働環境を保持するプロジェクトに適しています。自動化を実行する前に、各メンバー構成の変更を確認できます。
ヒント
構成を承認した後、「構成を検証できません」というエラー メッセージが表示される場合があります。この問題を解決するには、ブラウザを更新してください。
プロジェクト設定の「要注意」列に「新しいバージョンが利用可能です」という通知が表示される場合があります。これらのメッセージはスタックのデプロイを妨げるものではないため、無視してかまいません。
[スタック構成の表示]の横にある[オプション]アイコンをクリックし、 [検証]をクリックします。
プロジェクトで自動デプロイ設定がオフになっている場合は、準備ができているメンバー構成のみが検証されます。
プロジェクトで、 「構成」タブをクリックします。
スタックの最初のメンバー構成 ( Account Infrastructure Base ) が「検証準備完了」としてマークされていない場合は、ブラウザーでページを更新します。
Account Infrastructure Base行の「ドラフト・ステータスで検証」をクリックします。
構成を承認し、検証が正常に完了したら「デプロイ」をクリックします。
初期メンバー構成をデプロイした後、残りのメンバー構成を同時に検証してデプロイできます。アーキテクチャ内のメンバー構成ごとに、これらのデプロイメント手順を繰り返します。
これで、取得拡張生成パターンのデプロイ可能なアーキテクチャがターゲット アカウントにデプロイされました。
アーキテクチャがデプロイされると、新しくプロビジョニングされた DevOps サービスでサンプル アプリケーションが開始されます。
アプリケーションのビルドとデプロイメントを監視するには、次の手順に従います。
resource_group_name入力に基づいています。Workload - Sample RAG App Configuration行をクリックします。Outputsタブでは、デプロイされたアプリケーションの URL が、 sample_app_public_url出力の下にリストされます。 コストを最小限に抑えるために、自動化では Secrets Manager のトライアル価格プランが展開されます。 Secrets Manager の試用版インスタンスは 1 つだけ作成できます。 Secrets Manager の標準プランのインスタンスは、スタックのオプション設定からデプロイできます。
これを修正するには、試用版インスタンスを削除します。削除後は、サービスを再利用状態から削除します。
IBM Cloud では、リソースを削除しても、リソースはすぐには消えません。代わりに、再利用状態に入り、永久に削除されるまで短期間 (通常は 7 日間) 保持されます。再利用状態の間、必要に応じてリソースを回復できます。
以下の IBM Cloud CLI コマンドを実行して、サービスを再利用状態から削除します。
最初のコマンドは、再利用状態にあるすべてのリソースをリストします。
# List all the resources in reclamation state with its reclamation ID
ibmcloud resource reclamationsSecrets Manager サービスの再利用 ID を見つけます。その ID を次のコマンドで使用します。
ibmcloud resource reclamation-delete < reclamation-id >この特定の問題は、ALM/ツールチェーンのデプロイメントが 14 日以上経過し、アプリケーション構成 DA がアンデプロイ/再デプロイされている場合に発生する可能性があります。これは、パイプライン プロパティの作成と削除に継続的デリバリー サービスが必要であり、CD サービスが存在しない可能性があるときに展開が行われるためです。私たちはこのバグの長期的な解決策に取り組んでいますが、それまでの間は、ツールチェーンが作成されることが予想されるリソース グループに CD サービスが存在することを確認することで、このバグを軽減できます。
この問題は、コード エンジンと OCP の両方のバリエーションのWorkload - Sample RAG App Configurationデプロイ可能なアーキテクチャで発生します。通常、エラーには次のメッセージが含まれます。
"errors": [
{
"code": 403,
"message": "Continuous Delivery service required"
}
]
このアーキテクチャでは多くのカスタマイズが可能です。これらはいくつかの一般的なオプションです。
各メンバー構成には、多数の入力パラメーターが含まれています。構成を編集してデフォルト値を変更できます。
たとえば、メンバー構成を編集すると、次のことを実現できます。
メンバー構成を編集するには、メンバー構成行の「オプション」アイコンから「編集」を選択します。
他の構成が依存していないメンバー構成をスタックから削除できます。
このアーキテクチャでは次の構成を削除できます。
メンバー構成を削除するには、メンバー構成行の「オプション」アイコンから「スタックから削除」を選択します。
次の手順に従って、スタック レベルで入力変数と出力変数を追加または削除できます。
次の手順に従って、Activity Tracker のルートやターゲット、Cloud Monitoring インスタンスなどのオブザーバビリティ リソースを選択的にプロビジョニングできます。
cloud_logs_provision ): これを設定して、IBM Cloud Logs インスタンスのプロビジョニングまたはプロビジョニングをスキップします。cloud_monitoring_provision ): IBM Cloud Monitoring インスタンスのプロビジョニングまたはプロビジョニングをスキップするには、これを設定します。enable_at_event_routing_to_cos_bucket ): これを設定して、Activity Tracker から Object Storage バケットへのイベント ルーティングを有効または無効にします。enable_at_event_routing_to_cloud_logs ): これを設定して、Activity Tracker から Cloud Logs へのイベント ルーティングを有効または無効にします。プロジェクトでデプロイ可能なアーキテクチャーを変更した後、プライベート IBM Cloud カタログを通じて他のユーザーとそれを共有できます。展開可能なアーキテクチャを共有するには、「展開可能なアーキテクチャを企業に共有する」の手順に従います。
このサンプル オートメーションのコードをガイドとして使用して、要件に合わせてサンプル アプリをカスタマイズできます。コードは https://github.com/terraform-ibm-modules/terraform-ibm-rag-sample-da で入手できます。
独自のアプリを使用するには、スタックからWorkload - Sample RAG App Configurationメンバー構成を削除します。このメンバー構成は、デフォルトのサンプル アプリに固有です。
構成をクリーンアップする
すべての Watson リソースを破棄する予定がある場合、このステップはオプションです。アプリケーションによって作成されたアーティファクトは、Watson リソースのアンデプロイの一環として削除されます。
cleanup.md ファイルに記載されている手順に従って、サンプル アプリの構成を削除します。
CI ツールチェーンによって作成されたリソースを削除する
ツールチェーンによって作成される次のリソースは、Project でのスタックのデプロイ解除の一部として破棄されません。
プロジェクトを削除します。
デプロイ可能なアーキテクチャーによって作成されたインフラストラクチャーをデプロイ解除するには、IBM Cloud 資料のプロジェクトの削除の手順に従ってください。
