From e6f030713c92c3d75288218fefbd0fd65900dbc7 Mon Sep 17 00:00:00 2001 From: Sam Kleinman Date: Thu, 9 Aug 2012 10:17:06 -0400 Subject: [PATCH 1/2] DOCS-290 updates to the release notes --- source/release-notes/2.2.txt | 104 +++++++++++++++++++++++++---------- 1 file changed, 75 insertions(+), 29 deletions(-) diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 5355c18d764..828c5b80ca5 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -71,6 +71,8 @@ downtime, use the following procedure: upgrade by replacing the :program:`mongod` binary with the 2.2 binary. +.. _2.2-upgrade-shard-cluster: + Upgrading a Shard Cluster ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -105,32 +107,50 @@ Major Features Aggregation Framework ````````````````````` -Documentation: :doc:`/applications/aggregation` +The aggregation framework makes it possible to do aggregation +operations without needing to use :term:`map-reduce`. The +:dbcommand:`aggregate` exposes the aggregation framework, and the +:func:`db.collection.aggregate()` helper in the :program:`mongo` shell +provides an interface to these operations. Consider the following +resources for background on the aggregation framework and its use: + +- Documentation: :doc:`/applications/aggregation` -Reference: :doc:`/reference/aggregation` +- Reference: :doc:`/reference/aggregation` -Examples: :doc:`/tutorial/aggregation-examples` +- Examples: :doc:`/tutorial/aggregation-examples` TTL Collections ``````````````` -Documentation: :doc:`/tutorial/expire-data` +TTL collections remove stale data from a collection, using a special +index and a background thread that deletes expired documents every +minute. These collections are useful as an alternative to +:term:`capped collections ` in some cases, for data +warehousing and caching cases including: machine generated event data, +logs, and session information that only need to persist in a database +for a limited period of time. + +For more information, see the :doc:`/tutorial/expire-data` tutorial. Concurrency Improvements ```````````````````````` -Issues: +In 2.2 MongoDB increases the database's capability for concurrent +operations using with two key improvements: -- :issue:`DB Level Locking ` -- :issue:`Improved Yielding on Page Faults ` +#. :issue:`DB Level Locking ` +#. :issue:`Improved Yielding on Page Faults ` -.. TODO mention server stats reporting here. currentOp, serverStatus, profile. +To reflect these changes, MognODB now provides changed and improved +reporting for concurrency and use, see the :ref:`locks` and +:ref:`server-status-record-stats` in :doc:`server status +` and in the output of +:func:`db.currentOp()` as well as :doc:`mongotop +` and :doc:`mongostat ` and +in . -Documentation: Updated reporting on :ref:`locks` in :doc:`server -status ` as well as :doc:`mongotop -` and :doc:`mongostat `. - -.. TODO add links to current op when it happens. +.. TODO add links to current op output documentation when it happens. Tag Aware Sharding `````````````````` @@ -142,20 +162,44 @@ Tag Aware Sharding Fully Supported Read Preference Semantics ````````````````````````````````````````` -.. TODO write blurb mentioning mongos. - - mongos and all major drivers support full read preference as - specified: +All MongoDB clients and drivers now support full :ref:`read +preferences ` including consistent +support for a full range of :ref:`read preference modes +` and :ref:`tag sets +`. This support extends to the +:program:`mongos` and applies similarly to both single replica sets, +and replica sets that provide components of a shard cluster. -:ref:`replica-set-read-preference` +Additional read preference support now exists in the :program:`mongo` +shell using the :func:`reaPref() ` cursor method. .. including tagging Compatibility Changes ~~~~~~~~~~~~~~~~~~~~~ -.. TODO add sections here to describe compatibility changes with - regards to authentication, drivers, and mongos' +Authentication Changes +`````````````````````` + +In order to provide more reliable and robust support for +authentication clients, including drivers and :program:`mongos` +instances. + +If your :program:`mongod` instances or cluster is running with +authentication: + +- In sharded environments, 2.0 version :program:`mongos` instances are + **not** compatible with 2.2 shard clusters running with + authentication. Use the :ref:`upgrade procedure for shard clusters + <2.2-upgrade-shard-cluster>` and upgrade all :program:`mongos` + instances to prevent operational difficulty. + +- For all drivers, use the latest release of your driver and check + its release notes. + +Drivers and :program:`mongos` instances that connect to +:program:`mongod` instances that do *not* have authentication enabled +are not affected by this issue. .. _2.2-findandmodify-returns-null: @@ -316,9 +360,6 @@ Support for logging to Syslog :issue:`SERVER-2957` -Improved Authentication Support -``````````````````````````````` - ``touch`` Command ````````````````` @@ -408,16 +449,21 @@ code base. .. TODO help the verbs -Additionally, added a flag to ``scons`` so that the build process can -use system libraries, if desired. To build MongoDB with system -libraries for all libraries, use the following arguments to ``scons``: +If you want to build MongoDB binaries using system Boost libraries, +you can pass ``scons`` the ``--use-system-boost`` flag, as follows: .. code-block:: sh - scons --use-system-all + scons --use-system-boost -You can use the ``--use-system-boost`` to only use the system Boost -library. +There is also a flag in ``scons`` if you want to build MongoDB using +all system libraries rather than the included versions of the +libraries, if desired. To build MongoDB with system libraries for all +libraries, use the following arguments to ``scons``: + +.. code-block:: sh + + scons --use-system-all See the :issue:`SERVER-3829` and :issue:`SERVER-5172` issues for more information. From f86d1192fb11b4f4cabd8565634b5188dd30d407 Mon Sep 17 00:00:00 2001 From: Sam Kleinman Date: Thu, 9 Aug 2012 11:41:22 -0400 Subject: [PATCH 2/2] DOCS-290: minor changes in response to feedback. --- source/release-notes/2.2.txt | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 828c5b80ca5..7a2ca6f8c45 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -123,7 +123,7 @@ resources for background on the aggregation framework and its use: TTL Collections ``````````````` -TTL collections remove stale data from a collection, using a special +TTL collections remove expired data from a collection, using a special index and a background thread that deletes expired documents every minute. These collections are useful as an alternative to :term:`capped collections ` in some cases, for data @@ -136,19 +136,18 @@ For more information, see the :doc:`/tutorial/expire-data` tutorial. Concurrency Improvements ```````````````````````` -In 2.2 MongoDB increases the database's capability for concurrent -operations using with two key improvements: +In 2.2 MongoDB increases the server's capacity for concurrent +operations with two key improvements: #. :issue:`DB Level Locking ` #. :issue:`Improved Yielding on Page Faults ` -To reflect these changes, MognODB now provides changed and improved +To reflect these changes, MongoDB now provides changed and improved reporting for concurrency and use, see the :ref:`locks` and :ref:`server-status-record-stats` in :doc:`server status ` and in the output of :func:`db.currentOp()` as well as :doc:`mongotop -` and :doc:`mongostat ` and -in . +` and :doc:`mongostat `. .. TODO add links to current op output documentation when it happens. @@ -167,8 +166,8 @@ preferences ` including consistent support for a full range of :ref:`read preference modes ` and :ref:`tag sets `. This support extends to the -:program:`mongos` and applies similarly to both single replica sets, -and replica sets that provide components of a shard cluster. +:program:`mongos` and applies identically to single replica sets, and +the replica sets for each shard in a :term:`shard cluster`. Additional read preference support now exists in the :program:`mongo` shell using the :func:`reaPref() ` cursor method. @@ -185,14 +184,17 @@ In order to provide more reliable and robust support for authentication clients, including drivers and :program:`mongos` instances. -If your :program:`mongod` instances or cluster is running with +If your :program:`mongod` instances or cluster runs with authentication: - In sharded environments, 2.0 version :program:`mongos` instances are **not** compatible with 2.2 shard clusters running with - authentication. Use the :ref:`upgrade procedure for shard clusters + authentication. + + You **must** use the :ref:`upgrade procedure for shard clusters <2.2-upgrade-shard-cluster>` and upgrade all :program:`mongos` - instances to prevent operational difficulty. + instances *before* upgrading the shard to prevent rendering your + cluster non-operational. - For all drivers, use the latest release of your driver and check its release notes.