Skip to content

Clarify expected interaction between Worker Versions and Durable Obje… #20762

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
Closed
wants to merge 3 commits into from
Closed

Clarify expected interaction between Worker Versions and Durable Obje… #20762

wants to merge 3 commits into from

Conversation

@joshthoward
Copy link
Contributor

@joshthoward joshthoward commented Mar 12, 2025

…cts migrations

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 12, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Clarified the expected interaction between Worker Versions and Durable Objects migrations, enhancing the documentation for better understanding.

  • Updated migration examples for Durable Objects to improve clarity and consistency.
  • Added a section on the atomic nature of Durable Object migrations and their deployment process.
  • Revised the explanation of gradual deployments for Durable Objects to emphasize compatibility and deployment strategies.

Modified Files

  • src/content/docs/durable-objects/reference/durable-objects-migrations.mdx
  • src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@github-actions github-actions bot added product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product labels Mar 12, 2025
irvinebroque
irvinebroque reviewed Mar 12, 2025
View reviewed changes
src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx Outdated

In order to limit the blast radius of Durable Object migration deployments, migrations should be deployed independently of other code changes.

To understand why Durable Object migrations are atomic operations, consider the hypothetical example of gradually deploying a delete migration. If a delete migration were applied to 50% of Durable Object instances, then Workers requesting those Durable Object instances would fail because they would have been deleted. To do this without producing errors, a version of the Worker which does not depend on any Durable Object instances would have to have already been rolled out. At which point you can deploy a delete migration without affecting any traffic and there is no reason to do so gradually.
Copy link
Contributor

@irvinebroque irvinebroque Mar 12, 2025

Choose a reason for hiding this comment

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

this is good explainer to have and point ppl back to 🙌

@Oxyjun Oxyjun mentioned this pull request Apr 14, 2025
Merged
3 tasks
@Oxyjun
Copy link
Contributor

Oxyjun commented Apr 14, 2025

Now tracking here #21677

@Oxyjun Oxyjun closed this Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Oxyjun Oxyjun Oxyjun left review comments

@irvinebroque irvinebroque irvinebroque approved these changes

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@mikenomitch mikenomitch Awaiting requested review from mikenomitch mikenomitch is a code owner

@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner

Assignees

@elithrar elithrar

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@vy-ton vy-ton

@Oxyjun Oxyjun

@ToriLindsay ToriLindsay

Labels

product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@joshthoward @Oxyjun @irvinebroque @elithrar @mikenomitch @GregBrimble @WalshyDev @vy-ton @ToriLindsay