Skip to content

DOCSP-15327 final round NextGen cleanup #5145

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion source/about.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License
|copy| MongoDB, Inc. 2008-|year|

Man Pages
--------
---------

In addition to the `MongoDB Manual <https://docs.mongodb.com/manual/#>`_, you can
access the :manual:`MongoDB Man Pages </manpages.tar.gz>`,
Expand Down
73 changes: 44 additions & 29 deletions source/administration/security-checklist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,17 @@ Pre-production Checklist/Considerations
requires that all clients and servers provide valid credentials
before they can connect to the system.

See also:
|

- :doc:`/core/authentication`
- :doc:`/tutorial/enable-authentication`
See also:

- :doc:`/core/authentication`
- :doc:`/tutorial/enable-authentication`

.. _security-checklist-role-based-access-control:

Configure Role-Based Access Control
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|arrow| Configure Role-Based Access Control
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Create a user administrator **first**, then create additional
users. Create a unique MongoDB user for each person/application
Expand All @@ -45,16 +47,19 @@ Configure Role-Based Access Control
users and assign them only the roles they need to perform their
operations. A user can be a person or a client application.

Note that a user can have privileges across different databases. If a
user requires privileges on multiple databases, create a
single user with roles that grant applicable database
privileges instead of creating the user multiple times in
different databases.
.. note::

A user can have privileges across different databases. If a user
requires privileges on multiple databases, create a single user
with roles that grant applicable database privileges instead of
creating the user multiple times in different databases.

|

See also:
See also:

- :doc:`/core/authorization`
- :doc:`/tutorial/manage-users-and-roles`
- :doc:`/core/authorization`
- :doc:`/tutorial/manage-users-and-roles`

|arrow| Encrypt Communication (TLS/SSL)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -71,7 +76,9 @@ See also:

.. include:: /includes/fact-tls-1.0.rst

See also: :doc:`/tutorial/configure-ssl`.
|

See also: :doc:`/tutorial/configure-ssl`.

.. |binary| replace:: MongoDB

Expand Down Expand Up @@ -108,19 +115,21 @@ See also: :doc:`/tutorial/configure-ssl`.

.. include:: /includes/fact-default-bind-ip-change.rst

See also:
|

- :doc:`/core/security-hardening`
See also:

- the :setting:`net.bindIp` configuration setting

- the :setting:`security.clusterIpSourceWhitelist` configuration
setting
- :doc:`/core/security-hardening`

- the :ref:`authenticationRestrictions
<db-createUser-authenticationRestrictions>` field to the
:dbcommand:`db.createUser()` command to specify a per-user IP
whitelist.
- the :setting:`net.bindIp` configuration setting

- the :setting:`security.clusterIpSourceWhitelist` configuration
setting

- the :ref:`authenticationRestrictions
<db-createUser-authenticationRestrictions>` field to the
:method:`db.createUser()` command to specify a per-user IP
whitelist.


|arrow| Audit System Activity
Expand All @@ -136,11 +145,13 @@ See also:
up filters to record specific events, such as authentication
events.

See also:
|

See also:

- :doc:`/core/auditing`
- :doc:`/core/auditing`

- :doc:`/tutorial/configure-auditing`
- :doc:`/tutorial/configure-auditing`

|arrow| Run MongoDB with a Dedicated User
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -149,7 +160,9 @@ See also:
account. Ensure that the account has permissions to access data
but no unnecessary permissions.

See also: :doc:`/installation`
|

See also: :doc:`/installation`

.. _security-checklist-javascript:

Expand All @@ -168,7 +181,9 @@ See also: :doc:`/installation`
This ensures that all documents stored by the
:binary:`~bin.mongod` instance are valid :term:`BSON`.

See also: :doc:`/core/security-hardening`
|

See also: :doc:`/core/security-hardening`

