Skip to content

Commit bba245d

Browse files
committed
Add configuration docs
1 parent 11a43da commit bba245d

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

distribution/lambda/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,40 @@ make deploy-mock-data
9999
make invoke-mock-data-searcher
100100
```
101101

102+
### Configurations
103+
104+
The following environment variables can be configured on the Lambda functions.
105+
Note that only a small subset of all Quickwit configurations are exposed to
106+
simplify the setup and avoid unstable deployments.
107+
108+
| Variable | Description | Default |
109+
|---|---|---|
110+
| QW_LAMBDA_INDEX_ID | the index this Lambda interacts with (one and only one) | required |
111+
| QW_LAMBDA_METASTORE_BUCKET | bucket name for metastore files | required |
112+
| QW_LAMBDA_INDEX_BUCKET | bucket name for split files | required |
113+
| QW_LAMBDA_OPENTELEMETRY_URL | HTTP OTEL tracing collector endpoint | none, OTEL disabled |
114+
| QW_LAMBDA_OPENTELEMETRY_AUTHORIZATION | Authorization header value for HTTP OTEL calls | none, OTEL disabled |
115+
| QW_LAMBDA_ENABLE_VERBOSE_JSON_LOGS | true to enable JSON logging of spans and logs in Cloudwatch | false |
116+
| RUST_LOG | [Rust logging config][1] | info |
117+
118+
[1]: https://rust-lang-nursery.github.io/rust-cookbook/development_tools/debugging/config_log.html
119+
120+
121+
Indexer only:
122+
| Variable | Description | Default |
123+
|---|---|---|
124+
| QW_LAMBDA_INDEX_CONFIG_URI | location of the index configuration file, e.g `s3://mybucket/index-config.yaml` | required |
125+
| QW_LAMBDA_DISABLE_MERGE | true to disable compaction merges | false |
126+
| QW_LAMBDA_DISABLE_JANITOR | true to disable retention enforcement and garbage collection | false |
127+
| QW_LAMBDA_MAX_CHECKPOINTS | maximum number of ingested file names to keep in source history | 100 |
128+
129+
Searcher only:
130+
| Variable | Description | Default |
131+
|---|---|---|
132+
| QW_LAMBDA_SEARCHER_METASTORE_POLLING_INTERVAL| refresh interval of the metastore | 1m |
133+
| QW_LAMBDA_PARTIAL_REQUEST_CACHE_CAPACITY | `searcher.partial_request_cache_capacity` node config | 64M |
134+
135+
102136
### Set up a search API
103137

104138
You can configure an HTTP API endpoint around the Quickwit Searcher Lambda. The

0 commit comments

Comments
 (0)