DOCSP-42215 Atlas compatibility for CSFLE key management and client m…

…ethods (#10499) * Atlas compatibility draft * Added community and enterprise edition support * Removed note about support on all Atlas clusters * Added Syntax headings where missing, moved compatibility before Syntax * Fixed self-reference link
mongodb · Dec 6, 2024 · a9002f7 · a9002f7
1 parent 223f3d9
commit a9002f7
Show file tree

Hide file tree

Showing 16 changed files with 458 additions and 231 deletions.
diff --git a/source/reference/method/ClientEncryption.createEncryptedCollection.txt b/source/reference/method/ClientEncryption.createEncryptedCollection.txt
@@ -18,6 +18,18 @@ ClientEncryption.createEncryptedCollection()
    encrypted collection specified by ``collName`` on the database 
    specified by ``dbName``.
 
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Syntax
 ------
 
@@ -38,6 +50,7 @@ following syntax:
      }
    )
 
+
 Command Fields
 --------------
 
@@ -84,6 +97,7 @@ Command Fields
     - How to get the master key when the KMS Provider is AWS, GCP, or 
       Azure.
 
+
 Behavior
 --------
 

diff --git a/source/reference/method/ClientEncryption.decrypt.txt b/source/reference/method/ClientEncryption.decrypt.txt
@@ -18,6 +18,18 @@ ClientEncryption.decrypt()
 
    :returns: The decrypted value.
 
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Syntax
 ------
 

diff --git a/source/reference/method/ClientEncryption.encrypt.txt b/source/reference/method/ClientEncryption.encrypt.txt
@@ -22,6 +22,18 @@ ClientEncryption.encrypt()
      A :bsontype:`binary data <Binary>`  object with
      `subtype 6 <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/subtype6.rst>`_.
 
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Syntax
 ------
 

diff --git a/source/reference/method/KeyVault.addKeyAlternateName.txt b/source/reference/method/KeyVault.addKeyAlternateName.txt
@@ -23,24 +23,40 @@ KeyVault.addKeyAlternateName()
    with a :ref:`partial index <index-type-partial>` filter for only 
    documents where ``keyAltNames`` exists.
 
-   :method:`~KeyVault.addKeyAlternateName()` has the following syntax:
-
-   .. code-block:: none
-
-      keyVault = db.getMongo().getKeyVault()
-
-      keyVault.addKeyAlternateName(
-        UUID("<UUID string>"),
-        "keyAlternateName"
-      )
-
    :returns:
 
      Returns the previous version of the data encryption key document.
 
      Returns ``null`` if no data encryption key has the specified
      ``UUID()``.
 
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
+Syntax
+------
+
+:method:`~KeyVault.addKeyAlternateName()` has the following syntax:
+
+.. code-block:: none
+
+   keyVault = db.getMongo().getKeyVault()
+
+   keyVault.addKeyAlternateName(
+      UUID("<UUID string>"),
+      "keyAlternateName"
+   )
+
+
 Behavior
 --------
 

diff --git a/source/reference/method/KeyVault.addKeyName.txt b/source/reference/method/KeyVault.addKeyName.txt
@@ -27,6 +27,18 @@ KeyVault.addKeyAltName()
    This method is an alias for 
    :method:`~KeyVault.addKeyAlternateName()`.
 
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 .. seealso::
 
    :method:`~KeyVault.addKeyAlternateName()`.
diff --git a/source/reference/method/KeyVault.createDataKey.txt b/source/reference/method/KeyVault.createDataKey.txt
@@ -20,8 +20,20 @@ KeyVault.createDataKey()
    for supporting encryption and decryption of field values.
 
    This method is an alias for
-   :method:`~KeyVault.createDataKey()`.
+   :method:`~KeyVault.createKey()`.
+
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following
+environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 
 .. seealso::
 
-   :method:`~KeyVault.createDataKey()`.
+   :method:`~KeyVault.createKey()`.