Update "Upgrade Elastic Cloud Enterprise" doc and add known issue link as reference #4402
Conversation
kunisen
added
supportability
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
|
🔍 Preview links for changed docs |
| Before starting the upgrade process, verify that your setup meets the following requirements: | ||
|
|
||
| - XFS with quotas enabled on all allocators. You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly. To enable XFS quotas, modify the entry for the XFS volume in the `/etc/fstab file` to add pquota and `prjquota`. The default filesystem path used by {{ece}} is `/mnt/data`. | ||
| - **Review [known issues](cloud://release-notes/cloud-enterprise/known-issues.md) prior to upgrading.** This will provide you with guidance on limitations and known problems, ensuring a smoother upgrade experience. |
There was a problem hiding this comment.
This should be moved to the recommendations section above. this list is more about current setup. It's the most similar to this item (in the list above):
Before upgrading to Elastic Cloud Enterprise 4.0, refer to the lists of removals to find out about features and API endpoints that are no longer supported.
There was a problem hiding this comment.
Thank you @shainaraskas done the update. can you please kindly check again?
Also, I found we are duplicating the sentence of "before upgrade", where we mentioned that in the beginning of "recommendations" section as Before starting the upgrade process.
I simplified the statement by removing the dup "before upgrading".
FWIW, I also removed "4.0" mention, because known issues, could also happen in 3.x - minor upgrades - we have 3.x things mentioned in details per https://github.com/elastic/cloud/pull/149064 (we still need to backport this to 3.x).
About list of removals, I also removed 4.0 mention, as logically thinking, it's equivalent level as "known issue", and to keep the two entries logically balanced, I removed that.
However, if you think from doc team's perspective we should keep, then please kindly suggest, and I will follow your suggestion accordingly.
Summary
[1]
One thing during I was working on ECE known issue documentation with @rseldner and @hubbleview, we got a common agreement that we should add the link of our ECE known issue into ECE upgrade doc, so that user could have smoother upgrade experience. (There are some popular known issues outstandingly exist in upgrading path to 3.8 and 4)
I wrote up this quick one to achieve the goal.
Internal reference: link
[2]
There are some other cosmetic changes, mainly make the items described in requirements section to aligned in its format: The short piece with bold font.
Generative AI disclosure
Preview / View
Before merge
deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md
After merge
https://www.elastic.co/docs/deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise