Skip to content

fix(quick_start): align MinIO credential vars with documented .env - #576

Closed
Ahmath-Gadji wants to merge 1 commit into
forward-port/main-to-hexagonalfrom
fix/quickstart-minio-credentials
Closed

fix(quick_start): align MinIO credential vars with documented .env#576
Ahmath-Gadji wants to merge 1 commit into
forward-port/main-to-hexagonalfrom
fix/quickstart-minio-credentials

Conversation

@Ahmath-Gadji

@Ahmath-Gadji Ahmath-Gadji commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

What

Follow-up to a review finding on #568 (F12). The named-volume Milvus profile was reconciled to MINIO_ACCESS_KEY / MINIO_SECRET_KEY there, but the quick_start stack was left requiring MINIO_ROOT_USER / MINIO_ROOT_PASSWORD.

Why it's broken

The quickstart guide (docs/.../getting_started/quickstart.mdx) tells users to:

  1. cp .env.example .env — which defines MINIO_ACCESS_KEY / MINIO_SECRET_KEY (blank to fill in),
  2. drop that .env in the quick_start/ folder,
  3. bring the stack up.

But infra/quick_start/vdb/milvus.yaml used fail-fast interpolation on ${MINIO_ROOT_USER:?…} / ${MINIO_ROOT_PASSWORD:?…} — variable names no .env.example anywhere 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 read MINIO_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 .env now 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 the MINIO_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 passed
  • ruff check clean

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Bug Fixes
    • Updated quick-start storage setup to use the current MinIO credential variable names, improving compatibility with the latest environment configuration.
    • Ensured the Milvus service picks up the matching MinIO access credentials correctly.
  • Tests
    • Updated coverage to verify the new credential mapping and confirm the older credential names are no longer used.

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>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b9b929cd-736d-47a5-9867-10aa55fa394b

📥 Commits

Reviewing files that changed from the base of the PR and between e717a12 and 979d6ea.

📒 Files selected for processing (2)
  • infra/quick_start/vdb/milvus.yaml
  • tests/unit/infra/test_compose_storage.py

📝 Walkthrough

Walkthrough

The quick-start Milvus compose file now sources MinIO credentials from MINIO_ACCESS_KEY and MINIO_SECRET_KEY for both MinIO and Milvus. The unit test now checks the new env names, verifies the old root credential names are absent, and confirms the Milvus interpolation values.

Changes

Quick-start Milvus MinIO credentials

Layer / File(s) Summary
Compose credential env names
infra/quick_start/vdb/milvus.yaml
The minio and milvus service environment entries reference MINIO_ACCESS_KEY and MINIO_SECRET_KEY with required .env checks.
Credential wiring test
tests/unit/infra/test_compose_storage.py
The storage unit test loads the quick-start compose and .env.example, checks the new env names, and asserts Milvus interpolates from MinIO access credentials.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hopped through YAML, nibbling keys so neat,
MINIO_ACCESS_KEY found its burrow seat.
Milvus and MinIO twinkled in sync tonight,
Old root names hopped off into the night.
🐇✨ The tests went green with a joyful beat.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: aligning quick_start MinIO credential variables with the documented .env file.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/quickstart-minio-credentials

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.

@Ahmath-Gadji
Ahmath-Gadji deleted the fix/quickstart-minio-credentials branch July 17, 2026 08:08
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.

2 participants