Skip to content
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.

Sign up for GitHub

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

Jump to bottom

PYTHON-2818 Add documentation and changelog #1115

Merged
merged 4 commits into from Nov 14, 2022
Merged

PYTHON-2818 Add documentation and changelog #1115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4b425d
PYTHON-2818 Add documentation and changelog
blink1073 Nov 14, 2022
f0c8901
remove errant copy
blink1073 Nov 14, 2022
75f157f
formatting
blink1073 Nov 14, 2022
da67b28
address review
blink1073 Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 8 additions & 3 deletions doc/changelog.rst
View file
Open in desktop
Expand Up @@ -4,15 +4,20 @@ Changelog
Changes in Version 4.3.3
------------------------

Version 4.3.3 documents support for :ref:`CSFLE on-demand credentials` for cloud KMS providers, and fixes the following bugs:
Version 4.3.3 documents support for the following:

- :ref:`CSFLE on-demand credentials` for cloud KMS providers.
- Authentication support for :ref:`EKS Clusters`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move the CSOT docs line here as well?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

- Added the :ref:`timeout-example` example page to improve the documentation
for :func:`pymongo.timeout`.

Bug Fixes
.........
- Fixed a performance regression in :meth:`~gridfs.GridFSBucket.download_to_stream`
and :meth:`~gridfs.GridFSBucket.download_to_stream_by_name` by reading in chunks
instead of line by line (`PYTHON-3502`_).
- Improved performance of :meth:`gridfs.grid_file.GridOut.read` and
:meth:`gridfs.grid_file.GridOut.readline` (`PYTHON-3508`_).
- Added the :ref:`timeout-example` example page to improve the documentation
for :func:`pymongo.timeout`.

Issues Resolved
...............
Expand Down
18 changes: 18 additions & 0 deletions doc/examples/authentication.rst
View file
Open in desktop
Expand Up @@ -311,6 +311,7 @@ A sample URI would be::
.. note:: The access_key_id, secret_access_key, and session_token passed into
the URI MUST be `percent escaped`_.


AWS Lambda (Environment Variables)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -331,6 +332,23 @@ for the access key ID, secret access key, and session token, respectively::
PyMongo will use credentials set via the environment variables.
These environment variables MUST NOT be `percent escaped`_.


.. _EKS Clusters:

EKS Clusters
~~~~~~~~~~~~

Applications using the `Authenticating users for your cluster from an OpenID Connect identity provider <https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html>`_ capability on EKS can now
use the provided credentials, by giving the associated IAM User
`sts:AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_
permission.

When the username and password are not provided, the MONGODB-AWS mechanism
is set, and ``AWS_WEB_IDENTITY_TOKEN_FILE``, ``AWS_ROLE_ARN``, and
optional ``AWS_ROLE_SESSION_NAME`` are available, the driver will use
an ``AssumeRoleWithWebIdentity`` call to retrieve temporary credentials.
The application must be using ``pymongo_auth_aws`` >= 1.1.0 for EKS support.

ECS Container
~~~~~~~~~~~~~

Expand Down