Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 10 additions & 29 deletions docs/src/dev-docs/design-deployment-orchestration.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have a docker-compose file for the legacy spider setup. We don't need to remove it in this PR, but we should probably make an issue to keep track of it for removal.

Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ graph LR
results_cache["results-cache (MongoDB)"]
compression_scheduler["compression-scheduler"]
query_scheduler["query-scheduler"]
spider_scheduler["spider-scheduler"]
compression_worker["compression-worker"]
spider_compression_worker["spider-compression-worker"]
query_worker["query-worker"]
reducer["reducer"]
api_server["api-server"]
Expand Down Expand Up @@ -77,25 +75,23 @@ graph LR
query_scheduler -->|healthy| reducer
linkStyle 6 stroke:#800080

%% Link 7-15: Database initialization job --> Services
%% Link 7-13: Database initialization job --> Services
db_table_creator -->|completed_successfully| api_server
db_table_creator -->|completed_successfully| compression_scheduler
db_table_creator -->|completed_successfully| garbage_collector
db_table_creator -->|completed_successfully| log_ingestor
db_table_creator -->|completed_successfully| mcp_server
db_table_creator -->|completed_successfully| query_scheduler
db_table_creator -->|completed_successfully| spider_compression_worker
db_table_creator -->|completed_successfully| spider_scheduler
db_table_creator -->|completed_successfully| webui
linkStyle 7,8,9,10,11,12,13,14,15 stroke:#0000ff
linkStyle 7,8,9,10,11,12,13 stroke:#0000ff

%% Link 16-20: Results cache initialization job --> Services
%% Link 14-18: Results cache initialization job --> Services
results_cache_indices_creator -->|completed_successfully| api_server
results_cache_indices_creator -->|completed_successfully| garbage_collector
results_cache_indices_creator -->|completed_successfully| mcp_server
results_cache_indices_creator -->|completed_successfully| reducer
results_cache_indices_creator -->|completed_successfully| webui
linkStyle 16,17,18,19,20 stroke:#008000
linkStyle 14,15,16,17,18 stroke:#008000

subgraph Databases
database
Expand All @@ -114,12 +110,10 @@ graph LR
subgraph Schedulers
compression_scheduler
query_scheduler
spider_scheduler
end

subgraph Workers
compression_worker
spider_compression_worker
query_worker
reducer
end
Expand All @@ -137,8 +131,6 @@ graph LR

%% Subgraph styles
style celery_dependencies fill:#ffffe0
style spider_compression_worker fill:#008080
style spider_scheduler fill:#008080

+++
**Figure 1**: Orchestration architecture of the services in the CLP package.
Expand All @@ -157,10 +149,8 @@ graph LR
| 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 |
| reducer | Reducers for performing the final stages of aggregation jobs |
| api_server | API server for submitting queries |
Expand Down Expand Up @@ -251,23 +241,14 @@ Services require persistent storage for logs, data, archives, and streams.

### Deployment types

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this section may require a sanity check from @junhaoliao.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


CLP supports multiple deployment configurations based on the compression scheduler and query engine.
CLP supports two deployment configurations, depending on the query engine:

| Deployment Type | Compression Scheduler | Query Engine |
|-----------------|-----------------------|------------------------------|
| Base | Celery | [Presto][presto-integration] |
| Full | Celery | Native |
| Spider Base | Spider | [Presto][presto-integration] |
| Spider Full | Spider | Native |
* **Full**: Uses Celery for query orchestration.
* **Base**: Excludes the Celery-based query orchestration in Full, to support the
[Presto integration][presto-integration].
Comment thread
LinZhihao-723 marked this conversation as resolved.

:::{note}
Spider support is not yet available for Helm.
:::

Docker Compose selects the appropriate compose file (e.g., `docker-compose.yaml` for Full,
`docker-compose-spider.yaml` for Spider Full) and uses `deploy.replicas` with environment
variables (e.g., `CLP_MCP_SERVER_ENABLED`) to toggle optional services. Helm uses conditional
templating to include/exclude resources.
Docker Compose uses `deploy.replicas` with environment variables (e.g., `CLP_MCP_SERVER_ENABLED`)
to toggle optional services. Helm uses conditional templating to include or exclude resources.
Comment on lines 242 to +251

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's only one type of compression scheduler now, shall we remove the "Compression Scheduler" column?
Depending on how we're gonna add the new Spider stuff, I will reword the table in a later PR.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's only one type of compression scheduler now, shall we remove the "Compression Scheduler" column?

i agree.

it might be easier to read today by turning the table into a simple list. e.g.,

CLP supports two deployment configurations, depending on the query engine:

  • Full: Uses Celery for query orchestration.
  • Base: Excludes the Celery-based orchestration in Full, to support the [Presto integration][presto-integration].


## Troubleshooting

Expand Down
14 changes: 1 addition & 13 deletions docs/src/user-docs/guides-docker-compose-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,6 @@ docker compose \
up compression-scheduler \
--no-deps --wait

# Start Spider scheduler (optional, only if using Spider)
docker compose \
--project-name "clp-package-$(cat var/log/instance-id)" \
up spider-scheduler \
--no-deps --wait

# Start query scheduler
docker compose \
--project-name "clp-package-$(cat var/log/instance-id)" \
Expand Down Expand Up @@ -245,17 +239,11 @@ docker compose \
# Worker services (can be started on multiple hosts)
################################################################################

# Start compression worker (if using Celery)
# Start compression worker
docker compose \
--project-name "clp-package-$(cat var/log/instance-id)" \
up compression-worker \
--no-deps --wait

# Start Spider compression worker (optional, only if using Spider)
docker compose \
--project-name "clp-package-$(cat var/log/instance-id)" \
up spider-compression-worker \
--no-deps --wait

# Start query worker
docker compose \
Expand Down
66 changes: 0 additions & 66 deletions docs/src/user-docs/guides-using-spider.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/src/user-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,6 @@ Using Presto
Use Presto for distributed SQL queries on compressed logs.
:::

:::{grid-item-card}
:link: guides-using-spider
Using Spider
^^^
Use Spider for compression and query job task distribution.
:::
::::

---
Expand Down Expand Up @@ -263,7 +257,6 @@ guides-retention
guides-using-the-api-server
guides-mcp-server/index
guides-using-presto
guides-using-spider
:::

:::{toctree}
Expand Down
Loading