AI アシスタントによる Azure ドキュメントの自動化

大規模環境での Azure リソース グループ (RG) の管理と文書化は、時間がかかり、複雑になる場合があります。しかし、どのようなリソースが存在するかだけでなく、それらがどのように相互に関連しているかを説明するドキュメントを生成するプロセスを自動化できたらどうでしょうか?

この記事では、単純な Python スクリプト が OpenAI や Azure OpenAI などの LLM (大規模言語モデル) をどのように活用できるかを検討します。 は、ARM テンプレートからの包括的なマークダウン ドキュメントの作成を自動化します。このツールを強力にしているのは、複雑なエージェント フレームワークや重いインフラストラクチャを使用しているのではなく、純粋な Python と Azure CLI や OpenAI の API などの確立されたツールを組み合わせていることです。他の AI プロバイダーや、Ollama または他の同様のツールを使用するローカル LLM と併用することもできます。

複雑なエージェント フレームワークは不要

よくある誤解は、LLM の力を効果的に利用するには精巧なエージェント フレームワークが必要であるということです。実際には、既存のツールと単純なスクリプトを使用して、強力な自動化されたワークフローを実現できます。このソリューションでは、以下を組み合わせます:

1. Python: 一般的にインストールされ、広く使用されているスクリプト言語として。
2. Azure CLI: Azure リソース グループから ARM テンプレートを取得します。
3. OpenAI API 呼び出し: ARM テンプレートから人間が読めるドキュメントを生成します。
4. マークダウン: ドキュメントの出力形式として。ナレッジ ベースに簡単に統合できます。

結果は?複雑なツールや AI を活用したオーケストレーションを必要とせずにドキュメントを作成する、クリーンで効率的なスクリプト。

Azure アシスタントのソース コード

ソース コードは、Github リポジトリ: itlackey/azure-assistants で入手できます。現在、これには、Azure CLI と OpenAI API を利用して ARM テンプレートからマークダウン ドキュメントを生成する単一の Python スクリプトが含まれています。興味がある場合、または必要がある場合は、他のタスクを自動化するための追加のツールやスクリプトでリポジトリが更新されることがあります。

スクリプトの仕組み

このツールの中心となるのは document_resource_groups.py スクリプトです。次の 4 つのことを行います:

1. 現在の Azure サブスクリプション内のすべてのリソース グループを取得。
2. az CLI を使用して、Azure リソース グループから ARM テンプレートをエクスポートします。
3. 私たちはテンプレートを解析し、OpenAI 互換 API に送信します。
4. LLM は、ナレッジ ベースに含める準備ができている マークダウン ドキュメントを生成するために使用されます。

リソースグループのリスト

最初のステップは、Azure サブスクリプション内のすべてのリソース グループを取得することです。これは、Python スクリプトから az CLI コマンドを使用して行われます。次に、それらをループして ARM テンプレートを取得します。

result = subprocess.run(
    ["az", "group", "list", "--query", "[].name", "-o", "tsv"],
    stdout=subprocess.PIPE,
    text=True,
)
resource_groups = result.stdout.splitlines()

ARM テンプレートのエクスポート

ここでも、スクリプトは Azure CLI を使用して、現在のサブスクリプション内の各リソース グループの ARM テンプレートを取得します。これらのテンプレートには、ネットワークやセキュリティの設定を含む、すべてのリソースの詳細な構成情報が含まれています。

export_command = [
    "az", "group", "export",
    "--name", resource_group_name,
    "--include-parameter-default-value",
    "--output", "json",
]

LLM を使用した要約

次に、スクリプトは要約のために ARM テンプレートを OpenAI (または Azure OpenAI) に送信します。ここで魔法が起こります。複雑なエージェントのワークフローに飛び込む代わりに、単純なシステム メッセージとユーザー プロンプトが、洞察力に富んだドキュメントを生成するのに十分なコンテキストを LLM に提供します。

response = client.chat.completions.create(model=model, messages=messages)

