Skip to content

refactor(deployment): Standardizes service names to use hyphens instead of underscores for RFC1123 compliance (resolves #1777). #1785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
junhaoliao wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

refactor(deployment): Standardizes service names to use hyphens instead of underscores for RFC1123 compliance (resolves #1777). #1785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e37037e
refactor(deployment): Standardizes service names to use hyphens inste…
junhaoliao Dec 16, 2025
a44216f
docs: Update service names in orchestration design docs to use hyphen…
junhaoliao Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions components/clp-py-utils/clp_py_utils/clp_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@
DB_COMPONENT_NAME = "database"
QUEUE_COMPONENT_NAME = "queue"
REDIS_COMPONENT_NAME = "redis"
SPIDER_SCHEDULER_COMPONENT_NAME = "spider_scheduler"
SPIDER_SCHEDULER_COMPONENT_NAME = "spider-scheduler"
REDUCER_COMPONENT_NAME = "reducer"
RESULTS_CACHE_COMPONENT_NAME = "results_cache"
COMPRESSION_SCHEDULER_COMPONENT_NAME = "compression_scheduler"
QUERY_SCHEDULER_COMPONENT_NAME = "query_scheduler"
RESULTS_CACHE_COMPONENT_NAME = "results-cache"
COMPRESSION_SCHEDULER_COMPONENT_NAME = "compression-scheduler"
QUERY_SCHEDULER_COMPONENT_NAME = "query-scheduler"
PRESTO_COORDINATOR_COMPONENT_NAME = "presto-coordinator"
COMPRESSION_WORKER_COMPONENT_NAME = "compression_worker"
QUERY_WORKER_COMPONENT_NAME = "query_worker"
API_SERVER_COMPONENT_NAME = "api_server"
LOG_INGESTOR_COMPONENT_NAME = "log_ingestor"
COMPRESSION_WORKER_COMPONENT_NAME = "compression-worker"
QUERY_WORKER_COMPONENT_NAME = "query-worker"
API_SERVER_COMPONENT_NAME = "api-server"
LOG_INGESTOR_COMPONENT_NAME = "log-ingestor"
WEBUI_COMPONENT_NAME = "webui"
MCP_SERVER_COMPONENT_NAME = "mcp_server"
GARBAGE_COLLECTOR_COMPONENT_NAME = "garbage_collector"
MCP_SERVER_COMPONENT_NAME = "mcp-server"
GARBAGE_COLLECTOR_COMPONENT_NAME = "garbage-collector"

# Action names
ARCHIVE_MANAGER_ACTION_NAME = "archive_manager"
Expand Down
22 changes: 11 additions & 11 deletions docs/src/dev-docs/design-deployment-orchestration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,19 +151,19 @@ graph LR
| database | Database for archive metadata, compression jobs, and query jobs |
| queue | Task queue for schedulers |
| redis | Task result storage for workers |
| compression_scheduler | Scheduler for compression jobs |
| query_scheduler | Scheduler for search/aggregation jobs |
| spider_scheduler | Scheduler for Spider distributed task execution framework |
| results_cache | Storage for the workers to return search results to the UI |
| compression_worker | Worker processes for compression jobs using Celery |
| spider_compression_worker | Worker processes for compression jobs using Spider |
| query_worker | Worker processes for search/aggregation jobs using Celery |
| compression-scheduler | Scheduler for compression jobs |
| query-scheduler | Scheduler for search/aggregation jobs |
| spider-scheduler | Scheduler for Spider distributed task execution framework |
| results-cache | Storage for the workers to return search results to the UI |
| compression-worker | Worker processes for compression jobs using Celery |
| spider-compression-worker | Worker processes for compression jobs using Spider |
| query-worker | Worker processes for search/aggregation jobs using Celery |
| reducer | Reducers for performing the final stages of aggregation jobs |
| api_server | API server for submitting queries |
| api-server | API server for submitting queries |
| webui | Web server for the UI |
| mcp_server | MCP server for AI agent to access CLP functionalities |
| garbage_collector | Process to manage data retention |
| log_ingestor | Server for orchestrating and running continuous log ingestion jobs |
| mcp-server | MCP server for AI agent to access CLP functionalities |
| garbage-collector | Process to manage data retention |
| log-ingestor | Server for orchestrating and running continuous log ingestion jobs |

:::

Expand Down
37 changes: 13 additions & 24 deletions integration-tests/tests/utils/clp_mode_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,38 +40,27 @@
}


# TODO: This will eventually be replaced by a formalized mapping between component and service.
def _to_docker_compose_service_name(name: str) -> str:
"""
Convert a component name to a Docker Compose service name.

:param name:
:return: Service name with underscores replaced by hyphens
"""
return name.replace("_", "-")


# TODO: Modify these component lists when the Presto Docker Compose project is integrated with the
# CLP Docker compose project.
CLP_BASE_COMPONENTS = [
_to_docker_compose_service_name(DB_COMPONENT_NAME),
_to_docker_compose_service_name(QUEUE_COMPONENT_NAME),
_to_docker_compose_service_name(REDIS_COMPONENT_NAME),
_to_docker_compose_service_name(REDUCER_COMPONENT_NAME),
_to_docker_compose_service_name(RESULTS_CACHE_COMPONENT_NAME),
_to_docker_compose_service_name(COMPRESSION_SCHEDULER_COMPONENT_NAME),
_to_docker_compose_service_name(COMPRESSION_WORKER_COMPONENT_NAME),
_to_docker_compose_service_name(WEBUI_COMPONENT_NAME),
DB_COMPONENT_NAME,
QUEUE_COMPONENT_NAME,
REDIS_COMPONENT_NAME,
REDUCER_COMPONENT_NAME,
RESULTS_CACHE_COMPONENT_NAME,
COMPRESSION_SCHEDULER_COMPONENT_NAME,
COMPRESSION_WORKER_COMPONENT_NAME,
WEBUI_COMPONENT_NAME,
]

CLP_QUERY_COMPONENTS = [
_to_docker_compose_service_name(QUERY_SCHEDULER_COMPONENT_NAME),
_to_docker_compose_service_name(QUERY_WORKER_COMPONENT_NAME),
QUERY_SCHEDULER_COMPONENT_NAME,
QUERY_WORKER_COMPONENT_NAME,
]

CLP_API_SERVER_COMPONENT = _to_docker_compose_service_name(API_SERVER_COMPONENT_NAME)
CLP_GARBAGE_COLLECTOR_COMPONENT = _to_docker_compose_service_name(GARBAGE_COLLECTOR_COMPONENT_NAME)
CLP_MCP_SERVER_COMPONENT = _to_docker_compose_service_name(MCP_SERVER_COMPONENT_NAME)
CLP_API_SERVER_COMPONENT = API_SERVER_COMPONENT_NAME
CLP_GARBAGE_COLLECTOR_COMPONENT = GARBAGE_COLLECTOR_COMPONENT_NAME
CLP_MCP_SERVER_COMPONENT = MCP_SERVER_COMPONENT_NAME


def get_clp_config_from_mode(mode_name: str) -> ClpConfig:
Expand Down
Loading
Loading