[
https://issues.apache.org/jira/browse/ARTEMIS-4020?focusedWorklogId=822384&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-822384
]
ASF GitHub Bot logged work on ARTEMIS-4020:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 01/Nov/22 16:08
Start Date: 01/Nov/22 16:08
Worklog Time Spent: 10m
Work Description: 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.
Issue Time Tracking
-------------------
Worklog Id: (was: 822384)
Time Spent: 15h 40m (was: 15.5h)
> switch to using SLF4J for logging API and use Log4j 2 for broker distribution
> -----------------------------------------------------------------------------
>
> Key: ARTEMIS-4020
> URL: https://issues.apache.org/jira/browse/ARTEMIS-4020
> Project: ActiveMQ Artemis
> Issue Type: Improvement
> Reporter: Robbie Gemmell
> Assignee: Robbie Gemmell
> Priority: Major
> Fix For: 2.27.0
>
> Time Spent: 15h 40m
> Remaining Estimate: 0h
>
> Switch to using [SLF4J|https://www.slf4j.org/] as the logging API for the
> code base, with end-uses supplying and configuring an SLF4J-supporting
> logging implementation of their choice based on their needs.
> For the client, applications will need to supply an SLF4J binding to a
> logging implementation of their choice to enable logging. An example of doing
> so using [Log4J 2|https://logging.apache.org/log4j/2.x/manual/index.html] is
> given in (/will be, once the release is out) the [client logging
> documentation|https://activemq.apache.org/components/artemis/documentation/latest/logging.html#logging-in-a-client-application].
> For the broker, the assembly distribution will include [Log4J
> 2|https://logging.apache.org/log4j/2.x/manual/index.html] as its logging
> implentation, with the "artemis create" CLI command used to create broker
> instances now creating a log4j2.properties configuration within the
> <broker-instance>/etc/ directory to configure Log4J. Details for upgrading an
> existing broker-instance is given in (/will be, once the release is out) the
> [version upgrade
> documentation|https://activemq.apache.org/components/artemis/documentation/latest/versions.html].
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
