fix(quick_start): align MinIO credential vars with documented .env - #576
fix(quick_start): align MinIO credential vars with documented .env#576Ahmath-Gadji wants to merge 1 commit into
Conversation
The quickstart guide tells users to `cp .env.example .env` (which defines `MINIO_ACCESS_KEY` / `MINIO_SECRET_KEY`) and drop that file in `quick_start/`. But `quick_start/vdb/milvus.yaml` required `MINIO_ROOT_USER` / `MINIO_ROOT_PASSWORD` with fail-fast `:?` interpolation — variables no `.env.example` anywhere defines — so the documented flow aborts during compose interpolation before the stack starts. Switch the quick_start minio + milvus services to the same `MINIO_ACCESS_KEY` / `MINIO_SECRET_KEY` variables used by the main compose stack, the named-volume profile, and the Ollama CPU asset, so a single documented `.env` works everywhere and Milvus's object-storage creds match minio's. Update the compose-storage test accordingly (it previously locked in the `MINIO_ROOT_*` names) and assert the vars exist in `.env.example`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe quick-start Milvus compose file now sources MinIO credentials from ChangesQuick-start Milvus MinIO credentials
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
What
Follow-up to a review finding on #568 (F12). The named-volume Milvus profile was reconciled to
MINIO_ACCESS_KEY/MINIO_SECRET_KEYthere, but the quick_start stack was left requiringMINIO_ROOT_USER/MINIO_ROOT_PASSWORD.Why it's broken
The quickstart guide (
docs/.../getting_started/quickstart.mdx) tells users to:cp .env.example .env— which definesMINIO_ACCESS_KEY/MINIO_SECRET_KEY(blank to fill in),.envin thequick_start/folder,But
infra/quick_start/vdb/milvus.yamlused fail-fast interpolation on${MINIO_ROOT_USER:?…}/${MINIO_ROOT_PASSWORD:?…}— variable names no.env.exampleanywhere defines. So the documented flow aborts during compose interpolation (Set MINIO_ROOT_USER in your .env) before the stack even starts.Change
infra/quick_start/vdb/milvus.yaml: minio + milvus services now readMINIO_ACCESS_KEY/MINIO_SECRET_KEY— the same variables used by the main compose stack (infra/compose/milvus/milvus.yaml), the named-volume profile, and the Ollama CPU asset. One documented.envnow works everywhere, and Milvus's object-storage creds stay in sync with minio's.tests/unit/infra/test_compose_storage.py: the test previously locked in theMINIO_ROOT_*names; it now asserts the quick_start uses the documented vars and that they exist in.env.example.Verification
uv run pytest tests/unit/infra/test_compose_storage.py→ 7 passedruff checkclean🤖 Generated with Claude Code
Summary by CodeRabbit