|arrow| Request a Security Technical Implementation Guide (where applicable)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
23 changes: 23 additions & 0 deletions source/changeStreams.txt
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,15 @@ The following example opens a change stream for a collection and
iterates over the cursor to retrieve the change stream documents.
[#start-time]_

----------

.. |arrow| unicode:: U+27A4

|arrow| Use the **Select your language** drop-down menu in the
upper-right to set the language of the examples on this page.

----------

.. tabs-selector:: drivers

.. tabs-drivers::
Expand Down Expand Up @@ -308,6 +317,13 @@ open, the cursor remains open until one of the following occurs:
Modify Change Stream Output
---------------------------

----------

|arrow| Use the **Select your language** drop-down menu in the
upper-right to set the language of the examples on this page.

----------

.. tabs-drivers::

.. tab::
Expand Down Expand Up @@ -482,6 +498,13 @@ the update operation. However, you can configure the change stream
to return the most current majority-committed version of the updated
document.

----------

|arrow| Use the **Select your language** drop-down menu in the
upper-right to set the language of the examples on this page.

----------

.. tabs-drivers::

.. tab::
Expand Down
8 changes: 5 additions & 3 deletions source/core/capped-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ Query Efficiency
~~~~~~~~~~~~~~~~

Use natural ordering to retrieve the most recently inserted elements
from the collection efficiently. This is (somewhat) analogous to tail
on a log file.
from the collection efficiently. This is similar to using the ``tail``
command on a log file.

Aggregation ``$out``
~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -166,7 +166,9 @@ collection using the ``max`` field as in the following document:
documents if a collection reaches the maximum size limit before it
reaches the maximum document count.

.. see:: :method:`db.createCollection()` and :dbcommand:`create`.
.. see::

:method:`db.createCollection()` and :dbcommand:`create`.

.. _capped-collections-options:

Expand Down
3 changes: 1 addition & 2 deletions source/core/map-reduce-concurrency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Map-Reduce Concurrency
:depth: 1
:class: singlecol

.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce
:class: note
.. note:: Aggregation Pipeline as an Alternative to Map-Reduce

.. include:: /includes/fact-use-aggregation-not-map-reduce.rst

Expand Down
3 changes: 1 addition & 2 deletions source/core/map-reduce-sharded-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Map-Reduce and Sharded Collections
:depth: 1
:class: singlecol

.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce
:class: note
.. note:: Aggregation Pipeline as an Alternative to Map-Reduce

.. include:: /includes/fact-use-aggregation-not-map-reduce.rst

Expand Down
2 changes: 1 addition & 1 deletion source/core/read-isolation-consistency-recency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ upper-right to set the language of this example.

----------

.. tabs-pillstrip:: languages
.. tabs-selector:: drivers

.. tabs-drivers::

Expand Down
1 change: 0 additions & 1 deletion source/core/replica-set-high-availability.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
: replica set; failover
.. _replica-set-failover-administration:
.. _replica-set-failover:
.. _failover:
Expand Down
5 changes: 0 additions & 5 deletions source/core/replica-set-rollbacks.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@

single: replica set; rollbacks
single: consistency; rollbacks

.. _replica-set-rollbacks:
.. _replica-set-rollback:

Expand Down Expand Up @@ -58,7 +54,6 @@ By default, when a rollback occurs, MongoDB writes the rollback data to
:term:`BSON` files.

.. note:: Rollback Directory Change


Starting in Mongo 4.4, the rollback directory for a collection is named
after the collection's UUID rather than the collection namespace.
Expand Down
2 changes: 1 addition & 1 deletion source/core/security-client-side-encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ the following official 4.2-compatible driver versions:
- Supported Versions
- Quickstarts / Tutorials

* - :driverecosystem:`Node </node>`
* - :driver:`Node </node>`
- ``3.4.0+``
- | `Node.js Quickstart <https://mongodb.github.io/node-mongodb-native/3.4/reference/client-side-encryption/>`__
| :driver:`Client-Side Field Level Encryption Guide </security/client-side-field-level-encryption-guide>`
Expand Down
5 changes: 0 additions & 5 deletions source/core/sharding-shard-key.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

single: sharding; shard key

.. _sharding-shard-key:
.. _shard-key:
.. _sharding-internals-shard-keys:
Expand All @@ -11,8 +8,6 @@ Shard Keys

.. default-domain:: mongodb



.. contents:: On this page
:local:
:backlinks: none
Expand Down
6 changes: 1 addition & 5 deletions source/core/transactions-in-applications.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ Drivers API

.. default-domain:: mongodb



.. contents:: On this page
:local:
:backlinks: none
Expand Down Expand Up @@ -62,7 +60,7 @@ upper-right to set the language of the examples on this page.

----------

.. tabs-pillstrip:: languages
.. tabs-selector:: drivers

.. tabs-drivers::

Expand Down Expand Up @@ -353,8 +351,6 @@ upper-right to set the language of the examples on this page.
The following example incorporates logic to retry the transaction for
transient errors and retry the commit for unknown commit error:

.. tabs-pillstrip:: languages

.. include:: /includes/driver-examples/driver-example-transactions-retry-3.rst

Driver Versions
Expand Down
6 changes: 3 additions & 3 deletions source/core/transactions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ databases, documents, and shards.
Transactions API
----------------

This example highlights the key components of the transactions API.

----------

.. |arrow| unicode:: U+27A4
Expand All @@ -42,7 +40,9 @@ upper-right to set the language of the following example.

----------

.. tabs-pillstrip:: languages
This example highlights the key components of the transactions API.

.. tabs-selector:: drivers

.. tabs-drivers::

Expand Down
1 change: 1 addition & 0 deletions source/core/wiredtiger.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _storage-wiredtiger:
.. _storage-wiredTiger:

=========================
WiredTiger Storage Engine
Expand Down
6 changes: 3 additions & 3 deletions source/faq/concurrency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ following locks depending on the version of MongoDB:
- MongoDB 4.0.X and previous


* - :dbcommand:`renameCollection`
* - :dbcommand:`renameCollection` database command

- If renaming a collection within the same database, the
:dbcommand:`renameCollection` command takes an exclusive (W) lock
Expand All @@ -270,7 +270,7 @@ following locks depending on the version of MongoDB:
the same database.


* - :method:`~db.collection.renameCollection()`
* - :method:`~db.collection.renameCollection()` shell helper method

- If renaming a collection within the same database, the
:method:`~db.collection.renameCollection()` method takes an
Expand Down Expand Up @@ -333,7 +333,7 @@ the collection level:
Prior to MongoDB 4.2, the operation takes an exclusive (W) lock
on the database when renaming within the same database.

- For :dbcommand:`renameCollection` *only*:: If the target namespace
- For :dbcommand:`renameCollection` *only*: If the target namespace
is in a different database as the source collection, the locking
behavior is version dependent:

Expand Down
4 changes: 1 addition & 3 deletions source/faq/replica-sets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,7 @@ networks.

.. see::

The overview of
:ref:`Arbiter Members of Replica Sets
<replica-set-arbiters>`.
:ref:`Arbiter Members of Replica Sets <replica-set-arbiters>`

Is it normal for replica set members to use different amounts of disk space?
----------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/includes/changelogs/releases/4.0.22.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sharding
~~~~~~~~

- :issue:`SERVER-36739` Use the mongos_manual_intervention_action hook in concurrency stepdown suites
- :issue:`SERVER-41192` Add a metric for the size of the SessionCatalog under `logicalSessionRecordCache`
- :issue:`SERVER-41192` Add a metric for the size of the SessionCatalog under ``logicalSessionRecordCache``
- :issue:`SERVER-42632` Disable pinger threads that reach out to config server to make integration tests pass
- :issue:`SERVER-46393` Always check client last operation time when computing operationTime to append to the response
- :issue:`SERVER-48679` flushRoutingTableCacheUpdates should block on critical section with kWrite, not kRead
Expand Down
2 changes: 1 addition & 1 deletion source/includes/changelogs/releases/4.0.23.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sharding
~~~~~~~~

- :issue:`SERVER-50305` ARS::next() does not respect OperationContext deadline
- :issue:`SERVER-53274` The force-write of the `history` field to all chunks on FCV upgrade from 3.6 to 4.0 is unnecessary
- :issue:`SERVER-53274` The force-write of the ``history`` field to all chunks on FCV upgrade from 3.6 to 4.0 is unnecessary

Replication
~~~~~~~~~~~
Expand Down
Loading