このチュートリアルでは、Azure DevOps Wiki を Azure SRE エージェントのナレッジ ソースとして接続します。 これらの手順を完了すると、調査中に質問に回答するときに、エージェントはチームの Wiki で Runbook と手順を検索できます。
このチュートリアルでは、以下の内容を学習します。
- ドキュメント コネクタを使用して Azure DevOps Wiki を接続する
- マネージド ID と個人用アクセス トークン (PAT) 認証のどちらかを選択する
- Wiki コンテンツを使用する質問をエージェントに問い合わせて接続を確認する
推定時間: 10 分
前提条件
開始する前に、次のリソースとアクセス権があることを確認します。
- Azure SRE エージェント (既に作成済み)。
- コンテンツを含む Wiki を含む Azure DevOps プロジェクト。
- これらの認証オプションの 1 つ:
- マネージド ID: Azure DevOps 組織のユーザーとしてエージェントのマネージド ID を追加します (組織の設定>ユーザー>追加ユーザー> ID のクライアント ID を入力します。
- 個人用アクセス トークン (PAT):コード (読み取り) スコープを使用して Azure DevOps で生成します。
Wiki URL を取得する
Wiki に接続するには、まず Azure DevOps の URL が必要です。
- Azure DevOps プロジェクトに移動します。
- 左側のサイドバーで Wiki を選択します。
- ブラウザーのアドレス バーから URL をコピーします。
URL は次の例のようになります。
https://dev.azure.com/{your-org}/{your-project}/_wiki/wikis/{wiki-name}
レガシ URL もサポートされています。
https://{your-org}.visualstudio.com/{your-project}/_wiki/wikis/{wiki-name}
ヒント
Wiki の特定のセクションのみにインデックスを作成するには、まず Azure DevOps でそのセクションに移動し、URL をコピーします。 URL のページ ID は、そのページとそのサブページのみをクロールするようにエージェントに指示します。 この方法は、 /Operations や /Runbooks などのセクションのみが関連する大規模な Wiki に役立ちます。
[コネクタ] ページを開く
Azure SRE エージェント ポータルでコネクタの構成に移動します。
- sre.azure.com に移動します。
- エージェントを選択してください。
- 左側のサイドバーで[ビルダー]を展開 します。
- [コネクタ] を選択します。
既存のコネクタの一覧が表示され、その名前、サービスの種類、接続の状態が表示されます。
コネクタの追加ウィザードを開始する
ツール バーの [ コネクタの追加] を選択して、次の 3 つの手順のウィザードを開きます。
- コネクタを選択する: コネクタの種類を選択します。
- コネクタのセットアップ: 名前、URL、認証を構成します。
- 確認と追加: 確認して作成します。
ドキュメント コネクタを選択する
コネクタ ピッカーで、Azure DevOps というサブタイトルが付いたドキュメント コネクタを見つけて選択します。 コネクタの説明には、「エージェントはドキュメントとファイルを参照してプロジェクトとプロセスを理解します」と読み上げられます。
[ 次へ ] を選択してセットアップ フォームに進みます。
コネクタを構成する
フォーム のタイトルには、 Azure DevOps コネクタのセットアップが表示されます。 以下の項目に入力してください。
| フィールド | 入力する内容 |
|---|---|
| 名前 | わかりやすい名前 ( ops-wiki や team-runbooksなど) |
| Azure DevOps URL | 前の手順の Wiki URL |
認証方法を選択します
次のいずれかの認証オプションを選択します。
オプション A: マネージド ID (推奨)
- マネージド ID (既定で選択) を選択します。
- [マネージド ID] ドロップダウン リストから マネージド ID を 選択します (既定値は [システム割り当て済み] です)。
- 必要に応じて、[ マネージド ID をフェデレーション ID 資格情報として使用] を選択します。
オプション B: 個人用アクセス トークン (PAT)
- [ 個人用アクセス トークン (PAT)] を選択します。
- [ 個人用アクセス トークン ] フィールドに Azure DevOps PAT を貼り付けます。
[ 次へ ] を選択して、レビュー手順に進みます。
コネクタを確認して作成する
概要画面でコネクタの詳細を確認し、送信ボタンを選択してコネクタを作成します。
コネクタの一覧に新しいコネクタが表示され、状態が [接続済み ] (緑色のチェックマーク) になります。
注
Wiki のサイズによっては、最初のインデックス作成に数分かかる場合があります。 エージェントは、インデックス作成の完了後に Wiki コンテンツを使用できます。
接続を確認する
Wiki コンテンツが回答できる質問をエージェントに問い合わせて、新しい Wiki 接続をテストします。
- サイドバーで [新しいチャット スレッド ] を選択します。
- Wiki コンテンツが回答できる質問をします。
例えば次が挙げられます。
What are our standard procedures for handling a database failover?
エージェントは、他のナレッジ ソースと共に Wiki を検索し、その応答に元の Wiki ページにリンクする引用文献を含めます。 応答には、Azure DevOps のソース Wiki ページへの引用文献リンクが含まれています。
Troubleshooting
次の表を使用して、Azure DevOps Wiki コネクタに関する一般的な問題を解決します。
| 問題点 | ソリューション |
|---|---|
| コネクタが [切断済み] と表示される | Wiki URL の形式と認証資格情報を確認します。 |
| Wiki コンテンツが応答に表示されない | 最初のインデックス作成が完了するまで数分待ってから、もう一度やり直してください。 |
| URL 検証エラー | URL が https://dev.azure.com/{org}/{project}/_wiki/wikis/{wiki-name} または https://dev.azure.com/{org}/{project}/_git/{repo}と一致していることを確認します。 従来の visualstudio.com URL も受け入れられます。 |
| PAT 認証が失敗する | PAT に コード (読み取り) スコープがあり、有効期限が切れていないことを確認します。 |
| マネージド ID が失敗する | エージェントのマネージド ID が Azure DevOps 組織 (組織の設定>Users) のユーザーとして追加されていることを確認します。 |