docs: AS-385 notes for mongo 8 #5373
Conversation
WalkthroughThis pull request enhances documentation for FiftyOne users, specifically addressing MongoDB binary upgrade requirements for users running version 1.2.0 or lower on Ubuntu 24. A new documentation section has been added to Changes
Sequence DiagramsequenceDiagram
participant User
participant FiftyOne
participant MongoDB
User->>FiftyOne: Requires upgrade
FiftyOne->>MongoDB: Stop current instance
User->>FiftyOne: Upgrade FiftyOne and Fiftyone-db
FiftyOne->>MongoDB: Restart with new version
User->>MongoDB: Connect and set feature compatibility
Possibly related PRs
Suggested Labels
Suggested Reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![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 (4)
docs/source/getting_started/upgrading-mongodb.rst (3)
5-6: Add specific backup instructionsWhile the documentation emphasizes the importance of database backups, it would be helpful to include specific instructions or link to MongoDB's official backup documentation.
Consider adding:
Voxel51 advises performing database backups of your mongodb data directory whenever performing a database upgrade. + +To backup your data, you can use the following command: + +.. code-block:: shell + + mongodump --uri="$YOUR_MONGODB_URI" --out=/path/to/backup
43-43: Specify mongosh version requirementsThe mongosh installation step should specify the minimum required version for MongoDB 8 compatibility.
-4. `Install mongosh <https://www.mongodb.com/docs/mongodb-shell/install/>`_ +4. `Install mongosh 2.1.1 or later <https://www.mongodb.com/docs/mongodb-shell/install/>`_
65-65: Clarify MongoDB URI formatThe placeholder
$URI_FROM_ABOVEneeds more context about the expected format.- mongosh "$URI_FROM_ABOVE" + # The URI format should be: mongodb://localhost:PORT + # Replace PORT with the port number found in step 5 + mongosh "mongodb://localhost:PORT"docs/source/getting_started/install.rst (1)
211-216: Add version specifics to the upgrade noteThe note should explicitly mention the MongoDB versions involved in the upgrade.
.. note:: If you are a FiftyOne 1.2.0 or lower user with an Ubuntu 24 operating system, you will need to - :ref:`upgrade your mongodb binaries <mongodb-7-to-8>`. + :ref:`upgrade your MongoDB binaries from version 7.0.4 to 8.0.4 <mongodb-7-to-8>`.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/source/getting_started/install.rst(1 hunks)docs/source/getting_started/upgrading-mongodb.rst(1 hunks)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
What changes are proposed in this pull request?
This PR allowed fiftyone to natively spawn a mongodb instance on ubuntu 24. Prior to that, a hack had to be used to set the openssl version.
This PR aims to document the migration from a mongodb 7 instance to a mongodb 8 instance.
How is this patch tested? If it is not, please explain why.
Leads to:
and
Release Notes
Is this a user-facing change that should be mentioned in the release notes?
notes for FiftyOne users.
(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)
The installed mongodb binary packaged with
fiftyone[db]was upgraded fro Mongodb 7.0.4 to Mongodb 8.0.4 in order to comply with Mongodb's version matrix. Users who previously installed Fiftyone on ubuntu 24 should follow the migration guide in the documentation.What areas of FiftyOne does this PR affect?
fiftyonePython library changesSummary by CodeRabbit