Skip to content

Commit 5e2666e

Browse files
MongoCalebajhuh-mdbsarahsimpersjason-price-mongodbjason-price-mongodb
authored
Backport of DOCSP-16487 to 7.0 (#5594)
* Add useAuthorizationClaim * fix formatting and add version * one last formatting tweak * review suggestions * DOCS-16389 query plan cache subdocument (#5217) * DOCS-16389 query plan cache subdocument * * * IF feedback * clarity * nit * move to compatibility * * * wording * wording * (DOCS-16390) You can't specify WT encryption options in createCollection (#5260) * (DOCS-16390) You can't specify WT encryption options in createCollection * Includes change from tech review * DOCS-16363 Document killedDueToMaxTimeMSExpired under serverStatus (#5193) * DOCS-16363 Document killedDueToMaxTimeMSExpired under serverStatus * add to TOC * wording * build error * (DOCSP-34349) Adds release notes and compatibility changes for 7.2 (#5242) * DOCS-16363 Document killedDueToMaxTimeMSExpired under serverStatus (#5193) * DOCS-16363 Document killedDueToMaxTimeMSExpired under serverStatus * add to TOC * wording * build error * Includes PM external review changes * Revert "Includes PM external review changes" This reverts commit 0263ebe646848bf840c75b414815d3daa660e9fc. * Includes changes from PM review * Includes copy review changes --------- Co-authored-by: Alison Huh <[email protected]> * rewording * staging to check formatting * cleaning up the process * formatting foo * more review rewording and table formatting * still trying to get the table format correct... * funwith table formatting... * table formatting... * backport of docsp-16487 to 7.0 * fix table formatting and remove 7.2 release notes * fix missing (*Also available in 7.0.5*) in previous PR * review changes * Update source/includes/fact-encryption-options-create-collection.rst Co-authored-by: Alison Huh <[email protected]> * DOCSP-34855-QE-update (#5587) (#5601) * DOCSP-34855-QE-update * DOCSP-34855-QE-update * DOCSP-34855-QE-update * DOCSP-34855-QE-update * DOCSP-34855-QE-update * DOCSP-34855-QE-update * DOCSP-34855-QE-update --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-35035 adding reference to large oplog section (#5598) (#5608) * DOCSP-34820 4.4.27 Release notes (#5574) (#5590) * DOCSP-35003-glossary-1 (#5596) (#5613) * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 * DOCSP-35003-glossary-1 --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCS-14316-zones (#5551) (#5623) * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones * DOCS-14316-zones --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-35004-glossary-2 (#5602) (#5629) * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 * DOCSP-35004-glossary-2 --------- Co-authored-by: jason-price-mongodb <[email protected]> * fix backticks * fix :: preceding code block --------- Co-authored-by: Alison Huh <[email protected]> Co-authored-by: Sarah Simpers <[email protected]> Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: ltran-mdb2 <[email protected]> Co-authored-by: Kenneth P. J. Dyer <[email protected]>
1 parent 556d1a4 commit 5e2666e

File tree

6 files changed

+108
-19
lines changed

6 files changed

+108
-19
lines changed

‎source/core/hashed-sharding.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ If you shard a populated collection using a hashed shard key:
138138
- After the initial chunk creation, the balancer moves ranges of the
139139
initial chunk when it needs to balance data.
140140

141+
.. _shard-empty-collection:
142+
141143
Shard an Empty Collection
142144
~~~~~~~~~~~~~~~~~~~~~~~~~
143145

‎source/includes/fact-encryption-options-create-collection.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Starting in MongoDB 7.2 (and 7.0.5), you can't specify ``wiredTiger`` storage
2+
engine encryption options when you create a collection with
3+
:method:`db.createCollection()`. To configure encryption for
4+
the WiredTiger storage engine, see :ref:`security-encryption-at-rest`.

‎source/includes/fact-oidc-providers.rst

Lines changed: 47 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. list-table::
22
:header-rows: 1
3-
:widths: 20 25 35 20
3+
:widths: 20 18 42 20
44

55
* - Field
66

@@ -86,12 +86,11 @@
8686
* - ``requestScopes``
8787

8888
- Optional
89-
89+
9090
- array[ string ]
91-
91+
9292
- Permissions and access levels that MongoDB requests from the IDP.
9393

94-
9594
* - ``principalName``
9695

9796
- Optional
@@ -103,17 +102,55 @@
103102

104103
The default value is ``sub`` (stands for ``subject``).
105104

106-
107105
* - ``authorizationClaim``
108106

109107
- Conditional
110-
108+
111109
- string
112-
110+
113111
- Required, unless ``useAuthorizationClaim`` is set to ``false``.
114112

115113
Claim extracted from access token that contains MongoDB role names.
116114

115+
* - ``useAuthorizationClaim``
116+
117+
- Optional
118+
119+
- Boolean
120+
121+
- Determines if the ``authorizationClaim`` field is required. The default
122+
value is ``true``.
123+
124+
If the ``useAuthorizationClaim`` field is set to ``true``, the server requires
125+
an ``authorizationClaim`` for the identity provider's config. This is the
126+
default behavior.
127+
128+
If the ``useAuthorizationClaim`` field is set to ``false``, the
129+
``authorizationClaim`` field is optional (and ignored if provided).
130+
Instead, the server does the following:
131+
132+
- Searches the token for a claim whose name is listed in the
133+
``principalNameClaim`` field. This is typically named ``sub``. For
134+
example:
135+
136+
``sub: "[email protected]"``
137+
138+
- Constructs the internal username by concatenating the ``authNamePrefix``,
139+
a forward slash (``/``), and the contents of the claim identified by
140+
``principalNameClaim`` within the access token. For example, with a
141+
``authNamePrefix`` field value of "mdbinc", the internal username is:
142+
143+
``mdbinc/[email protected]``
144+
145+
- Looks for the user with this username and authorize the client with the
146+
roles:
147+
148+
.. code-block:: javascript
149+
150+
{ user: "mdbinc/[email protected]",
151+
db: "$external" }
152+
153+
.. versionadded:: 7.2 (*Also available in 7.0.5*)
117154

118155
* - ``logClaims``
119156

@@ -124,22 +161,20 @@
124161
- List of access token claims to include in log and audit messages upon
125162
authentication completion.
126163

127-
128164
* - ``JWKSPollSecs``
129165

130166
- Optional
131167

132-
- integer
168+
- Integer
133169

134170
- Frequency, in seconds, to request an updated JSON Web Key Set (JWKS) from the IDP.
135171
A setting of 0 disables polling.
136172

137-
138173
* - ``supportsHumanFlows``
139174

140175
- Optional
141176

142-
- bool
177+
- Boolean
143178

144179
- Whether the OIDC provider supports human or machine workflows. This
145180
affects the ``clientId`` and ``matchPattern`` fields.
@@ -149,5 +184,5 @@
149184

150185
Default: ``true``.
151186

152-
.. versionadded:: 7.2
187+
.. versionadded:: 7.2 (*Also available in 7.0.5*)
153188

‎source/reference/command/create.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,8 @@ The ``create`` command has the following fields:
228228
validated and logged to the :term:`oplog` during replication to
229229
support replica sets with members that use different storage
230230
engines.
231+
232+
.. include:: /includes/fact-encryption-options-create-collection.rst
231233

232234
.. seealso::
233235

@@ -616,3 +618,5 @@ specific configuration string that MongoDB will pass to the
616618
``wiredTiger`` storage engine. See the :wtdocs-v5.0:`WiredTiger documentation of
617619
collection level options </struct_w_t___s_e_s_s_i_o_n.html>`
618620
for specific ``wiredTiger`` options.
621+
622+
.. include:: /includes/fact-encryption-options-create-collection.rst

‎source/reference/command/serverStatus.txt

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1657,6 +1657,8 @@ metrics
16571657
totalTimeToFirstNonAuthCommandMillis : Long("<num>")
16581658
},
16591659
operation : {
1660+
killedDueToClientDisconnect : Long("<num>"), // Added in MongoDB 7.1 (*Also available in 7.0.5*)
1661+
killedDueToMaxTimeMSExpired : Long("<num>"), // Added in MongoDB 7.2 (*Also available in 7.0.5*)
16601662
numConnectionNetworkTimeouts : Long("<num>"), // Added in MongoDB 6.3
16611663
totalTimeWaitingBeforeConnectionTimeoutMillis : Long("<num>"), // Added in MongoDB 6.3
16621664
scanAndOrder : Long("<num>"),
@@ -1672,7 +1674,6 @@ metrics
16721674
},
16731675
query: {
16741676
allowDiskUseFalse: Long("<num>"),
1675-
planCacheTotalSizeEstimateBytes: Long("<num>"),
16761677
updateOneOpStyleBroadcastWithExactIDCount: Long("<num>"),
16771678
lookup: {
16781679
hashLookup: Long("<num>"),
@@ -2148,6 +2149,19 @@ metrics
21482149
A document that holds counters for several types of update and query
21492150
operations that MongoDB handles using special operation types.
21502151

2152+
.. serverstatus:: metrics.operation.killedDueToClientDisconnect
2153+
2154+
.. versionadded:: 7.1 (*Also available in 7.0.5*)
2155+
2156+
Total number of operations cancelled before completion
2157+
because the client disconnected.
2158+
2159+
.. serverstatus:: metrics.operation.killedDueToMaxTimeMSExpired
2160+
2161+
.. versionadded:: 7.2 (*Also available in 7.0.5*)
2162+
2163+
Total number of operations that timed out before completion.
2164+
21512165
.. serverstatus:: metrics.operation.numConnectionNetworkTimeouts
21522166

21532167
.. versionadded:: 6.3
@@ -3853,15 +3867,41 @@ planCache
38533867

38543868
.. code-block:: javascript
38553869

3856-
planCache: {
3857-
classic: { hits: Long("<num>"), misses: Long("<num>") },
3858-
sbe: { hits: Long("<num>"), misses: Long("<num>") }
3870+
planCache : {
3871+
totalQueryShapes : Long("<num>"),
3872+
totalSizeEstimateBytes : Long("<num>"),
3873+
classic : {
3874+
hits : Long("<num>"),
3875+
misses : Long("<num>")
3876+
},
3877+
sbe : {
3878+
hits : Long("<num>"),
3879+
misses: Long("<num>")
3880+
}
38593881
}
38603882

38613883
.. serverstatus:: planCache
38623884

38633885
A document that reports query plan cache statistics.
38643886

3887+
.. serverstatus:: planCache.totalQueryShapes
3888+
3889+
Approximate number of :term:`query shapes <query shape>`.
3890+
3891+
Prior to version 7.2, information on the number of query shapes was stored in
3892+
the ``query.planCacheTotalQueryShapes`` field.
3893+
3894+
.. versionadded:: 7.2 (*Also available in 7.0.5*)
3895+
3896+
.. serverstatus:: planCache.totalSizeEstimateBytes
3897+
3898+
Total size of the plan cache in bytes.
3899+
3900+
Prior to version 7.2, information on the plan cache size was stored in the
3901+
``query.planCacheTotalSizeEstimateBytes`` field.
3902+
3903+
.. versionadded:: 7.2 (*Also available in 7.0.5*)
3904+
38653905
.. serverstatus:: planCache.classic.hits
38663906

38673907
Number of classic execution engine query plans found in the query
@@ -3874,12 +3914,12 @@ planCache
38743914

38753915
.. serverstatus:: planCache.sbe.hits
38763916

3877-
Number of slot-based execution engine query plans found in the query
3917+
Number of |sbe-short| query plans found in the query
38783918
cache and reused to avoid the query planning phase.
38793919

38803920
.. serverstatus:: planCache.sbe.misses
38813921

3882-
Number of slot-based execution engine query plans which were not found
3922+
Number of |sbe-short| plans which were not found
38833923
in the query cache and went through the query planning phase.
38843924

38853925
.. _server-status-queryAnalyzers:
@@ -6733,7 +6773,7 @@ wiredTiger
67336773

67346774
.. serverstatus:: wiredTiger.cache.bytes currently in the cache
67356775

6736-
Size in byte of the data currently in cache. This value should
6776+
Size in bytes of the data currently in cache. This value should
67376777
not be greater than the ``maximum bytes configured`` value.
67386778

67396779
.. serverstatus:: wiredTiger.cache.unmodified pages evicted

‎source/reference/method/db.createCollection.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,8 @@ The ``options`` document contains the following fields:
259259
to support replica sets with members that use different storage
260260
engines.
261261

262+
.. include:: /includes/fact-encryption-options-create-collection.rst
263+
262264
.. seealso::
263265

264266
:ref:`create-collection-storage-engine-options`
@@ -542,3 +544,5 @@ specific configuration string that MongoDB will pass to the
542544
``wiredTiger`` storage engine. See the :wtdocs-v5.0:`WiredTiger documentation of
543545
collection level options </struct_w_t___s_e_s_s_i_o_n.html>`
544546
for specific ``wiredTiger`` options.
547+
548+
.. include:: /includes/fact-encryption-options-create-collection.rst

0 commit comments

Comments
 (0)