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.

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

upgrade.rst: remove instructions for upgrades before 3.2 #4625

Conversation

dilyanpalauzov
Copy link
Contributor

The only way to upgrade to 3.6 is to have first version 3.2 installed. That said, it can be assumed that users will first read the upgrade instructions to version 3.2 from https://www.cyrusimap.org/3.2/imap/download/upgrade.html .

Since there is stated already that BDB is gone in Cyrus IMAP 3.0 and the handling of special-use flags after 2.4 is discussed, there is no need to have this information in the upgrade notes for 3.6, 3.8 and master/dev .

@dilyanpalauzov dilyanpalauzov force-pushed the upgrade_rst_strip_pre36 branch 5 times, most recently from 3f7e6c7 to 73e0952 Compare August 26, 2023 12:05
The only way to upgrade to 3.6 is to have first version 3.2 installed.
That said, it can be assumed that users will first read the upgrade
instructions to version 3.2 from https://www.cyrusimap.org/3.2/imap/download/upgrade.html .

Since there is stated already that BDB is gone in Cyrus IMAP 3.0 and the
handling of special-use flags after 2.4 is discussed, there is no need to
have this information in the upgrade notes for 3.6, 3.8 and master/dev .

Likewise for the other changes.
@dilyanpalauzov dilyanpalauzov force-pushed the upgrade_rst_strip_pre36 branch from 73e0952 to 476f298 Compare August 26, 2023 12:16
dilyanpalauzov added a commit to dilyanpalauzov/cyrus-imapd that referenced this pull request Sep 24, 2024
cyrusimap#4625

The only way to upgrade to 3.6 is to have first version 3.2 installed.
That said, it can be assumed that users will first read the upgrade
instructions to version 3.2 from https://www.cyrusimap.org/3.2/imap/download/upgrade.html .

Since there is stated already that BDB is gone in Cyrus IMAP 3.0 and the
handling of special-use flags after 2.4 is discussed, there is no need to
have this information in the upgrade notes for 3.6, 3.8 and master/dev .
@rsto rsto self-assigned this Oct 14, 2024
@rsto
Copy link
Member

rsto commented Oct 15, 2024

@elliefm This looks good to me, other than it should refer to version 3.10 rather than 3.8 in the upgrade instructions. Do you agree?

@elliefm
Copy link
Contributor

elliefm commented Oct 16, 2024

@rsto This is the upgrade instructions on the master branch, and the master branch documentation is for the eventual next release, so "3.10" wouldn't be strictly correct here either. But I don't think it really matters anyway, since I'll review and update the document when preparing next year's stable release and fix the number then. I suppose we could use the magic word "UNRELEASED" here, like we already do in imapoptions.

@rsto
Copy link
Member

rsto commented Oct 16, 2024

@elliefm I would apply the following changes, e.g. keep mentioning that BDB is not supported anymore:

Upgrade by replicating
~~~~~~~~~~~~~~~~~~~~~~

If you're familiar with replication, you can set up your existing installation to
replicate data to a new UNRELEASED installation and failover to the new installation
when you're ready. The replication protocol has been kept backwards compatible.

Upgrade in place
~~~~~~~~~~~~~~~~

If you are upgrading in place, you will need to shut down Cyrus
entirely while you install the new package.  If your old installation
was using Berkeley DB format databases, you will need to convert or
upgrade the databases **before** you upgrade.  Cyrus UNRELEASED does not
support Berkeley DB at all.

@dilyanpalauzov
Copy link
Contributor Author

keep mentioning that BDB is not supported anymore

Why?

@elliefm elliefm self-requested a review October 25, 2024 03:10
@elliefm elliefm assigned elliefm and unassigned rsto Oct 25, 2024
@elliefm
Copy link
Contributor

elliefm commented Feb 21, 2025

I wound up making similar changes myself as part of the 3.12 release, they're in 8ac9254

@elliefm elliefm closed this Feb 21, 2025
@dilyanpalauzov
Copy link
Contributor Author

Currently the text at https://www.cyrusimap.org/3.12/imap/download/upgrade.html states: “you should first upgrade to 3.10.1 … Upgrade by replicating … If you're familiar with replication, and your current installation is 2.4 or newer, you can set up your existing installation to replicate data to a new 3.12 installation”

This text still suggests at the same time that before upgrading to 3.12 the underlying system must be 3.10, but states also that upgrade over replacation from 2.4 can be achieved.

If upgrades from 2.4 are still possible, the sentence that upgrade first upgrade to 3.10 should be made, is confusing.

@elliefm
Copy link
Contributor

elliefm commented Feb 23, 2025

Yeah I left that section alone, because I don't know what's actually true -- as far as I know you can still replicate from 2.4 to 3.12.

This document is a bit of a mess, and these kind of piecemeal updates of individual details don't really resolve that, but it's what we've got to work with. I might mess around with the heading levels, and see if I can get a more clear separation between the "upgrade in place" vs "install a new server and replicate your data into it" sections.

@elliefm
Copy link
Contributor

elliefm commented Feb 23, 2025

Actually, I just found another thing (#4967) that reckons that replication from 3.0-or-earlier to 3.2-or-later are broken for mailboxes that have annotations. So replication from 2.4->3.12 might work if no mailboxes have annotations, but will break if they do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants