-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Update 1.10 enterprise upgrade docs. #10446
Conversation
🤔 This PR has changes in the |
The current 1.10 upgrade page instructions are live here: https://consul-7a2vaizou-hashicorp.vercel.app/docs/upgrading/instructions/upgrade-to-1-10-x |
866e79d
to
b335d3d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks super close actually, these are not major changes but I think a few might be important in keeping things as clear as possible!
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Paul Banks <[email protected]>
Co-authored-by: Paul Banks <[email protected]>
Added some comments. To your question around :
IMO, we have existing docs around in place upgrades vs autopilot upgrades already. So I'd add a generic sentence before the detailed steps in the preceding paragraph, something like "These instructions require licensing related configuration changes needed to upgrade to 1.10, and also require intermediate upgrade versions to ensure forward compatibility. We recommend using your existing upgrade strategies such as |
…/consul into licensing-upgrade-docs # Conflicts: # website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
the licensing changes outlined on the [Specific Version Details](/docs/upgrading/upgrade-specific#consul-1-10-0) | ||
page. There are notes on that page about other changes that might cause issues during an upgrade as well. | ||
You can find more granular details in the [licensing FAQ](/docs/enterprise/license/faq) as well as the full | ||
[changelog](https://github.com/hashicorp/consul/blob/master/CHANGELOG.md#1100-june-22-2021). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that this link will be broken until we release 1.10
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks Matt!!
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/upgrading/instructions/upgrade-to-1-10-x.mdx
Outdated
Show resolved
Hide resolved
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/393397. |
🍒✅ Cherry pick of commit 76857dd onto |
Co-authored-by: Paul Banks <[email protected]> Co-authored-by: Ashwin Venkatesh <[email protected]>
I think I have some overall structure in place but I found out that our general upgrade guide is kind of lacking. It goes over how to do an in place upgrade of OSS but doesn't cover autopilot assisted upgrades, client upgrades or snapshot agent upgrades.
Additionally, my plan was to have version specific upgrade paths in the guide. However I realized that clusters could have mixed versions and then specifying that would get way too complicated vs just saying that at each step all servers, or clients or snapshot agents needed to be upgraded to the latest in either the 1.8.x or 1.9.x series.
There are a bunch of vague steps in the 1.10 upgrade guide that I want to fill in with more info but was hoping for others opinions on how to proceed. Originally I was going to link out to the general upgrade process but that just covers upgrading the servers using an in-place upgrade strategy. This didn't seem great as I expect many enterprise users are going to use automated upgrades. So basically what would others like to see at these locations. It feels like we should have other documentation around the various scenarios but in the absence of that I am not sure what would be best in these docs.