Skip to content

build: use ghcr images in quickstart docker compose files#127

Merged
forshev merged 1 commit into
mainfrom
0-qickstart-ghcr-images
Sep 10, 2025
Merged

build: use ghcr images in quickstart docker compose files#127
forshev merged 1 commit into
mainfrom
0-qickstart-ghcr-images

Conversation

@forshev
Copy link
Copy Markdown
Collaborator

@forshev forshev commented Sep 10, 2025

Description

use ghcr images in quickstart docker compose files


  • I have read and followed all requirements in CONTRIBUTING.md;
  • I used LLM/AI assistance to make this pull request;

If you have used LLM/AI assistance please provide model name and full prompt:

Model: {{model-name}}
Prompt: {{prompt}}

Summary by CodeRabbit

  • New Features

    • Added default quickstart/mappings.yaml with predefined field mappings to simplify setup and customization.
  • Chores

    • Quickstart now uses published images (ghcr.io/ozontech/seq-db:latest) instead of local builds.
    • Updated docker-compose volumes to use local ./data and a single ./mappings.yaml file.
    • Config updated to reference the new mappings.yaml path.
    • .gitignore now excludes /quickstart/data to prevent accidental commits of local data.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.50%. Comparing base (00feef8) to head (758c4ab).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #127      +/-   ##
==========================================
+ Coverage   71.49%   71.50%   +0.01%     
==========================================
  Files         201      201              
  Lines       18167    18167              
==========================================
+ Hits        12988    12991       +3     
+ Misses       4458     4456       -2     
+ Partials      721      720       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Sep 10, 2025

📝 Walkthrough

Walkthrough

Switches quickstart compose services from local builds to ghcr.io/ozontech/seq-db:latest, updates volume mounts to a single mappings.yaml file, points config to /seq-db/mappings.yaml, adds quickstart/mappings.yaml, and ignores quickstart/data in .gitignore.

Changes

Cohort / File(s) Summary of Changes
Git metadata
`.gitignore`
Added ignore entry for `/quickstart/data`.
Quickstart runtime config
`quickstart/config.quickstart.yaml`, `quickstart/mappings.yaml`
Updated `mapping.path` to `/seq-db/mappings.yaml`. Added new mappings definition file with field mappings (keywords, text, path, object with nested fields).
Docker Compose (quickstart)
`quickstart/docker-compose.yaml`, `quickstart/docker-compose.seq-ui.yaml`
Replaced build blocks with `image: ghcr.io/ozontech/seq-db:latest` for `seq-db-proxy` and `seq-db-store`. Changed volumes to mount `./mappings.yaml:/seq-db/mappings.yaml`; updated data path to `./data/:/seq-db/data/`. Minor whitespace only for other services.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • ssnd
  • moflotas
  • dkharms

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly captures the main change of switching the quickstart Docker Compose services to GHCR images without extraneous detail, making it clear and actionable.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 0-qickstart-ghcr-images

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
quickstart/config.quickstart.yaml (1)

31-33: Mapping file path switch looks consistent with the new volume mount.

One ask: the container commands use a relative --config=config.yaml, and storage.data_dir is ./data. This assumes the container working directory is /seq-db. If that’s not guaranteed, prefer absolute paths to avoid surprises.

Apply outside this hunk (example):

# quickstart/config.quickstart.yaml
-  data_dir: ./data
+  data_dir: /seq-db/data
# quickstart/docker-compose.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.yaml
# quickstart/docker-compose.seq-ui.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.yaml
quickstart/docker-compose.yaml (1)

3-7: Avoid mutable “latest” for reproducible quickstarts.

Pin ghcr.io/ozontech/seq-db to a version tag or digest (and reuse via an env/anchor) to keep tutorials stable.

Example:

-    image: ghcr.io/ozontech/seq-db:latest
+    image: ghcr.io/ozontech/seq-db:${SEQ_DB_TAG:-vX.Y.Z}

Add .env with SEQ_DB_TAG=vX.Y.Z and document updating it.

quickstart/docker-compose.seq-ui.yaml (1)

13-17: Same note: pin the seq-db image instead of “latest”.

Mirror the tag/digest approach here for consistency with the other compose.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00feef8 and 758c4ab.

📒 Files selected for processing (5)
  • .gitignore (1 hunks)
  • quickstart/config.quickstart.yaml (1 hunks)
  • quickstart/docker-compose.seq-ui.yaml (1 hunks)
  • quickstart/docker-compose.yaml (1 hunks)
  • quickstart/mappings.yaml (1 hunks)
⏰ 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 (5)
.gitignore (1)

26-27: LGTM: ignore quickstart runtime data.

Prevents accidental check-ins of local volumes. No further action.

quickstart/mappings.yaml (1)

12-17: Replace title with name under types
types entries expect a name key (e.g. - name: "keyword"), not title. Confirm against the seq-db mapping schema and update accordingly.

quickstart/docker-compose.yaml (2)

6-6: Nice: single-file mapping mount aligns with config path.

Keeps the quickstart minimal.


19-20: Good: dedicated data volume path under quickstart.

Matches .gitignore and keeps state local to the example.

quickstart/docker-compose.seq-ui.yaml (1)

29-30: Volumes look correct and consistent with the non-UI compose.

No issues spotted.

@forshev forshev merged commit e42af57 into main Sep 10, 2025
9 of 11 checks passed
@forshev forshev deleted the 0-qickstart-ghcr-images branch September 10, 2025 11:39
@coderabbitai coderabbitai Bot mentioned this pull request Sep 14, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants