PYTHON-3517 Add documentation for on-demand KMS providers #1113
Conversation
This file contains 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
ShaneHarvey
reviewed
Nov 11, 2022
doc/changelog.rst
Outdated
|
|
||
| Version 4.4 brings a number of improvements including: | ||
|
|
||
| - Added support for :ref:`CSFLE on-demand credentials` for cloud KMS providers. |
There was a problem hiding this comment.
I think this can go into the 4.3.3 release if we market it as "documented support" instead of "added support". We can say that it requires pymongocrypt>=1.4. I think this makes more sense because it will be supported by older versions of pymongo too.
ShaneHarvey
requested changes
Nov 11, 2022
doc/changelog.rst
Outdated
| @@ -4,7 +4,7 @@ Changelog | |||
| Changes in Version 4.3.3 | |||
| ------------------------ | |||
|
|
|||
| Version 4.3.3 fixes a number of bugs: | |||
| Version 4.3.3 documents supportfor :ref:`CSFLE on-demand credentials` for cloud KMS providers, and fixes the following bugs: | |||
doc/examples/encryption.rst
Outdated
|
|
||
| from pymongo import MongoClient | ||
| from pymongo.encryption import ClientEncryption | ||
| from pymongo.encryption_options import AutoEncryptionOpts |
There was a problem hiding this comment.
AutoEncryptionOpts is imported but never used in these examples. It would be good to add one AutoEncryptionOpts example.
| from pymongo.encryption_options import AutoEncryptionOpts | ||
| client = MongoClient() | ||
| client_encryption = ClientEncryption( | ||
| kms_providers={"aws": {}}, |
There was a problem hiding this comment.
A comment on these lines would be good to highlight that the empty dict means creds are looked up on demand.
ShaneHarvey
approved these changes
Nov 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.