Skip to content

Commit dda97e2

Browse files
committed
refactor(helm/docs): Rename package.query_engine to webui.query_engine and update Presto configurations
1 parent e0d175a commit dda97e2

File tree

5 files changed

+24
-23
lines changed

5 files changed

+24
-23
lines changed

docs/src/user-docs/guides-k8s-deployment.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ clpConfig:
200200
# Use clp-text, instead of clp-json (default)
201201
package:
202202
storage_engine: "clp" # Use "clp-s" for clp-json, "clp" for clp-text
203+
204+
webui:
203205
query_engine: "clp" # Use "clp-s" for clp-json, "clp" for clp-text, "presto" for Presto
204206
205207
# Configure archive output
@@ -248,30 +250,29 @@ helm template clp . -f custom-values.yaml
248250

249251
### Using Presto as the query engine
250252

251-
To use [Presto][presto-guide] as the query engine, set `query_engine` to `"presto"` and configure
252-
the Presto-specific settings. The `query_engine` setting controls which search interface the Web UI
253-
displays. Presto runs alongside the existing compression pipeline; setting the clp-s native query
254-
components to `null` is optional but recommended to save resources when you don't need both query
255-
paths:
253+
To use [Presto][presto-guide] as the query engine, set `webui.query_engine` to `"presto"` and
254+
configure the Presto-specific settings. The `query_engine` setting controls which search interface
255+
the Web UI displays. Presto runs alongside the existing compression pipeline; setting the clp-s
256+
native query components to `null` is optional but recommended to save resources when you don't need
257+
both query paths:
256258

257259
```{code-block} yaml
258260
:caption: presto-values.yaml
259261
260262
image:
261263
prestoCoordinator:
262264
repository: "ghcr.io/y-scope/presto/coordinator"
263-
tag: "dev"
265+
tag: "clp-v0.10.0"
264266
prestoWorker:
265267
repository: "ghcr.io/y-scope/presto/prestissimo-worker"
266-
tag: "dev"
268+
tag: "clp-v0.10.0"
267269
268270
prestoWorker:
269271
# See below "Worker scheduling" for more details on configuring Presto scheduling
270272
replicas: 2
271273
272274
clpConfig:
273-
package:
274-
storage_engine: "clp-s"
275+
webui:
275276
query_engine: "presto"
276277
277278
# Optional: Disable the clp-s native query pipeline to save resources.

docs/src/user-docs/guides-using-presto.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ CLP supports Presto through two deployment methods:
2626
## Kubernetes (Helm)
2727

2828
When deploying CLP on Kubernetes using Helm, Presto can be enabled by setting `clpConfig.presto` to
29-
a non-null configuration and `query_engine` to `"presto"`. The `query_engine` setting controls which
30-
search interface the Web UI displays. Presto runs alongside the existing compression pipeline; the
31-
clp-s native query components can optionally be disabled to save resources.
29+
a non-null configuration and `webui.query_engine` to `"presto"`. The `query_engine` setting controls
30+
which search interface the Web UI displays. Presto runs alongside the existing compression pipeline;
31+
the clp-s native query components can optionally be disabled to save resources.
3232

3333
### Requirements
3434

@@ -42,7 +42,7 @@ clp-s native query components can optionally be disabled to save resources.
4242
:caption: presto-values.yaml
4343
4444
clpConfig:
45-
package:
45+
webui:
4646
query_engine: "presto"
4747
4848
# Optional: Disable the clp-s native query pipeline to save resources.

docs/src/user-docs/quick-start/clp-text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ helm repo update clp
100100

101101
helm install clp clp/clp DOCS_VAR_HELM_VERSION_FLAG \
102102
--set clpConfig.package.storage_engine=clp \
103-
--set clpConfig.package.query_engine=clp \
103+
--set clpConfig.webui.query_engine=clp \
104104
--set clpConfig.webui.port="$CLP_WEBUI_PORT" \
105105
--set clpConfig.results_cache.port="$CLP_RESULTS_CACHE_PORT" \
106106
--set clpConfig.database.port="$CLP_DATABASE_PORT" \

tools/deployment/package-helm/templates/configmap.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ data:
127127
log_ingestor: null
128128
{{- end }}
129129
package:
130-
query_engine: {{ .Values.clpConfig.package.query_engine | quote }}
130+
query_engine: {{ .Values.clpConfig.webui.query_engine | quote }}
131131
storage_engine: {{ .Values.clpConfig.package.storage_engine | quote }}
132132
{{- with .Values.clpConfig.query_scheduler }}
133133
query_scheduler:
@@ -254,7 +254,7 @@ data:
254254
webui-client-settings.json: |
255255
{
256256
"ClpStorageEngine": {{ .Values.clpConfig.package.storage_engine | quote }},
257-
"ClpQueryEngine": {{ .Values.clpConfig.package.query_engine | quote }},
257+
"ClpQueryEngine": {{ .Values.clpConfig.webui.query_engine | quote }},
258258
"LogsInputType": {{ .Values.clpConfig.logs_input.type | quote }},
259259
{{- if eq .Values.clpConfig.logs_input.type "fs" }}
260260
"LogsInputRootDir": "/mnt/logs",
@@ -323,7 +323,7 @@ data:
323323
{{ .Values.clpConfig.archive_output.target_encoded_file_size | int }},
324324
"ArchiveOutputTargetSegmentSize":
325325
{{ .Values.clpConfig.archive_output.target_segment_size | int }},
326-
"ClpQueryEngine": {{ .Values.clpConfig.package.query_engine | quote }},
326+
"ClpQueryEngine": {{ .Values.clpConfig.webui.query_engine | quote }},
327327
"ClpStorageEngine": {{ .Values.clpConfig.package.storage_engine | quote }},
328328
{{- if .Values.clpConfig.presto }}
329329
"PrestoHost": "{{ include "clp.fullname" . }}-presto-coordinator",

tools/deployment/package-helm/values.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ image:
1111
tag: "main"
1212
prestoCoordinator:
1313
repository: "ghcr.io/y-scope/presto/coordinator"
14-
pullPolicy: "Always"
15-
tag: "dev"
14+
pullPolicy: "IfNotPresent"
15+
tag: "clp-v0.10.0"
1616
prestoWorker:
1717
repository: "ghcr.io/y-scope/presto/prestissimo-worker"
18-
pullPolicy: "Always"
19-
tag: "dev"
18+
pullPolicy: "IfNotPresent"
19+
tag: "clp-v0.10.0"
2020

2121
# - If false: Single-node deployment.
2222
# - Pods automatically tolerate control-plane taints.
@@ -106,7 +106,6 @@ clpConfig:
106106

107107
package:
108108
storage_engine: "clp-s"
109-
query_engine: "clp-s"
110109

111110
# API server config
112111
api_server:
@@ -185,6 +184,7 @@ clpConfig:
185184
upsert_interval: 100 # milliseconds
186185

187186
webui:
187+
query_engine: "clp-s"
188188
port: 30000
189189
results_metadata_collection_name: "results-metadata"
190190
rate_limit: 1000
@@ -194,7 +194,7 @@ clpConfig:
194194
# logging_level: "INFO"
195195

196196
# Presto query engine config. Uncomment to enable Presto deployments. If you want the Web UI to
197-
# expose Presto SQL, also set `package.query_engine: "presto"`.
197+
# expose Presto SQL, also set `webui.query_engine: "presto"`.
198198
presto: null
199199
# port: 30889
200200
# coordinator:

0 commit comments

Comments
 (0)