Skip to content

[Identity] Adjust IMDS retry backoff #35070

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

Merged
pvaneck merged 2 commits into from
Apr 5, 2024
Merged

[Identity] Adjust IMDS retry backoff #35070

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e79c55
[Identity] Adjust IMDS retry backoff
pvaneck Apr 4, 2024
72ab654
Review feedback
pvaneck Apr 5, 2024
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
12 changes: 12 additions & 0 deletions sdk/identity/azure-identity/BREAKING_CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Breaking Changes

## 1.16.0

### Behavioral change to `ManagedIdentityCredential` in IMDS managed identity scenarios

As of `azure-identity` 1.16.0, `ManagedIdentityCredential` makes a minor change to the retry behavior in environments where Instance Metadata Service (IMDS) managed identity is used. The retry backoff factor for IMDS requests was reduced to `0.8` from `2` to prevent excessive delays during retries and to improve responsiveness. This change might affect workloads that rely on the previous retry behavior.
Comment thread
pvaneck marked this conversation as resolved.
Outdated

If retry settings need to be customized for IMDS managed identity scenarios, users can pass in `RetryPolicy` parameters noted in the [Azure Core Client library developer reference](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies) to the `ManagedIdentityCredential` constructor. For example:

```python
credential = ManagedIdentityCredential(retry_connect=8, retry_backoff_factor=2)
```

## 1.11.0

### Behavioral change to credential types supporting multi-tenant authentication
Expand Down
4 changes: 3 additions & 1 deletion sdk/identity/azure-identity/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Release History

## 1.16.0b3 (Unreleased)
## 1.16.0 (Unreleased)
Comment thread
pvaneck marked this conversation as resolved.

### Features Added

### Breaking Changes

- For IMDS requests in `ManagedIdentityCredential`, the retry backoff factor was reduced from 2 to 0.8 in order to avoid excessive retry delays. This change might potentially affect workloads that rely on the previous retry behavior. See [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/BREAKING_CHANGES.md).

### Bugs Fixed

### Other Changes
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/_credentials/imds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@

PIPELINE_SETTINGS = {
"connection_timeout": 2,
"retry_backoff_factor": 2,
"retry_backoff_max": 60,
Comment thread
pvaneck marked this conversation as resolved.
# Five retries, with each retry sleeping for [0.0s, 1.6s, 3.2s, 6.4s, 12.8s] between attempts.
Comment thread
xiangyan99 marked this conversation as resolved.
"retry_backoff_factor": 0.8,
"retry_on_status_codes": [404, 410, 429] + list(range(500, 600)),
"retry_status": 5,
"retry_total": 5,
Expand Down
2 changes: 1 addition & 1 deletion sdk/identity/azure-identity/azure/identity/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
VERSION = "1.16.0b3"
VERSION = "1.16.0"
⚡