docs: udpate quickstart to use config files, add seq-ui quickstart#108
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #108 +/- ##
==========================================
- Coverage 71.87% 71.83% -0.05%
==========================================
Files 200 200
Lines 18076 18076
==========================================
- Hits 12993 12984 -9
- Misses 4364 4371 +7
- Partials 719 721 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Warning Rate limit exceeded@forshev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 28 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughRemoves Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/en/01-quickstart.md (2)
41-43: Update text: mapping is configured via config.yaml, not CLI flag.-The example uses the `--mode single` flag to run both seq-db in a single binary, rather than in cluster mode and `--mapping auto` to index all fields as `keyword`. +The example uses the `--mode single` flag to run seq-db in a single binary; field indexing is enabled via `mapping.path: auto` in config.yaml.
99-110: Use NDJSON Content-Type and --data-binary for Bulk API.Bulk requires newline-delimited JSON and preserving newlines.
-curl --request POST \ +curl --request POST \ --url http://localhost:9002/_bulk \ - --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --header 'Content-Type: application/x-ndjson' \ + --data-binary $'{"index" : {"unused-key":""}} {"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} {"index" : {"unused-key":""}} {"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} {"index" : {"unused-key":""}} -{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} -' +{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"}\n'docs/ru/01-quickstart.md (2)
1-224: RU quickstart is in English.This file is under docs/ru but contains English text. Either translate to Russian or point RU index to the EN page to avoid confusing readers.
I can provide a concise Russian translation of the updated sections if you want it in this PR.
99-110: Bulk API: NDJSON + --data-binary (same as EN).- --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --header 'Content-Type: application/x-ndjson' \ + --data-binary $'{"index" : {"unused-key":""}} @@ -{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} -' +{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"}\n'
🧹 Nitpick comments (7)
docker-compose.yaml (2)
17-26: Order startup to avoid offloading races.Since offloading is enabled, ensure the store starts after MinIO.
seq-db-store: @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml + depends_on: + - minio
16-16: Trim trailing whitespace.YAMLlint flagged trailing spaces on this blank line.
- +docs/en/01-quickstart.md (4)
30-39: Correct registry reference and keep config-driven phrasing.You're pulling from GHCR, not Docker Hub. Keep wording aligned with the config-based run.
-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the seq-db image from GitHub Container Registry and create a container:
18-21: Minor grammar.-Before launch you need to create config file: +Before launching, create a config file:-config.yaml: +config.yaml:
136-141: Polish seq-ui intro sentence.-seq-ui is a backend for user interface. +seq-ui is the backend for the user interface.-To launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, config.seq-ui.yaml: +To launch seq-db with seq-ui, add a minimal configuration file for seq-ui, config.seq-ui.yaml:
169-170: Polish reminder sentence.-Don't forget to include seq-db configuration file, config.yaml: +Don't forget to include the seq-db configuration file, config.yaml:docs/ru/01-quickstart.md (1)
30-39: Registry reference.-Pull seq-db image from Docker hub and create a container: +Pull the seq-db image from GitHub Container Registry and create a container:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
config.example.yaml(3 hunks)docker-compose.yaml(1 hunks)docs/en/01-quickstart.md(4 hunks)docs/ru/01-quickstart.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: ingestor or store. ...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
🪛 YAMLlint (1.37.1)
docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (1)
config.example.yaml (1)
35-36: Mapping file presence confirmed tests/data/mappings/logging-new.yaml exists; no action needed.
forshev
force-pushed
the
0-seq-ui-quickstart
branch
from
30bcc45 to
67d935a
Compare
There was a problem hiding this comment.
Actionable comments posted: 12
♻️ Duplicate comments (3)
docker-compose.yaml (2)
13-13: Use absolute config path in command.You mount the file at /seq-db/config.yaml but pass --config=config.yaml; this can fail depending on WORKDIR. Use the absolute path.
- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml
25-25: Same absolute path fix for store.- command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamldocs/ru/01-quickstart.md (1)
90-91: Уберите упоминание CLI-флага --mapping.Теперь настройка через файл; используйте mapping.path в config.yaml.
- Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. + Для простоты в config.yaml задано `mapping.path: auto`, но это не для продакшена.
🧹 Nitpick comments (3)
docker-compose.yaml (2)
27-33: MinIO is missing credentials and persistent data.For a usable quickstart, add default creds and a volume.
minio: image: quay.io/minio/minio + environment: + - MINIO_ROOT_USER=minioadmin + - MINIO_ROOT_PASSWORD=minioadmin + volumes: + - minio-data:/data ports: - "9000:9000" - "9001:9001" command: server /data --console-address ":9001" + +volumes: + minio-data:
16-16: Trailing whitespace trips linters.Remove trailing spaces on this blank line.
docs/en/01-quickstart.md (1)
90-91: Remove leftover CLI flag reference for mapping.The guide now uses config files; replace “--mapping auto” with mapping.path in config.
-Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. +For simplicity we set `mapping.path: auto` in config.yaml, but this is not production friendly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
config.example.yaml(3 hunks)docker-compose.yaml(1 hunks)docs/en/01-quickstart.md(3 hunks)docs/ru/01-quickstart.md(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- config.example.yaml
🧰 Additional context used
🪛 LanguageTool
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
🪛 YAMLlint (1.37.1)
docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
forshev
force-pushed
the
0-seq-ui-quickstart
branch
2 times, most recently
from
e323576 to
0df4d57
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docker-compose.yaml (1)
27-33: MinIO likely won’t start without root creds.Recent MinIO requires MINIO_ROOT_USER and MINIO_ROOT_PASSWORD. Add them for the quickstart.
minio: image: quay.io/minio/minio + environment: + MINIO_ROOT_USER: minioadmin + MINIO_ROOT_PASSWORD: minioadmin ports: - "9000:9000" - "9001:9001" command: server /data --console-address ":9001"
♻️ Duplicate comments (7)
docs/en/01-quickstart.md (3)
71-86: Use absolute config path in compose commands.Matches the /seq-db/config.yaml mount.
- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
186-195: Point seq-ui to the mounted config path.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml
196-213: Absolute config path for seq-db containers in seq-ui compose.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamldocs/ru/01-quickstart.md (4)
186-195: Использовать смонтированный путь конфига для seq-ui.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml
30-39: Уточнить реестр и путь к конфигу.
- Образы берём из ghcr.io.
- Используйте смонтированный путь /seq-db/config.yaml в --config.
- -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=/seq-db/config.yaml
196-213: Абсолютный путь к конфигу для seq-db в compose с seq-ui.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
69-86: Абсолютный путь к конфигу в docker-compose.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
🧹 Nitpick comments (6)
docker-compose.yaml (1)
16-16: Trailing whitespace.Remove trailing spaces to satisfy linters.
- +config.quickstart.yaml (1)
14-16: Clarify hot_stores entries.Quote host:port to make intent explicit and avoid YAML mapping ambiguity.
- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"docs/en/01-quickstart.md (2)
55-62: Make hot_stores host:port unambiguous.Quote entries to avoid YAML mapping parsing edge cases.
- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"
170-179: Same hot_stores quoting fix in the seq-ui section’s config snippet.- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"docs/ru/01-quickstart.md (2)
56-62: Однозначно указать host:port в hot_stores.- - seq-db-store:9004 + - "seq-db-store:9004"
172-179: Повторить кавычки для hot_stores в секции seq-ui.- - seq-db-store:9004 + - "seq-db-store:9004"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (5)
.github/workflows/cd.yml(1 hunks)config.quickstart.yaml(1 hunks)docker-compose.yaml(1 hunks)docs/en/01-quickstart.md(4 hunks)docs/ru/01-quickstart.md(4 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
🪛 LanguageTool
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (1)
.github/workflows/cd.yml (1)
44-46: Dual-tag push looks good.Adding both versioned and latest tags per release is correct here.
forshev
force-pushed
the
0-seq-ui-quickstart
branch
from
0df4d57 to
bdec864
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (8)
config.quickstart.yaml (1)
20-23: MinIO endpoint correctly points to the service DNS.Good fix; containers will resolve
minioon the compose network.docs/en/01-quickstart.md (3)
69-86: Compose commands should reference the mounted config path.Both services mount to
/seq-db/config.yamlbut use a relative--config.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
186-205: Fix config paths in the seq-ui compose example.Point seq-ui to its mounted path and seq-db services to
/seq-db/config.yaml.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamlAlso applies to: 208-213
30-39: Use GHCR wording and the mounted absolute config path.The image is hosted on GHCR, and the config is mounted at
/seq-db/config.yaml.-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the image from GitHub Container Registry and create a container: @@ - -it ghcr.io/ozontech/seq-db:latest --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:latest --mode single --config=/seq-db/config.yamldocs/ru/01-quickstart.md (3)
30-39: GHCR wording and absolute config path.Update wording and point
--configto the mounted path.-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the image from GitHub Container Registry and create a container: @@ - -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=/seq-db/config.yaml
64-86: Compose commands should use the mounted absolute path.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
186-195: Fix config paths in the seq-ui compose example.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamlAlso applies to: 196-213
docker-compose.yaml (1)
13-15: Point --config to the mounted absolute path.Both services mount
/seq-db/config.yamlbut the command uses a relative path.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamlAlso applies to: 25-25
🧹 Nitpick comments (5)
config.quickstart.yaml (2)
30-31: Prefer auto-mapping for the quickstart (avoid path coupling).Unless
logging-new.yamlis guaranteed to be mounted at/seq-db/mappings/, use auto to reduce setup friction.mapping: - path: /seq-db/mappings/logging-new.yaml + path: auto
9-12: Storage data dir default.Compose mounts
/seq-db/data/for the store, butstorage.data_dirisn’t set. If the default isn’t/seq-db/data/, add it explicitly to avoid silent misplacement.docs/en/01-quickstart.md (1)
66-86: Optional: pin image tags for reproducibility.Quickstarts are more stable when versions are pinned (e.g.,
ghcr.io/ozontech/seq-db:v0.61.0) rather thanlatest.docker-compose.yaml (2)
27-33: Optional: make MinIO creds explicit to match config.Helps first-run success and aligns with
access_key/secret_keyin config.minio: image: quay.io/minio/minio + environment: + - MINIO_ROOT_USER=minioadmin + - MINIO_ROOT_PASSWORD=minioadmin ports: - "9000:9000" - "9001:9001" command: server /data --console-address ":9001"
14-16: Trim trailing whitespace.YAML lint flagged trailing spaces at Line 16.
- depends_on: - - seq-db-store - + depends_on: + - seq-db-store +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (5)
.github/workflows/cd.yml(1 hunks)config.quickstart.yaml(1 hunks)docker-compose.yaml(1 hunks)docs/en/01-quickstart.md(4 hunks)docs/ru/01-quickstart.md(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/workflows/cd.yml
🧰 Additional context used
🪛 LanguageTool
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
🪛 YAMLlint (1.37.1)
docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (1)
config.quickstart.yaml (1)
13-16: Confirm expected schema for hot_stores.
- seq-db-store:9004is a single scalar string (host:port). If the config expects a list of strings, this is fine; if it expects a list of maps, switch to- host: seq-db-store/port: 9004.
forshev
force-pushed
the
0-seq-ui-quickstart
branch
from
bdec864 to
52c9241
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/en/01-quickstart.md (1)
90-91: Replace CLI flag mention with config-based mapping.Docs say “we set
--mappingtoauto” but mapping is configured via config now.-Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. +Be aware that we set `mapping.path: auto` for easier quickstart, but this option is not production-friendly.
♻️ Duplicate comments (13)
docs/en/01-quickstart.md (6)
49-49: Minor grammar: add article.-Use `--mode` flag to select specific mode: `proxy` or `store`. +Use the `--mode` flag to select a mode: `proxy` or `store`.
30-39: Align wording and point --config to the mounted path.
- It’s pulled from GitHub Container Registry, not Docker Hub.
- Command should reference
/seq-db/config.yaml.-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the image from GitHub Container Registry and create a container: @@ - -it ghcr.io/ozontech/seq-db:latest --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:latest --mode single --config=/seq-db/config.yaml
71-86: Use absolute config path in compose commands.- volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + volumes: + - ${PWD}/config.yaml:/seq-db/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml - command: --mode store --config=config.yaml + volumes: + - ${PWD}/config.yaml:/seq-db/config.yaml + command: --mode store --config=/seq-db/config.yaml
170-179: Same YAML quoting for cluster.hot_stores.- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"
186-195: Point seq-ui to the mounted config path.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml
196-213: Absolute config path for seq-db in seq-ui compose.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamldocs/ru/01-quickstart.md (7)
30-39: Абсолютный путь к конфигу и корректное упоминание реестра.-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the image from GitHub Container Registry and create a container: @@ - -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=/seq-db/config.yaml
56-62: Кавычки вокруг host:port в YAML.- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"
69-86: Абсолютный путь для --config в docker-compose.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
170-179: Повторно: кавычки для cluster.hot_stores.- hot_stores: - - seq-db-store:9004 + hot_stores: + - "seq-db-store:9004"
186-195: Неверный путь конфига для seq-ui.- command: --config config.yaml + command: --config /seq-ui-server/config.yaml
196-213: Абсолютные пути для seq-db в compose с seq-ui.- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
90-91: Замените упоминание--mappingнаmapping.path: auto.- Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. + Be aware that we set `mapping.path: auto` for easier quickstart, but this option is not production‑friendly.
🧹 Nitpick comments (4)
.github/workflows/cd.yml (1)
44-46: Pushing latest tag on release looks good; consider guardrails.Optional: restrict pushing the
latesttag to stable releases only (e.g., skip for pre-releases) if you ever enable them in this workflow.quickstart/config.quickstart.yaml (1)
4-7: Quote address literals for clarity.Values like
:9002parse fine but are clearer and safer when quoted.address: - http: :9002 - grpc: :9004 - debug: :9200 + http: ":9002" + grpc: ":9004" + debug: ":9200"quickstart/docker-compose.yaml (2)
16-16: Remove trailing whitespace (YAMLlint).There’s trailing spaces on this blank line.
- +
3-6: Consider using published images for faster quickstart.Building from source increases time/requirements. Using ghcr images improves UX for newcomers.
- seq-db-proxy: - build: - context: ../ - dockerfile: build/package/Dockerfile + seq-db-proxy: + image: ghcr.io/ozontech/seq-db:latest @@ - seq-db-store: - build: - context: ../ - dockerfile: build/package/Dockerfile + seq-db-store: + image: ghcr.io/ozontech/seq-db:latestAlso applies to: 18-21
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (6)
.github/workflows/cd.yml(1 hunks)docker-compose.yaml(0 hunks)docs/en/01-quickstart.md(4 hunks)docs/ru/01-quickstart.md(4 hunks)quickstart/config.quickstart.yaml(1 hunks)quickstart/docker-compose.yaml(1 hunks)
💤 Files with no reviewable changes (1)
- docker-compose.yaml
🧰 Additional context used
🪛 YAMLlint (1.37.1)
quickstart/docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
🪛 LanguageTool
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (1)
quickstart/config.quickstart.yaml (1)
17-23: Keep demo creds obviously non-prod (already warned).No change required; reiterating that
minioadmin/minioadminmust not leak beyond quickstart.
forshev
force-pushed
the
0-seq-ui-quickstart
branch
from
52c9241 to
cc50c6d
Compare
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/en/01-quickstart.md (1)
90-91: Fix mapping reference: it’s config-driven, not a CLI flag.-Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. -So we encourage you to read more about [mappings and how we index fields](03-index-types.md) and seq-db architecture and operating modes (single/cluster). +Be aware that we set `mapping.path` to `auto` for easier quickstart, which is not production friendly. +We encourage you to read more about [mappings and how we index fields](03-index-types.md) and seq-db architecture and operating modes (single/cluster).
♻️ Duplicate comments (6)
quickstart/docker-compose.yaml (1)
13-15: Use absolute config path in container commands.The config is mounted to /seq-db/config.yaml; commands use a relative path that may not resolve depending on WORKDIR.
Apply:
- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamlAlso applies to: 25-25
docs/en/01-quickstart.md (2)
58-58: YAML host:port should be a string.Without quotes, YAML parses this as a mapping, not a scalar address.
- - seq-db-store:9004 + - "seq-db-store:9004"
38-38: Container should read the mounted config path.You mount to /seq-db/config.yaml but pass --config=config.yaml.
- -it ghcr.io/ozontech/seq-db:latest --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:latest --mode single --config=/seq-db/config.yamldocs/ru/01-quickstart.md (3)
38-38: Абсолютный путь к конфигу в docker run.- -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:v0.61.0 --mode single --config=/seq-db/config.yaml
58-58: YAML host:port следует заключить в кавычки.- - seq-db-store:9004 + - "seq-db-store:9004"
90-91: Исправьте упоминание mapping: это настройка в config, а не CLI-флаг.- Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly. - So we encourage you to read more about [mappings and how we index fields](03-index-types.md) and seq-db architecture and operating modes (single/cluster). + We set `mapping.path` to `auto` for an easier quickstart, which is not production-ready. + Read more about [mappings and indexing](03-index-types.md) and seq-db architecture and modes (single/cluster).
🧹 Nitpick comments (2)
quickstart/docker-compose.yaml (1)
16-16: Strip trailing spaces.YAMLlint flags trailing whitespace on Line 16.
- +docs/en/01-quickstart.md (1)
30-30: Minor wording: registry name.-seq-db can be quickly launched in a docker container. Pull seq-db image from Docker hub and create a container: +seq-db can be quickly launched in a docker container. Pull the image from GitHub Container Registry and create a container:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (6)
.github/workflows/cd.yml(1 hunks)docker-compose.yaml(0 hunks)docs/en/01-quickstart.md(4 hunks)docs/ru/01-quickstart.md(4 hunks)quickstart/config.quickstart.yaml(1 hunks)quickstart/docker-compose.yaml(1 hunks)
💤 Files with no reviewable changes (1)
- docker-compose.yaml
🚧 Files skipped from review as they are similar to previous changes (2)
- .github/workflows/cd.yml
- quickstart/config.quickstart.yaml
🧰 Additional context used
🪛 LanguageTool
docs/ru/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
docs/en/01-quickstart.md
[grammar] ~18-~18: There might be a mistake here.
Context: ...le node mode Before launch you need to create config file: config.yaml: ```yaml sto...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...quickly launched in a docker container. Pull seq-db image from Docker hub and create...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...-db doesn't index any fields by default. The example uses the --mode single fla...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ... stores the data. Use --mode flag to select specific mode: proxy or store. Bef...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...o launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, ...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ons_per_request: 3 ``` Don't forget to include seq-db configuration file, config.yaml:...
(QB_NEW_EN)
🪛 YAMLlint (1.37.1)
quickstart/docker-compose.yaml
[error] 16-16: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
forshev
force-pushed
the
0-seq-ui-quickstart
branch
from
cc50c6d to
93c47b4
Compare
4 participants
Description
Updated quickstart to use config files
Added seq-ui launch example to quickstart
Updated docker-compose.yaml to use config files
Summary by CodeRabbit
New Features
Documentation
Chores