プロンプトは、予期される出力テンプレートを提供し、LLM に次のことを指示します。

• 各リソースをリストして説明します。
• リソースが互いにどのように関係しているかを説明します。
• 重要なネットワーク構成を強調表示します。

これにより、LLM は複雑なオーケストレーションを必要とせずに、構造化された読みやすいドキュメントを作成できます。

マークダウンドキュメントの生成

最後のステップは、リソース グループの詳細を含むマークダウン ファイルを生成することです。前付には、リソース グループ名、日付、タグなどのメタデータが含まれます。 AI が生成したドキュメントがドキュメントのコンテンツとして追加されます。

front_matter = f"---\n"
front_matter += f'title: "{resource_group_name}"\n'
front_matter += f"date: {date}\n"
front_matter += f"internal: true\n"

Markdown は汎用形式であるため、この出力を多くのドキュメント システムやナレッジ マネジメント システムに簡単に統合できます。

AI プロンプトのカスタマイズ

このスクリプトの重要な機能は、LLM に送信されるプロンプトをカスタマイズできることです。ここでユーザーは希望する出力の種類を微調整できます:

• システム メッセージ: リソース、関係、ネットワーキングの説明に重点を置いたドキュメントを生成するように LLM をガイドします。

例:

    You are an experienced Azure cloud architect helping to create reference documentation that explains the resources within an Azure Resource Manager (ARM) template.

    The documentation you create is intended for use in a knowledge base. Your role is to describe the resources in a clear and human-readable way, providing details on the following:

    - What resources exist in the ARM template.
    - How the resources relate to each other.
    - The purpose of each resource (if possible).
    - Highlighting network configurations and data locations such as storage accounts and databases.
    - Be sure to include IP addresses in the documentation when they are available.
    - Include information about virtual network peering.
    - It is very important that you also include any potential security issues that you may find.

• ユーザー プロンプト: 要約されるリソース グループに基づいて動的に生成されます。

例:

    Provide detailed documentation of the following ARM template for resource group: 


    {template_content}


    The purpose of this documentation is to...

これらのプロンプトを柔軟かつシンプルに保つことで、スクリプトは高品質のドキュメントを提供しながら過剰なエンジニアリングを回避します。

スクリプトの実行

注: このスクリプトを実行する前に、az CLI と python3 をマシンにインストールしておく必要があります。

スクリプトの設定と実行は簡単です:

1. Azure にログインします: Azure CLI で認証されていることを確認します。

result = subprocess.run(
    ["az", "group", "list", "--query", "[].name", "-o", "tsv"],
    stdout=subprocess.PIPE,
    text=True,
)
resource_groups = result.stdout.splitlines()

1. スクリプトを実行してマークダウンドキュメントを生成します。

export_command = [
    "az", "group", "export",
    "--name", resource_group_name,
    "--include-parameter-default-value",
    "--output", "json",
]

スクリプトは各リソース グループを処理し、その ARM テンプレートを生成し、出力ディレクトリにマークダウン ファイルを作成します。

出力例

スクリプトが生成するものの例を次に示します:

response = client.chat.completions.create(model=model, messages=messages)

この出力は簡潔、読みやすい、理解しやすいであり、まさに内部文書やナレッジベースのエントリに必要なものです。

結論

Azure Assistants は、既存のツール と基本的な Python スキルを使用して、LLM で強力な結果を達成する方法を示す完璧な例です。シンプルなスクリプトを Azure CLI および OpenAI の API と組み合わせることで、Azure リソース グループに関する明確で包括的なドキュメントを生成できる場合、複雑なエージェント フレームワークは必要ありません。

このツールは、適切なプロンプトと強固な構造を備えていれば、基本的なスクリプト スキルを持つ誰でも AI を活用してクラウド ドキュメントを自動化し、DevOps チームやインフラストラクチャ チームにとって貴重なアシスタントとなることを示しています。

以上がAI アシスタントによる Azure ドキュメントの自動化の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。