Merge remote-tracking branch 'upstream/main'

Author: loveyana

assets/images/logo.png

@@ -31,13 +31,19 @@ Run python `deploy.py` for deployment on Volcengine FaaS platform.
 它会提示你输入如下几个参数：
 
 - 本地项目名称（即项目的本地目录名称）
-- VeFaaS应用名称（不可带下划线）
-- 火山引擎网关实例名称（可选）
-- 火山引擎网关服务名称（可选）
-- 火山引擎网关Upstream名称（可选）
+- 火山引擎函数服务应用名称（不可带下划线）
+- 火山引擎API网关实例名称（可选）
+- 火山引擎API网关服务名称（可选）
+- 火山引擎API网关Upstream名称（可选）
 - 部署模式
   1. A2A / MCP Server
   2. VeADK Web
+- 认证方式
+  1. 不认证
+  2. API key（仅限A2A / MCP Server的部署模式）
+  3. OAuth2
+- 火山引擎Identity用户池名称（可选）
+- 火山引擎Identity客户端名称（可选，仅限VeADK Web的部署模式）
 
 生成后的项目结构如下：
 

docs/content/9.deploy/1.from-scratch.md

@@ -21,10 +21,13 @@ navigation:
 | - | - | - |
 | `--access-key` | 字符串 | 火山引擎AK |
 | `--secret-key` | 字符串 | 火山引擎SK |
-| `--vefaas-app-name` | 字符串 | 火山引擎 VeFaaS 平台应用名称 |
-| `--veapig-instance-name` | 字符串 | 火山引擎 APIG 实例名称 |
-| `--veapig-service-name` | 字符串 | 火山引擎 APIG 服务名称 |
-| `--veapig-upstream-name` | 字符串 | 火山引擎 APIG Upstream 名称 |
+| `--vefaas-app-name` | 字符串 | 火山引擎函数服务应用名称 |
+| `--veapig-instance-name` | 字符串 | 火山引擎 API 网关实例名称 |
+| `--veapig-service-name` | 字符串 | 火山引擎 API 网关服务名称 |
+| `--veapig-upstream-name` | 字符串 | 火山引擎 API 网关 Upstream 名称 |
 | `--short-term-memory-backend` | `local` \| `mysql` | 短期记忆后端 |
 | `--use-adk-web` | FLAG | 设置后将会在云端启动 web，否则为 A2A / MCP 模式 |
 | `--path` | 字符串 | 本地项目路径，默认为当前目录 |
+| `--auth-method` | `none` \| `api-key` \| `oauth2` | 认证方式 |
+| `--user-pool-name` | 字符串 | 火山引擎 Identity 用户池名称 |
+| `--client-name` | 字符串 | 火山引擎 Identity 客户端名称 |

docs/content/9.deploy/2.from-proj.md

@@ -28,11 +28,14 @@ cloud_app = engine.deploy(...)
 | 参数名称 | 类型 | 说明 |
 | --- | --- | --- |
 | path | str | 本地Agent项目路径 |
-| application_name | str | 云应用名称 |
-| gateway_name | str | 火山引擎网关实例名称 |
-| gateway_service_name | str | 火山引擎网关服务名称 |
-| gateway_upstream_name | str | 火山引擎网关Upstream名称 |
+| application_name | str | 函数服务应用名称 |
+| gateway_name | str | 火山引擎 API 网关实例名称 |
+| gateway_service_name | str | 火山引擎 API 网关服务名称 |
+| gateway_upstream_name | str | 火山引擎 API 网关Upstream名称 |
 | use_adk_web | bool | 是否在云端使用VeADK Web / Google Web |
+| auth_method | str | 认证方式 |
+| identity_user_pool_name | str | 火山引擎 Identity 用户池名称 |
+| identity_client_name | str | 火山引擎 Identity 客户端名称 |
 
 ### Cloud App
 

docs/content/9.deploy/3.from-code.md

@@ -1,6 +1,6 @@
 [project]
 name = "veadk-python"
