Skip to content

Commit aaec572

Browse files
committed
refactor: centralize default template names for CR instance and TOS bucket to constants
- Move default template names from service classes to constants.py for better maintainability - Replace hardcoded "agentkit-cli-{{account_id}}" with DEFAULT_CR_INSTANCE_TEMPLATE_NAME constant - Replace hardcoded "agentkit-cli-{{account_id}}" with DEFAULT_TOS_BUCKET_TEMPLATE_NAME constant - Update template names from "agentkit-cli-{{account_id}}" to "agentkit-platform-{{account_id}}" - Remove CRService.default_cr_instance (cherry picked from commit 93aed2c5b75c81cf5eda44e1c2bdc263b0d5c887)
1 parent e311fec commit aaec572

File tree

7 files changed

+17
-20
lines changed

7 files changed

+17
-20
lines changed

agentkit/toolkit/config/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
"AUTO_CREATE_VE",
6565
"DEFAULT_WORKSPACE_NAME",
6666
"DEFAULT_CR_NAMESPACE",
67+
"DEFAULT_CR_INSTANCE_TEMPLATE_NAME",
68+
"DEFAULT_TOS_BUCKET_TEMPLATE_NAME",
6769
"DEFAULT_IMAGE_TAG",
6870
"GLOBAL_CONFIG_DIR",
6971
"GLOBAL_CONFIG_FILE",

agentkit/toolkit/config/constants.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
AUTO_CREATE_VE = "Auto"
2626
DEFAULT_WORKSPACE_NAME = "agentkit-cli-workspace"
2727
DEFAULT_CR_NAMESPACE = "agentkit"
28+
DEFAULT_CR_INSTANCE_TEMPLATE_NAME = "agentkit-platform-{{account_id}}"
29+
DEFAULT_TOS_BUCKET_TEMPLATE_NAME = "agentkit-platform-{{account_id}}"
2830

2931
# Default image tag placeholder for timestamped builds
3032
DEFAULT_IMAGE_TAG = "{{timestamp}}"

agentkit/toolkit/config/strategy_configs.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from dataclasses import dataclass, field
22
from typing import Dict, List
33
from .dataclass_utils import AutoSerializableMixin
4-
from .constants import AUTO_CREATE_VE, DEFAULT_CR_NAMESPACE, DEFAULT_IMAGE_TAG, DEFAULT_WORKSPACE_NAME
4+
from .constants import AUTO_CREATE_VE, DEFAULT_CR_NAMESPACE, DEFAULT_IMAGE_TAG, DEFAULT_WORKSPACE_NAME, DEFAULT_CR_INSTANCE_TEMPLATE_NAME, DEFAULT_TOS_BUCKET_TEMPLATE_NAME
55

66

77
@dataclass
@@ -55,7 +55,7 @@ class HybridStrategyConfig(AutoSerializableMixin):
5555
region: str = field(default="cn-beijing", metadata={"description": "Volcano Engine service region", "icon": "🌏", "aliases": ["ve_region"]})
5656

5757
# Container Registry (CR) configuration
58-
cr_instance_name: str = field(default=AUTO_CREATE_VE, metadata={"description": "Container Registry instance name", "icon": "📦", "render_template": True, "default_template": "agentkit-cli-{{account_id}}", "aliases": ["ve_cr_instance_name"]})
58+
cr_instance_name: str = field(default=AUTO_CREATE_VE, metadata={"description": "Container Registry instance name", "icon": "📦", "render_template": True, "default_template": DEFAULT_CR_INSTANCE_TEMPLATE_NAME, "aliases": ["ve_cr_instance_name"]})
5959
cr_namespace_name: str = field(default=DEFAULT_CR_NAMESPACE, metadata={"description": "Container Registry namespace", "icon": "📁", "render_template": True, "aliases": ["ve_cr_namespace_name"]})
6060
cr_repo_name: str = field(default="", metadata={"description": "Container Registry repository name", "icon": "📋", "aliases": ["ve_cr_repo_name"]})
6161
cr_image_full_url: str = field(default="", metadata={"system": True, "description": "Full Container Registry image URL", "aliases": ["ve_cr_image_full_url"]})
@@ -101,15 +101,15 @@ class CloudStrategyConfig(AutoSerializableMixin):
101101
)
102102

