Skip to content

Commit

Permalink
Clarify zero-downtime upgrade docs
Browse files Browse the repository at this point in the history
According to Matrix discussion, it sounds like Pulp already supports
zero-downtime upgrades. I'm updating the docs to be more clear about
this.

[noissue]
  • Loading branch information
daviddavis authored and mdellweg committed Sep 18, 2024
1 parent 0fd444d commit 45628a2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/dev/learn/plugin-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -657,9 +657,9 @@ time to finding a fix and was generally less surprising.

## Zero-Downtime Upgrades

Eventually, Pulp users will be able to upgrade without first stopping Pulp services. This has been
[requested from the community](https://discourse.pulpproject.org/t/support-zero-downtime-updates/645),
To work towards that goal, developers of `pulpcore` or a plugin should follow these requirements:
Pulp users should be able to upgrade without first stopping Pulp services. This has been
[requested from the community](https://discourse.pulpproject.org/t/support-zero-downtime-updates/645).
To support this, developers of `pulpcore` or a plugin should follow these requirements:

- Migrations must not break earlier versions code still running during an upgrade.
- Task code must be backwards compatible until the next major Pulp version.
Expand All @@ -669,6 +669,12 @@ Future user upgrades will likely run as follow:
1. Run the migrations while old pulp code is online. Old code, is using the new data format.
2. Rolling restart old code to become new code. Old and new code is running at the same time!

!!! note

Zero-downtime upgrade support is provided as a best effort and sometimes it is not feasible to
write a migration that doesn't require downtime. In such cases, a changelog entry should be
added that notes the release has a migration that requires downtime.

# Zero-Downtime Migrations

The significant challenge with online migrations is that the db state the migration applies has to
Expand Down

0 comments on commit 45628a2

Please sign in to comment.