Docker compose CAS db callout #422
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Eric Hofesmann <[email protected]>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughUpdated docker/README.md prerequisites: replaced “FiftyOne Teams” with “FiftyOne Enterprise,” clarified MongoDB edition compatibility, and added a note that Enterprise requires two databases (fiftyone and fiftyone-cas) created on startup with references to env.template. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ 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: 1
🧹 Nitpick comments (1)
docker/README.md (1)
87-88: MongoDB compatibility wording nitConsider lowercasing “Editions” for consistency with the rest of the document and typical style (“editions”).
- - FiftyOne Enterprise is compatible with MongoDB Community, Enterprise, or Atlas - Editions. + - FiftyOne Enterprise is compatible with MongoDB Community, Enterprise, or Atlas + editions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docker/README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docker/README.md
96-96: Line length
Expected: 80; Actual: 461
(MD013, line-length)
⏰ 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). (2)
- GitHub Check: pre-commit
- GitHub Check: docker-pulls
docker/README.md
Outdated
| can then use utilization metrics to make scaling decisions (up or down). | ||
| Please note that we do not support MongoDB Atlas Serverless instances | ||
| because we require Aggregations. | ||
| - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L52) and [`fiftyone-cas`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L64)) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Clarify when databases are auto-created; reflow to satisfy markdownlint (MD013)
- The databases are only auto-created during initial deployment when database admin mode is enabled. Make this explicit to avoid confusion.
- Line exceeds markdownlint’s MD013 (line-length). Reflow into a wrapped/nested list for readability and to pass lint.
- Prefer referencing the controlling env vars (FIFTYONE_DATABASE_NAME, CAS_DATABASE_NAME, CAS_MONGODB_URI) and a relative link to env.template to reduce link rot.
- Optional: note required MongoDB privileges to create databases/collections.
Apply this diff to clarify and reflow:
- - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L52) and [`fiftyone-cas`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L64))
+ - A FiftyOne Enterprise deployment requires two MongoDB databases. They are
+ created on initial startup when `FIFTYONE_DATABASE_ADMIN=true`:
+ - App database (default: `fiftyone`) — configurable via `FIFTYONE_DATABASE_NAME`
+ - CAS database (default: `fiftyone-cas`) — configurable via `CAS_DATABASE_NAME`
+ - Optionally, CAS can use a different MongoDB URI via `CAS_MONGODB_URI`
+ - See defaults in [`internal-auth/env.template`](./internal-auth/env.template)
+ - Ensure your MongoDB user has privileges to create databases and collectionsIf you prefer to keep the single-line style, suppress only this lint with:
+<!-- markdownlint-disable-next-line MD013 -->
- - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L52) and [`fiftyone-cas`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L64))
+ - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](./internal-auth/env.template) and [`fiftyone-cas`](./internal-auth/env.template))- Confirm that the Helm documentation mirrors this clarification about the two databases and the dependency on
FIFTYONE_DATABASE_ADMIN=truefor auto-creation.
🏁 Script executed:
#!/bin/bash
# Search for mentions of the relevant environment variables in the Helm docs
rg -n 'FIFTYONE_DATABASE_ADMIN' -C3
rg -n 'FIFTYONE_DATABASE_NAME' -C3
rg -n 'CAS_DATABASE_NAME' -C3
# Locate Helm README files to inspect their contents
fd -t f -I README.md | grep -i helm || trueLength of output: 91304
Clarify database creation conditions and update all docs
- The two MongoDB databases (
fiftyone&fiftyone-cas) are only auto-created on initial startup whenFIFTYONE_DATABASE_ADMIN=true. - Reflow the bullet in
docker/README.mdto wrap at ~80 chars, reference the env vars by name, and link relatively tointernal-auth/env.template. - Helm chart documentation does not currently mention auto-creation of these two databases. Please add a similar note:
•helm/fiftyone-teams-app/README.md.gotmplunder Version 2.9+ Installation Changes
•helm/docs/upgrading.md(or a new Databases section) - Use the controlling env vars:
FIFTYONE_DATABASE_NAME,CAS_DATABASE_NAME,CAS_MONGODB_URI, and note required MongoDB privileges.
Suggested diff for docker/README.md (around line 96):
- - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](https://github.com/voxel51/.../env.template#L52) and [`fiftyone-cas`](https://github.com/voxel51/.../env.template#L64))
+ - A FiftyOne Enterprise deployment requires two MongoDB databases. They are
+ created on initial startup when `FIFTYONE_DATABASE_ADMIN=true`:
+ - App database (default: `fiftyone`) — configurable via `FIFTYONE_DATABASE_NAME`
+ - CAS database (default: `fiftyone-cas`) — configurable via `CAS_DATABASE_NAME`
+ - Optional: override CAS URI via `CAS_MONGODB_URI`
+ - See defaults in [`internal-auth/env.template`](./internal-auth/env.template)
+ - Ensure your MongoDB user has privileges to create databases & collectionsFix documentation in:
- docker/README.md (lines ~96–100)
- helm/fiftyone-teams-app/README.md.gotmpl (Version 2.9+ section)
- helm/docs/upgrading.md (add a “Databases” note)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - A FiftyOne Enterprise deployment requires two separate databases in your MongoDB instance that are automatically created on startup (defaulting to [`fiftyone`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L52) and [`fiftyone-cas`](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/17c11828f3e3d02cc7eb32543d26ba3e61ebfe77/docker/internal-auth/env.template#L64)) | |
| - A FiftyOne Enterprise deployment requires two MongoDB databases. They are | |
| created on initial startup when `FIFTYONE_DATABASE_ADMIN=true`: | |
| - App database (default: `fiftyone`) — configurable via `FIFTYONE_DATABASE_NAME` | |
| - CAS database (default: `fiftyone-cas`) — configurable via `CAS_DATABASE_NAME` | |
| - Optional: override CAS URI via `CAS_MONGODB_URI` | |
| - See defaults in [`internal-auth/env.template`](./internal-auth/env.template) | |
| - Ensure your MongoDB user has privileges to create databases & collections |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
96-96: Line length
Expected: 80; Actual: 461
(MD013, line-length)
afoley587
requested changes
Aug 13, 2025
Signed-off-by: Eric Hofesmann <[email protected]>
|
Please target to |
afoley587
previously approved these changes
Aug 15, 2025
afoley587
approved these changes
Aug 15, 2025
afoley587
reviewed
Aug 15, 2025
afoley587
previously approved these changes
Aug 15, 2025
|
@ehofesmann merge asap if you want this in v2.11.0 documentation |
voxelbuildbot
dismissed
afoley587’s stale review
The base branch was changed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale
We don't explicitly call out what happens in mongo when standing up an FOE deployment (e.g. that two databases are required)
Changes
Explicitly call this out for docker compose
Checklist
Will need to call out something similar for helm when those docs are updated similar to the recent docker changes
Testing