Skip to content

Add documents and clean out of date scripts/configs#180

Merged
xiexiaoy merged 5 commits intoeloqdata:mainfrom
xiexiaoy:doc_and_clean
Sep 19, 2025
Merged

Add documents and clean out of date scripts/configs#180
xiexiaoy merged 5 commits intoeloqdata:mainfrom
xiexiaoy:doc_and_clean

Conversation

@xiexiaoy
Copy link
Copy Markdown
Collaborator

@xiexiaoy xiexiaoy commented Sep 16, 2025

Summary by CodeRabbit

  • New Features

    • Tarballs now include ready-to-use configs for EloqDoc-RocksDB and EloqDoc-RocksDBCloud, plus single-machine cluster examples.
  • Documentation

    • Introduced a package-first Quick Start.
    • Added detailed compile, configuration reference, and single-machine cluster deployment guides.
    • Removed outdated build and VPAT docs.
  • Refactor

    • Updated default and valid ranges for key runtime settings (e.g., checkpoint interval, memory limits, cache sizes).
    • Removed an obsolete configuration option.
  • Chores

    • Cleaned up legacy scripts and deprecated config templates.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Sep 17, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Updates README to a package-first Quick Start and tarball-centric setup. Adds packaged config files for RocksDB and RocksDB-Cloud (including single-node and cluster variants). Overhauls documentation with compile, configuration, and cluster deployment guides. Removes legacy configs/scripts. Adjusts Eloq options: removes bthreadWorkerNum and updates defaults/ranges.

Changes

Cohort / File(s) Summary
README refresh
README.md
Replaces setup paths with package-first Quick Start; adds explicit local/cloud flows; links to advanced docs.
Packaged configs (RocksDB / Cloud / Cluster)
concourse/artifact/ELOQDSS_ROCKSDB/mongod.conf, concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/eloqdss.conf, concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod.conf, concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod_cluster_*.conf
Introduces ready-to-use mongod and DSS configs for local RocksDB and S3-backed cloud variants, plus 3-node cluster configs.
Tarball build script tweaks
concourse/scripts/build_tarball.bash, concourse/scripts/build_tarball_open.bash
Stop creating conf dir; now copy all artifact configs per DATA_STORE_TYPE into etc.
Legacy concourse config removal
concourse/scripts/mongod.conf
Removes old static mongod.conf.
Docs added (compile/deploy/config)
docs/how-to-compile.md, docs/how-to-deploy-cluster.md, docs/configuration-description.md
Adds detailed build instructions, cluster deployment guide, and comprehensive configuration reference.
Docs removed (legacy)
docs/building.md, docs/building.opensolaris.ec2.md, docs/index.md, docs/vpat.md
Deletes outdated/irrelevant documentation pages.
Config templates removed
config/... including example.conf, standalone/*, multinode/*, dss_config.ini, standalone_dss_config.ini, store_rocksdb_cloud*.yaml
Removes legacy standalone/multinode and cloud config templates and DSS INI files.
Scripts removed (build/run/format/test)
scripts/build_mongo.sh, scripts/run_with_config.sh, scripts/format.sh, scripts/gdb_add_index.sh, scripts/test.sh, scripts/eloqdoc-config.cnf
Deletes internal tooling for building, running, formatting, indexing, and testing.
Eloq option defaults and API surface
src/mongo/db/modules/eloq/src/eloq_global_options.cpp, .../eloq_global_options.h, .../eloq_kv_engine.cpp
Removes bthreadWorkerNum option; adjusts ranges/defaults (e.g., nodeMemoryLimitMB min=512, checkpointerIntervalSec default=10); updates SST cache defaults; drops related wiring in KV engine.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User
  participant P as Package (tarball)
  participant DSS as dss_server (S3 gateway)
  participant S3 as S3/MinIO
  participant N1 as mongod Node A
  participant N2 as mongod Node B
  participant N3 as mongod Node C
  participant C as Mongo Client

  U->>P: Download & extract EloqDoc-RocksDBCloud
  U->>DSS: Start with eloqdss.conf
  DSS-->>S3: Connect using endpoint/keys
  U->>N1: Start with mongod_cluster_a.conf
  U->>N2: Start with mongod_cluster_b.conf
  U->>N3: Start with mongod_cluster_c.conf
  N1-->>DSS: Register dssPeerNode / storage settings
  N2-->>DSS: Register dssPeerNode / storage settings
  N3-->>DSS: Register dssPeerNode / storage settings
  Note over N1,N3: txService coordinates replica groups and txlog (RocksDB-Cloud)
  C->>N1: Connect (mongo shell)
  N1-->>C: Respond (ismaster/hello)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related issues

Poem

A rabbit unpacks tarballs with glee,
Hops past old scripts, config debris.
New clouds hum soft by S3’s shore,
Three nodes whisper, “Ready for more.”
With tidy docs and cleaner knobs,
Thump-thump—onward to eloquent jobs! 🐇✨

✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 099e7df and 2c58038.

📒 Files selected for processing (40)
  • README.md (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB/mongod.conf (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/eloqdss.conf (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod.conf (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod_cluster_a.conf (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod_cluster_b.conf (1 hunks)
  • concourse/artifact/ELOQDSS_ROCKSDB_CLOUD_S3/mongod_cluster_c.conf (1 hunks)
  • concourse/scripts/build_tarball.bash (2 hunks)
  • concourse/scripts/build_tarball_open.bash (2 hunks)
  • concourse/scripts/mongod.conf (0 hunks)
  • config/dss_config.ini (0 hunks)
  • config/example.conf (0 hunks)
  • config/multinode/node0.conf.template (0 hunks)
  • config/multinode/node1.conf.template (0 hunks)
  • config/multinode/node2.conf.template (0 hunks)
  • config/standalone/debug.conf.template (0 hunks)
  • config/standalone/debug_coroutine.conf.template (0 hunks)
  • config/standalone/release.conf.template (0 hunks)
  • config/standalone/release_coroutine.conf.template (0 hunks)
  • config/standalone_dss_config.ini (0 hunks)
  • config/store_rocksdb_cloud.yaml (0 hunks)
  • config/store_rocksdb_cloud_node0.yaml (0 hunks)
  • config/store_rocksdb_cloud_node1.yaml (0 hunks)
  • config/store_rocksdb_cloud_node2.yaml (0 hunks)
  • docs/building.md (0 hunks)
  • docs/building.opensolaris.ec2.md (0 hunks)
  • docs/configuration-description.md (1 hunks)
  • docs/how-to-compile.md (1 hunks)
  • docs/how-to-deploy-cluster.md (1 hunks)
  • docs/index.md (0 hunks)
  • docs/vpat.md (0 hunks)
  • scripts/build_mongo.sh (0 hunks)
  • scripts/eloqdoc-config.cnf (0 hunks)
  • scripts/format.sh (0 hunks)
  • scripts/gdb_add_index.sh (0 hunks)
  • scripts/run_with_config.sh (0 hunks)
  • scripts/test.sh (0 hunks)
  • src/mongo/db/modules/eloq/src/eloq_global_options.cpp (4 hunks)
  • src/mongo/db/modules/eloq/src/eloq_global_options.h (0 hunks)
  • src/mongo/db/modules/eloq/src/eloq_kv_engine.cpp (0 hunks)

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

@xiexiaoy xiexiaoy force-pushed the doc_and_clean branch 5 times, most recently from cda332d to c7235fe Compare September 19, 2025 06:22
@xiexiaoy xiexiaoy marked this pull request as ready for review September 19, 2025 06:33
@xiexiaoy xiexiaoy requested a review from lzxddz September 19, 2025 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants