feat: deploy with API key authentication

Signed-off-by: Xie Zhihao <zhihao.xie@bytedance.com>

Author: zhxie

veadk/cli/cli_deploy.py

@@ -49,6 +49,12 @@
     type=click.Choice(["local", "mysql"]),
     help="Backend for short-term memory",
 )
+@click.option(
+    "--auth-method",
+    default="none",
+    type=click.Choice(["none", "api-key"]),
+    help="=Authentication method for agent",
+)
 @click.option("--use-adk-web", is_flag=True, help="Whether to use ADK Web")
 @click.option("--path", default=".", help="Local project path")
 def deploy(
@@ -60,6 +66,7 @@ def deploy(
     veapig_upstream_name: str,
     short_term_memory_backend: str,
     use_adk_web: bool,
+    auth_method: str,
     path: str,
 ) -> None:
     """Deploy a user project to Volcengine FaaS application.
@@ -90,6 +97,8 @@ 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'.
         path: Local directory path containing the VeADK project to deploy
 
     Note:
@@ -131,6 +140,7 @@ def deploy(
         "veapig_service_name": veapig_service_name,
         "veapig_upstream_name": veapig_upstream_name,
         "use_adk_web": use_adk_web,
+        "auth_method": auth_method,
         "veadk_version": VERSION,
     }
 

veadk/cli/cli_init.py

@@ -61,13 +61,33 @@ 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",
+    }
+    auth_methods = {
+        "1": "none",
+        "2": "api-key",
+    }
+
+    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]
 
     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,
         "veadk_version": VERSION,
     }
 

veadk/cloud/cloud_agent_engine.py

@@ -197,6 +197,7 @@ def deploy(
         gateway_name: str = "",
         gateway_service_name: str = "",
         gateway_upstream_name: str = "",
+        auth_method: str = "none",
         use_adk_web: bool = False,
         local_test: bool = False,
     ) -> CloudApp:
@@ -210,6 +211,7 @@ def deploy(
             gateway_name (str, optional): Custom gateway resource name. Defaults to timestamped.
             gateway_service_name (str, optional): Custom service name. Defaults to timestamped.
             gateway_upstream_name (str, optional): Custom upstream name. Defaults to timestamped.
+            auth_method (str, optional): Authentication for the agent. Defaults to none.
             use_adk_web (bool): Enable ADK Web configuration. Defaults to False.
             local_test (bool): Perform FastAPI server test before deploy. Defaults to False.
 
@@ -232,6 +234,10 @@ def deploy(
         # prevent deepeval writing operations
         veadk_environments["DEEPEVAL_TELEMETRY_OPT_OUT"] = "YES"
 
+        enable_key_auth = False
+        if auth_method == "api-key":
+            enable_key_auth = True
+
         if use_adk_web:
             veadk_environments["USE_ADK_WEB"] = "True"
         else:
@@ -258,6 +264,7 @@ def deploy(
                 gateway_name=gateway_name,
                 gateway_service_name=gateway_service_name,
                 gateway_upstream_name=gateway_upstream_name,
+                enable_key_auth=enable_key_auth,
             )
             _ = function_id  # for future use
 

veadk/integrations/ve_faas/template/cookiecutter.json

@@ -8,5 +8,6 @@
   "veapig_service_name": "",
   "veapig_upstream_name": "",
   "use_adk_web": false,
+  "auth_method": "none",
   "veadk_version": ""
 }

veadk/integrations/ve_faas/template/{{cookiecutter.local_dir_name}}/deploy.py

@@ -84,6 +84,7 @@ async def main():
         gateway_service_name="{{cookiecutter.veapig_service_name}}",
         gateway_upstream_name="{{cookiecutter.veapig_upstream_name}}",
         use_adk_web={{cookiecutter.use_adk_web}},
+        auth_method="{{cookiecutter.auth_method}}",
         local_test=False,  # Set to True for local testing before deploy to VeFaaS
     )
     print(f"VeFaaS application ID: {cloud_app.vefaas_application_id}")

veadk/integrations/ve_faas/ve_faas.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 import json
-import os
 import time
 
 import requests
@@ -141,9 +140,8 @@ def _create_application(
         gateway_name: str,
         upstream_name: str,
         service_name: str,
+        enable_key_auth: bool = False,
     ):
-        enable_key_auth = os.getenv("VEFAAS_ENABLE_KEY_AUTH", "true").lower() == "true"
-
         response = ve_request(
             request_body={
                 "Name": application_name,
@@ -386,6 +384,7 @@ def deploy(
         gateway_name: str = "",
         gateway_service_name: str = "",
         gateway_upstream_name: str = "",
+        enable_key_auth: bool = False,
     ) -> tuple[str, str, str]:
         """Deploy an agent project to VeFaaS service.
 
@@ -395,6 +394,7 @@ def deploy(
             gateway_name (str, optional): Gateway name. Defaults to "".
             gateway_service_name (str, optional): Gateway service name. Defaults to "".
             gateway_upstream_name (str, optional): Gateway upstream name. Defaults to "".
+            enable_key_auth (bool, optional): Enable key auth. Defaults to False.
 
         Returns:
             tuple[str, str, str]: (url, app_id, function_id)
@@ -439,6 +439,7 @@ def deploy(
             gateway_name,
             gateway_upstream_name,
             gateway_service_name,
+            enable_key_auth,
         )
 
         logger.info(f"VeFaaS application {name} with ID {app_id} created.")

veadk/integrations/ve_faas/web_template/cookiecutter.json

@@ -6,6 +6,7 @@
   "veapig_service_name": "",
   "veapig_upstream_name": "",
   "use_adk_web": false,
+  "auth_method": "none",
   "veadk_version": "",
   "_copy_without_render": [
     "*.html",

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/deploy.py

@@ -27,6 +27,7 @@ async def main():
         gateway_service_name="{{cookiecutter.veapig_service_name}}",
         gateway_upstream_name="{{cookiecutter.veapig_upstream_name}}",
         use_adk_web={{cookiecutter.use_adk_web}},
+        auth_method="{{cookiecutter.auth_method}}",
         local_test=False,  # Set to True for local testing before deploy to VeFaaS
     )
     print(f"VeFaaS application ID: {cloud_app.vefaas_application_id}")