103103
# Tencent Object Storage (TOS) configuration for build artifacts
104-
tos_bucket: str = field(default=AUTO_CREATE_VE, metadata={"system": True, "description": "TOS bucket name for storing build artifacts", "icon": "🗂️", "render_template": True, "default_template": "agentkit-cli-{{account_id}}"})
104+
tos_bucket: str = field(default=AUTO_CREATE_VE, metadata={"system": True, "description": "TOS bucket name for storing build artifacts", "icon": "🗂️", "render_template": True, "default_template": DEFAULT_TOS_BUCKET_TEMPLATE_NAME})
105105
tos_prefix: str = field(default="agentkit-builds", metadata={"system": True, "description": "TOS object prefix for build artifacts"})
106106
tos_region: str = field(default="cn-beijing", metadata={"system": True, "description": "TOS service region"})
107107
tos_object_key: str = field(default="", metadata={"system": True, "description": "TOS object key for uploaded build artifact"})
108108
tos_object_url: str = field(default="", metadata={"system": True, "description": "TOS object URL for build artifact"})
109109

110110
# Container Registry (CR) configuration for Docker images
111111
image_tag: str = field(default=DEFAULT_IMAGE_TAG, metadata={"system": True, "description": "Docker image tag", "icon": "🏷️", "render_template": True})
112-
cr_instance_name: str = field(default=AUTO_CREATE_VE, metadata={"description": "Container Registry instance name", "icon": "📦", "render_template": True, "default_template": "agentkit-cli-{{account_id}}", "aliases": ["ve_cr_instance_name"]})
112+
cr_instance_name: str = field(default=AUTO_CREATE_VE, metadata={"description": "Container Registry instance name", "icon": "📦", "render_template": True, "default_template": DEFAULT_CR_INSTANCE_TEMPLATE_NAME, "aliases": ["ve_cr_instance_name"]})
113113
cr_namespace_name: str = field(default=DEFAULT_CR_NAMESPACE, metadata={"description": "Container Registry namespace", "icon": "📁", "render_template": True, "aliases": ["ve_cr_namespace_name"]})
114114
cr_repo_name: str = field(default="", metadata={"description": "Container Registry repository name (defaults to AgentKit project name)", "icon": "📋", "aliases": ["ve_cr_repo_name"]})
115115
cr_region: str = field(default="cn-beijing", metadata={"system": True, "description": "Container Registry service region", "aliases": ["ve_cr_region"]})

agentkit/toolkit/executors/init_executor.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
global_config_exists,
4747
get_global_config,
4848
)
49+
from agentkit.toolkit.config.constants import DEFAULT_CR_INSTANCE_TEMPLATE_NAME, DEFAULT_TOS_BUCKET_TEMPLATE_NAME
4950

5051

