-
Notifications
You must be signed in to change notification settings - Fork 29
DOCSP-45212 Compatibility #97
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.
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
Merged
stephmarie17
merged 11 commits into
mongodb:standardization
from
stephmarie17:docsp-45212-compatibility
Dec 13, 2024
Merged
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
918c63a
add new page and includes
stephmarie17 d78fe38
edits
stephmarie17 f9eb47e
update index
stephmarie17 647525a
remove old file
stephmarie17 69fff45
cleanup and consolidate tables
stephmarie17 956b3a4
MR feedback
stephmarie17 c13b640
edits
stephmarie17 75cda13
remove unused include
stephmarie17 729145c
update
stephmarie17 b695b10
edits
stephmarie17 c44c8d7
sme feedback
stephmarie17 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| .. _ruby-compatibility: | ||
|
|
||
| ============= | ||
| Compatibility | ||
| ============= | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 2 | ||
| :class: singlecol | ||
|
|
||
| .. facet:: | ||
| :name: genre | ||
| :values: reference | ||
|
|
||
| .. meta:: | ||
| :keywords: backwards compatibility, versions, upgrade | ||
|
|
||
| MongoDB Compatibility | ||
| --------------------- | ||
|
|
||
| The following compatibility table specifies the recommended | ||
| version(s) of the {+driver-long+} for use with a specific version of | ||
| MongoDB. Except when indicated, the specified driver versions expose or | ||
| take advantage of the features added in the corresponding server versions. | ||
|
|
||
| MongoDB server releases are generally backwards compatible. This means a | ||
| particular driver version will generally work with newer server versions but might | ||
| not utilize the new functionalities in those server versions. | ||
|
|
||
| The first column lists the driver versions. | ||
|
|
||
| .. sharedinclude:: dbx/lifecycle-schedule-callout.rst | ||
|
|
||
| .. include:: /includes/compatibility-table-legend-ruby.rst | ||
|
|
||
| .. include:: /includes/mongodb-compatibility-table-ruby.rst | ||
|
|
||
| The driver does not support older versions of MongoDB. | ||
|
|
||
| Language Compatibility | ||
| ---------------------- | ||
|
|
||
| The following compatibility table specifies the versions of Ruby supported | ||
| by the various versions of the {+driver-long+}. | ||
|
|
||
| The first column lists the driver versions. | ||
|
|
||
| .. include:: /includes/compatibility-table-legend-ruby.rst | ||
|
|
||
| .. include:: /includes/language-compatibility-table-ruby.rst | ||
|
|
||
| The driver does not support older versions of Ruby. | ||
|
|
||
| Rails/ActiveSupport Compatibility | ||
| --------------------------------- | ||
|
|
||
| The {+driver-short+} does not depend on ActiveSupport. However, if your | ||
| application uses ActiveSupport or Ruby on Rails, you must load the driver's | ||
| ActiveSupport compatibility code for behavior such as time serialization to be | ||
| correct: | ||
|
|
||
| .. code-block:: ruby | ||
|
|
||
| require 'mongo' | ||
| require 'mongo/active_support' | ||
|
|
||
| Applications using Mongoid 7.0.6 or newer do not need to explicitly load | ||
| the driver's ActiveSupport code, since Mongoid automatically does so. | ||
|
|
||
| .. _tls-compatibility: | ||
|
|
||
| TLS/SSL Compatibility | ||
| ---------------------- | ||
|
|
||
| The {+driver-short+} uses the protocols supported by the underlying Ruby | ||
| ``openssl`` extension. The ``openssl`` extension generally exposes | ||
| the functionality available in the operating system's OpenSSL library. | ||
|
|
||
| Industry best practices, and some regulations, require the use of TLS 1.1 | ||
| or newer. Some operating systems or versions might not provide an OpenSSL version | ||
| that supports these TLS versions. | ||
|
|
||
| If you use macOS older than 10.13 (High Sierra), you need to install Ruby from | ||
| `rvm`_, `homebrew`_, `macports`_, or another similar source. See | ||
| `Installing Ruby`_ for more options. | ||
|
|
||
| If you use Linux or other non-macOS Unix system, you can check your OpenSSL version | ||
| as follows: | ||
|
|
||
| .. code-block:: sh | ||
|
|
||
| openssl version | ||
|
|
||
| If the version number is less than 1.0.1, support for TLS 1.1 or newer is | ||
| not available. Contact your operating system vendor for a solution or upgrade | ||
| to a newer distribution. | ||
|
|
||
| You can check your TLS version by running the following command in your Ruby | ||
| interpreter: | ||
stephmarie17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| .. code-block:: sh | ||
|
|
||
| ruby -e "require 'net/http'; require 'json'; puts JSON.parse(Net::HTTP.get(URI('https://www.howsmyssl.com/a/check')))['tls_version']" | ||
|
|
||
| After running the command, you must see ``TLS 1.X`` where ``X`` is greater than | ||
| or equal to ``1``. | ||
|
|
||
| To learn more about TLS versions and their security implications, see `Transport Layer Security Cheat Sheet | ||
| <https://cheatsheetseries.owasp.org/cheatsheets/Transport_Layer_Security_Cheat_Sheet.html>`_. | ||
|
|
||
| .. _rvm: https://rvm.io/ | ||
| .. _homebrew: https://brew.sh/ | ||
| .. _macports: https://www.macports.org/ | ||
| .. _Installing Ruby: https://www.ruby-lang.org/en/documentation/installation | ||
|
|
||
| Atlas Compatibility | ||
| ------------------- | ||
|
|
||
| We recommend {+driver-short+} version 2.6.1 or later when using MongoDB Atlas. | ||
| This version has significant performance improvements for TLS connections, and | ||
| all Atlas connections use TLS. | ||
|
|
||
| When running on JRuby and connecting to Atlas Free Tier, {+driver-short+} | ||
| version 2.6.4 or later and Java 8 or later are required. | ||
stephmarie17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| mongo_kerberos Compatibility | ||
| ---------------------------- | ||
|
|
||
| {+driver-short+} versions 2.7 and later are compatible with the | ||
| ``mongo_kerberos`` gem version 2.1 of the :ref:`mongo_kerberos library <kerberos>`. | ||
stephmarie17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| JRuby and Kerberos Authentication | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If you use the ``mongo_kerberos`` gem for Kerberos authentication with JRuby, | ||
| the JVM system property ``sun.security.jgss.native`` is set to ``true``. This | ||
| facilitates the use of the system cache of Ticket Granting Tickets (TGTs), for | ||
| example, TGTs obtained with ``kinit``. | ||
stephmarie17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This setting also affects any other use of the JGSS library, making any TGTs in | ||
| the system cache available for obtaining Kerberos credentials. | ||
|
|
||
| .. include:: /includes/unicode-checkmark.rst | ||
|
|
||
| JRuby and TLS Connections | ||
| ------------------------- | ||
|
|
||
| Due to JRuby limitations: | ||
|
|
||
| - The driver does not support ECDSA server certificates. | ||
| - The driver does not perform OCSP endpoint checking. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| Compatibility Table Legend | ||
| ++++++++++++++++++++++++++ | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :stub-columns: 1 | ||
| :class: compatibility | ||
|
|
||
| * - Icon | ||
| - Explanation | ||
|
|
||
| * - ✓ | ||
| - All features are supported. | ||
| * - D | ||
| - Support for the Driver version is deprecated. | ||
| * - No mark | ||
| - The Driver version is not tested with the MongoDB version. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :stub-columns: 1 | ||
| :class: compatibility-large no-padding | ||
|
|
||
| * - Ruby Driver | ||
| - Ruby 3.2 | ||
| - Ruby 3.1 | ||
| - Ruby 3.0 | ||
| - Ruby 2.7 | ||
| - Ruby 2.6 | ||
| - Ruby 2.5 | ||
| - Ruby 2.4 | ||
| - Ruby 2.3 | ||
| - Ruby 2.2 | ||
| - Ruby 2.1 | ||
| - Ruby 2.0 | ||
| - Ruby 1.9 | ||
stephmarie17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - JRuby 9.4 | ||
| - JRuby 9.3 | ||
| - JRuby 9.2 | ||
| - JRuby 9.1 | ||
|
|
||
| * - 2.20 to 2.21 | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - | ||
|
|
||
| * - 2.19 | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - D | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.18 | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.17 | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.16 | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.15 | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - D | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.14 | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - D | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.11 to 2.13 | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - | ||
|
|
||
| * - 2.10 | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - D | ||
| - D | ||
| - D | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
|
|
||
| * - 2.9 | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - D | ||
| - D | ||
| - D | ||
| - D | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
|
|
||
| * - 2.6 to 2.8 | ||
| - | ||
| - | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - |checkmark| | ||
| - | ||
| - | ||
| - |checkmark| | ||
| - |checkmark| | ||
|
|
||
| .. include:: /includes/unicode-checkmark.rst | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.