-version = "0.2.22"
+version = "0.2.23"
 description = "Volcengine agent development kit, integrations with Volcengine cloud services."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -22,7 +22,7 @@ dependencies = [
     "opentelemetry-instrumentation-logging>=0.56b0",
     "wrapt>=1.17.2", # For patching built-in functions
     "openai<1.100", # For fix https://github.com/BerriAI/litellm/issues/13710
-    "volcengine-python-sdk>=4.0.18", # For Volcengine API
+    "volcengine-python-sdk>=4.0.33", # For Volcengine API
     "volcengine>=1.0.193", # For Volcengine sign
     "agent-pilot-sdk>=0.1.2", # Prompt optimization by Volcengine AgentPilot/PromptPilot toolkits
     "fastmcp>=2.11.3", # For running MCP
@@ -33,7 +33,9 @@ dependencies = [
     "llama-index-llms-openai-like>=0.5.1",
     "llama-index-vector-stores-opensearch>=0.6.1",
     "psycopg2-binary>=2.9.10", # For PostgreSQL database (short term memory)
+    "asyncpg>=0.29.0", # For async PostgreSQL database (short term memory)
     "pymysql>=1.1.1", # For MySQL database (short term memory)
+    "aiomysql>=0.3.2", # For async MySQL database (short term memory)
     "opensearch-py==2.8.0",
     "filetype>=1.2.0",
 ]

pyproject.toml

@@ -61,6 +61,12 @@ async def test_cloud():
                 mock_vefaas_service.find_app_id_by_name.return_value = "app-123"
                 mock_vefaas_service.delete.return_value = None
 
+                mock_vefaas_service.get_application_route.return_value = (
+                    "gw-123",
+                    "svc-456",
+                    "route-789",
+                )
+
                 # Test CloudAgentEngine creation and deploy functionality
                 engine = CloudAgentEngine()
 

tests/test_cloud.py

@@ -48,7 +48,6 @@
 from veadk.tracing.base_tracer import BaseTracer
 from veadk.utils.logger import get_logger
 from veadk.utils.patches import patch_asyncio, patch_tracer
-from veadk.tools.builtin_tools.agent_authorization import check_agent_authorization
 from veadk.version import VERSION
 
 patch_tracer()
@@ -188,6 +187,10 @@ def model_post_init(self, __context: Any) -> None:
             self.tools.append(load_memory)
 
         if self.enable_authz:
+            from veadk.tools.builtin_tools.agent_authorization import (
+                check_agent_authorization,
+            )
+
             if self.before_agent_callback:
                 if isinstance(self.before_agent_callback, list):
                     self.before_agent_callback.append(check_agent_authorization)

veadk/agent.py

@@ -50,6 +50,22 @@
     help="Backend for short-term memory",
 )
 @click.option("--use-adk-web", is_flag=True, help="Whether to use ADK Web")
+@click.option(
+    "--auth-method",
+    default="none",
+    type=click.Choice(["none", "api-key", "oauth2"]),
+    help="=Authentication method for agent",
+)
+@click.option(
+    "--user-pool-name",
+    default="",
+    help="Expected Volcengine Identity user pool name",
+)
+@click.option(
+    "--client-name",
+    default="",
+    help="Expected Volcengine Identity client name",
+)
 @click.option("--path", default=".", help="Local project path")
 def deploy(
     volcengine_access_key: str,
@@ -60,6 +76,9 @@ def deploy(
     veapig_upstream_name: str,
     short_term_memory_backend: str,
     use_adk_web: bool,
+    auth_method: str,
+    user_pool_name: str,
+    client_name: str,
     path: str,
 ) -> None:
     """Deploy a user project to Volcengine FaaS application.
@@ -90,6 +109,10 @@ def deploy(
         short_term_memory_backend: Backend type for short-term memory storage.
             Choices are 'local' or 'mysql'
         use_adk_web: Flag to enable ADK Web interface for the deployed agent
+        auth_method: Authentication for the agent.
+            Choices are 'none', 'api-key' or 'oauth2'.
+        veidentity_user_pool_name: Optional Volcengine Identity user pool name
+        veidentity_client_name: Optional Volcengine Identity client name
         path: Local directory path containing the VeADK project to deploy
 
     Note:
@@ -131,6 +154,9 @@ def deploy(
         "veapig_service_name": veapig_service_name,
         "veapig_upstream_name": veapig_upstream_name,
         "use_adk_web": use_adk_web,
+        "auth_method": auth_method,
+        "veidentity_user_pool_name": user_pool_name,
+        "veidentity_client_name": client_name,
         "veadk_version": VERSION,
     }
 

veadk/cli/cli_deploy.py

@@ -61,13 +61,49 @@ def _render_prompts() -> dict[str, Any]:
     deploy_mode = click.prompt(
         "Enter your choice", type=click.Choice(deploy_mode_options.keys())
     )
+    use_adk_web = deploy_mode == "2"
+
+    auth_method_options = {
+        "1": "None",
+        "2": "API key",
+        "3": "OAuth2",
+    }
+    auth_methods = {
+        "1": "none",
+        "2": "api-key",
+        "3": "oauth2",
+    }
+
+    click.echo("Choose an authentication method:")
+    for key, value in auth_method_options.items():
+        click.echo(f"  {key}. {value}")
+
+    auth_method_idx = click.prompt(
+        "Enter your choice", type=click.Choice(auth_method_options.keys())
+    )
+    auth_method = auth_methods[auth_method_idx]
+
+    veidentity_user_pool_name = ""
+    veidentity_client_name = ""
+    if auth_method == "oauth2":
+        veidentity_user_pool_name = click.prompt(
+            "Volcengine Identity user pool name", default="", show_default=True
+        )
+
+        if use_adk_web:
+            veidentity_client_name = click.prompt(
+                "Volcengine Identity client name", default="", show_default=True
+            )
 
     return {
         "vefaas_application_name": vefaas_application_name,
         "veapig_instance_name": veapig_instance_name,
         "veapig_service_name": veapig_service_name,
         "veapig_upstream_name": veapig_upstream_name,
-        "use_adk_web": deploy_mode == "2",
+        "use_adk_web": use_adk_web,
+        "auth_method": auth_method,
+        "veidentity_user_pool_name": veidentity_user_pool_name,
+        "veidentity_client_name": veidentity_client_name,
         "veadk_version": VERSION,
     }