update docs

Author: ZQlQZ

docs/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# vscode
+.vscode/
+# Windsurf
+.windsurf
+
+# python package
+uv.lock
+
+# VitePress related files (security concern - keep Markdown docs in repo)
+docs/package.json
+docs/package-lock.json
+docs/node_modules/

docs/app/app_agent.yaml

@@ -0,0 +1,4 @@
+name: app_agent
+description: Application operations agent.
+instruction: 仅根据你的知识库回答业务应用排障问题。必要时建议回滚或触发标准化作业。
+model: itops_root.models.MockSubAgentLlm

docs/app/host_agent.yaml

@@ -0,0 +1,4 @@
+name: host_agent
+description: Host/Middleware operations agent.
+instruction: 仅根据你的知识库回答主机/中间件排障问题。必要时建议采集证据或提交工单。
+model: itops_root.models.MockSubAgentLlm

docs/app/itops_root.yaml

@@ -0,0 +1,20 @@
+name: itops_root
+description: Planner that routes user intents to the right department agent.
+instruction: |
+  你是 IT 运维总控台。先判断用户问题属于 网络/主机/应用/安全 哪一类，
+  然后调用相应子 Agent 获取答案并整合。若问题跨域，可分别调用多个子 Agent 并给出综合结论。
+  若涉及动作（如创建工单），请明确说明，并在获得用户确认后再调用相关工具。
+tools:
+  - tools.py
+sub_agents:
+  - network_agent.yaml
+  - host_agent.yaml
+  - app_agent.yaml
+  - sec_agent.yaml
+model:
+  name: mock-planner
+long_term_memory:
+  backend: local
+  index: itops_ltm_demo
+tracers:
+  - type: opentelemetry

docs/app/itops_root/__init__.py

@@ -0,0 +1,6 @@
+from google.adk.tools.tool_registry import register_tool
+from . import models
+from . import tools
+
+register_tool(tools.create_ticket)
+register_tool(tools.query_cmdb)

docs/app/itops_root/models.py

@@ -0,0 +1,83 @@
+from google.adk.models.base_llm import BaseLlm
+from google.adk.models.llm_response import LlmResponse
+from google.genai import types as genai_types
+
+class MockPlannerLlm(BaseLlm):
+    """A mock planner LLM that routes to sub-agents based on keywords."""
+
+    async def generate_content_async(self, llm_request, stream: bool = False):
+        user_queries: list[str] = []
+        for content in llm_request.contents:
+            if content.role == "user":
+                for part in content.parts or []:
+                    if getattr(part, "text", None):
+                        user_queries.append(part.text)
+        query = user_queries[-1] if user_queries else ""
+
+        function_calls = []
+        if "网络" in query or "network" in query:
+            function_calls.append(
+                genai_types.FunctionCall(
+                    name="network_agent",
+                    args={"prompt": query}
+                )
+            )
+        if "服务器" in query or "主机" in query or "host" in query:
+             function_calls.append(
+                genai_types.FunctionCall(
+                    name="host_agent",
+                    args={"prompt": query}
+                )
+            )
+        if "应用" in query or "app" in query:
+             function_calls.append(
+                genai_types.FunctionCall(
+                    name="app_agent",
+                    args={"prompt": query}
+                )
+            )
+        if "安全" in query or "sec" in query:
+             function_calls.append(
+                genai_types.FunctionCall(
+                    name="sec_agent",
+                    args={"prompt": query}
+                )
+            )
+
+        if function_calls:
+            parts = [genai_types.Part(function_call=call) for call in function_calls]
+            response_content = genai_types.Content(
+                role="model",
+                parts=parts,
+            )
+        else:
+            text = f"抱歉，无法理解您的问题 '{query}'。请说明问题属于 网络/主机/应用/安全 中的哪一类。"
+            response_content = genai_types.Content(
+                role="model",
+                parts=[genai_types.Part.from_text(text=text)],
+            )
+
+        yield LlmResponse(content=response_content)
+
+class MockSubAgentLlm(BaseLlm):
+    """A mock sub-agent LLM that provides a canned response."""
+
+    async def generate_content_async(self, llm_request, stream: bool = False):
+        # Extract the function call from the request
+        function_call = None
+        for content in llm_request.contents:
+            if content.role == "function":
+                function_call = content
+
+        if function_call:
+            response_text = f"已收到来自 {function_call.parts[0].function_response.name} 的请求"
+        else:
+            response_text = "已收到请求"
+
+
+        response_content = genai_types.Content(
+            role="model",
+            parts=[genai_types.Part.from_text(text=response_text)],
+        )
+
+        yield LlmResponse(content=response_content)

docs/app/itops_root/root_agent.yaml

@@ -0,0 +1,15 @@
+name: itops_root
+description: Planner that routes user intents to the right department agent.
+instruction: |
+  你是 IT 运维总控台。先判断用户问题属于 网络/主机/应用/安全 哪一类，
+  然后调用相应子 Agent 获取答案并整合。若问题跨域，可分别调用多个子 Agent 并给出综合结论。
+  若涉及动作（如创建工单），请明确说明，并在获得用户确认后再调用相关工具。
+sub_agents:
+  - config_path: ../network_agent.yaml
+  - config_path: ../host_agent.yaml
+  - config_path: ../app_agent.yaml
+  - config_path: ../sec_agent.yaml
+tools:
+  - name: itops_root.tools.create_ticket
+  - name: itops_root.tools.query_cmdb
+model: itops_root.models.MockPlannerLlm

docs/app/itops_root/tools.py

@@ -0,0 +1,10 @@
+from typing import Dict, Any, Optional
+
+def create_ticket(type: str, title: str, severity: str, meta: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    """创建工单（示例桩）。生产中调用企业工单系统 API，并返回工单链接。"""
+    ticket_id = f"TCK-{severity.upper()}-0001"
+    return {"id": ticket_id, "url": f"https://ticket.example.com/{ticket_id}", "title": title, "type": type, "severity": severity, "meta": meta or {}}
+
+def query_cmdb(asset_id: Optional[str] = None, ip: Optional[str] = None) -> Dict[str, Any]:
+    """CMDB 查询（示例桩）。生产中调用 CMDB API。"""
+    return {"asset_id": asset_id or "host-001", "ip": ip or "10.0.0.1", "owner_dept": "network", "env": "prod"}

docs/app/network_agent.yaml

@@ -0,0 +1,4 @@
+name: network_agent
+description: Network operations agent focusing on DNS/Connectivity.
+instruction: 仅根据你的知识库回答网络排障问题。不要臆测，不要编造。必要时建议提交工单。
+model: itops_root.models.MockSubAgentLlm

docs/app/sec_agent.yaml

@@ -0,0 +1,4 @@
+name: sec_agent
+description: Security operations agent.
+instruction: 仅根据你的知识库回答安全相关问题。对可能的失陷要给出初步处置建议。
+model: itops_root.models.MockSubAgentLlm