gemmellr commented on code in PR #4246: URL: https://github.com/apache/activemq-artemis/pull/4246#discussion_r1010462981
########## docs/user-manual/en/upgrading.md: ########## @@ -48,3 +48,23 @@ most cases_ the instance can be upgraded to a newer version simply by changing the value of this property to the location of the new broker home. Please refer to the aforementioned [versions](versions.md) document for additional upgrade steps (if required). + +It is also possible to do these steps automatically as it can be seen in the next section. + +## Upgrading tool + +An automatic approach can be used to upgrade the instance. You may simply call `./artemis upgrade <old-instance>`. + +```shell +cd $NEW_ARTEMIS_DOWNLOAD/bin/ +./artemis upgrade PATH_TO_UPGRADING_INSTANCE +``` + +artemis, artemis.profile will be updated to the new version. + +The tool will also update log4j2.properties (if you are migrating from a version previous to 2.27.0). + +> **Note:** +> +>to avoid removing eventual user's customizations, the upgrade process won't automatically bring new additions to the scripts itself. Please compare your artemis and artemis.profile to newer versions after the upgrade. Review Comment: I think this is over-selling the 'automation', given the note at the end. The description here isnt clear as to what it will do. I think a user will struggle to know what this means until trying it and finding it doenst necessarily do what they expected. To have a new version file to compare with, a user would still also need to 'artemis create' a new separate broker instance to see its config, but now thats in addition to running the 'artemis upgrade' command on their existing one to take care of some of the updates, but not others. This isnt all that clear from the 'upgrade' name for the command, or this documentation. That was one good thing about the previous 'create new files' approach. Theyd already have the new file, and theyd have their backed up old file to compare it with and find/port port their own modifications across if needed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
