Skip to content

Docker compose CAS db callout #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docker compose CAS db callout #422

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d33637
Docker compose CAS db callout
ehofesmann Aug 13, 2025
ae72e52
Update README.md
ehofesmann Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ regarding FiftyOne Enterprise.
- License file from Voxel51
- Docker Hub credentials from Voxel51
- MongoDB instance available.
- FiftyOne Teams is compatible with MongoDB Community, Enterprise, or Atlas
- FiftyOne Enterprise is compatible with MongoDB Community, Enterprise, or Atlas
Editions.
- If using MongoDB Community or Enterprise we recommend a minimum of 4vCPU and
16GB of RAM. Large datasets and complex samples may require additional
Expand All @@ -93,6 +93,7 @@ regarding FiftyOne Enterprise.
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))
Copy link

Choose a reason for hiding this comment

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

💡 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 collections

If 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=true for 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 || true

Length 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 when FIFTYONE_DATABASE_ADMIN=true.
  • Reflow the bullet in docker/README.md to wrap at ~80 chars, reference the env vars by name, and link relatively to internal-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.gotmpl under 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 & collections

Fix 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)

- For resource requirements on a VM that will be hosting your docker deployment,
we recommend starting with 8vCPU/32GB RAM, monitoring usage and scaling
accordingly.
Expand Down
Loading