5152
TEMPLATES = {
@@ -444,7 +445,7 @@ def _setup_config_launch_type(self, config_manager, common_config):
444445
cloud_config.cr_instance_name = ""
445446
self.logger.debug("Using global CR instance config")
446447
else:
447-
cloud_config.cr_instance_name = CRService.default_cr_instance_name_template()
448+
cloud_config.cr_instance_name = DEFAULT_CR_INSTANCE_TEMPLATE_NAME
448449

449450
if global_config and global_config.cr.namespace_name:
450451
cloud_config.cr_namespace_name = ""
@@ -456,7 +457,7 @@ def _setup_config_launch_type(self, config_manager, common_config):
456457
cloud_config.tos_bucket = ""
457458
self.logger.debug("Using global TOS bucket config")
458459
else:
459-
cloud_config.tos_bucket = TOSService.default_bucket_name_template()
460+
cloud_config.tos_bucket = DEFAULT_TOS_BUCKET_TEMPLATE_NAME
460461

461462
if global_config and global_config.tos.prefix:
462463
cloud_config.tos_prefix = ""
@@ -485,7 +486,7 @@ def _setup_config_launch_type(self, config_manager, common_config):
485486
hybrid_config.cr_instance_name = ""
486487
self.logger.debug("Using global CR instance config")
487488
else:
488-
hybrid_config.cr_instance_name = CRService.default_cr_instance_name_template()
489+
hybrid_config.cr_instance_name = DEFAULT_CR_INSTANCE_TEMPLATE_NAME
489490

490491
if global_config and global_config.cr.namespace_name:
491492
hybrid_config.cr_namespace_name = ""

agentkit/toolkit/volcengine/services/cr_service.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
from agentkit.utils.ve_sign import get_volc_ak_sk_region
2020
import agentkit.toolkit.volcengine.cr as ve_cr
2121
import agentkit.toolkit.config as config
22-
from agentkit.toolkit.config import AUTO_CREATE_VE
22+
from agentkit.toolkit.config import AUTO_CREATE_VE, DEFAULT_CR_INSTANCE_TEMPLATE_NAME
2323
from agentkit.toolkit.config.dataclass_utils import AutoSerializableMixin
2424
from agentkit.toolkit.reporter import Reporter
2525
from agentkit.toolkit.context import ExecutionContext
@@ -429,16 +429,12 @@ def get_cr_config(self) -> Dict[str, Any]:
429429
except Exception as e:
430430
logger.warning(f"Failed to retrieve CR configuration: {str(e)}")
431431
return {}
432-
433-
@staticmethod
434-
def default_cr_instance_name_template():
435-
return "agentkit-cli-{{account_id}}"
436432

437433
@staticmethod
438434
def generate_cr_instance_name() -> str:
439435
"""Generate a CR instance name from the default template."""
440436
from agentkit.utils.template_utils import render_template
441-
cr_instance_name_template = CRService.default_cr_instance_name_template()
437+
cr_instance_name_template = DEFAULT_CR_INSTANCE_TEMPLATE_NAME
442438
rendered = render_template(cr_instance_name_template)
443439
return rendered
444440

agentkit/toolkit/volcengine/services/tos_service.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import logging
1717
from dataclasses import dataclass, field
1818
from agentkit.toolkit.config.dataclass_utils import AutoSerializableMixin
19+
from agentkit.toolkit.config.constants import DEFAULT_TOS_BUCKET_TEMPLATE_NAME
1920

2021
try:
2122
import tos
@@ -286,7 +287,7 @@ def generate_bucket_name(prefix: str = "agentkit") -> str:
286287
"""
287288
import re
288289
from agentkit.utils.template_utils import render_template
289-
bucket_name = TOSService.default_bucket_name_template()
290+
bucket_name = DEFAULT_TOS_BUCKET_TEMPLATE_NAME
290291
bucket_name = render_template(bucket_name)
291292

292293
# Verify template was fully rendered (no unresolved variables remain)
@@ -303,8 +304,3 @@ def generate_bucket_name(prefix: str = "agentkit") -> str:
303304
bucket_name = f"{prefix}-bucket-{generate_random_id(4)}".lower()
304305

305306
return bucket_name
306-
307-
@staticmethod
308-
def default_bucket_name_template() -> str:
309-
"""Return the default template for generating bucket names."""
310-
return "agentkit-cli-{{account_id}}"

agentkit/utils/template_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
2323
Example:
2424
>>> from agentkit.utils.template_utils import render_template
25-
>>> result = render_template("agentkit-cli-{{account_id}}")
25+
>>> result = render_template("agentkit-platform-{{account_id}}")
2626
"""
2727

2828
import re

0 commit comments

Comments
 (0)