Skip to content

@W-21964600: Document Upgrade Tool path prerequisites #3398

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.

Sign up for GitHub

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

Open
damiancinich wants to merge 1 commit into
base: v4.12
Choose a base branch
from
Open

@W-21964600: Document Upgrade Tool path prerequisites #3398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions modules/ROOT/pages/_partials/upgrade-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The Mule upgrade tool requires the full distribution of the Mule runtime. Ensure
Download the Mule upgrade tool from the https://help.salesforce.com/s/[Salesforce Help Center]. For more information, see https://help.salesforce.com/s/articleView?id=005167229&type=1[How to access MuleSoft Downloads].
* At least 2 GB of available disk space on the file system and access privileges to install the new Mule distribution.
* (For Windows environments) The execution policy for Powershell scripts set to *Unrestricted*.
* Mule distribution paths (`$MULE_HOME` and the new distribution path) that do not contain blank spaces. The upgrade tool does not support paths that contain blank spaces and exits with an error if it detects one.
* If Anypoint Monitoring agent is installed, uninstall it prior to the upgrade.
* Rename the `$MULE_HOME` directory before running the upgrade tool to use a generic name or one that matches the target version. For example, `mule-enterprise-4.9.8`.
+
Expand All @@ -26,19 +27,21 @@ Renaming the directory after running the upgrade tool causes Anypoint Monitoring
// Upgrade Or Update Mule
// tag::UpgradeOrUpdateMule[]
[IMPORTANT]
The parameter `<newMuleDistributionAbsolutePath>` refers to the temporary location where the new Mule runtime distribution is unpacked for the upgrade process. After the upgrade is successfully completed, this location is no longer required by the Upgrade Tool and can be safely deleted.
The parameter `<newMuleDistributionPath>` refers to the temporary location where the new Mule runtime distribution is unpacked for the upgrade process. After the upgrade is successfully completed, this location is no longer required by the Upgrade Tool and can be safely deleted.

To upgrade or update your clustered Mule instances to the latest version:

. Navigate to the `$MULE_HOME/tools` directory, where you downloaded the Mule upgrade tool.
. Run the `upgrade -n` subcommand, specifying as an argument the absolute path of the directory where the latest Mule runtime distribution is downloaded and unpacked, for example:
. Run the `upgrade -n` subcommand, specifying as an argument the path of the directory where the latest Mule runtime distribution is downloaded and unpacked, for example:
+

[source,bash,linenums]
----
$MULE_HOME/tools/upgrade-tool upgrade -n <newMuleDistributionAbsolutePath>
$MULE_HOME/tools/upgrade-tool upgrade -n <newMuleDistributionPath>
----
+
You can provide `<newMuleDistributionPath>` (and the `-o` option) as either an absolute or a relative path. Relative paths are resolved against the directory from which you run the tool.
+
The script outputs the following:
+
----
Expand Down Expand Up @@ -68,7 +71,7 @@ Verifying Mule Agent
INFO: Mule Agent not installed, skipping setup
----

Now that your existing Mule instance is upgraded, you can delete the recently downloaded version (referenced in the example as `<newMuleDistributionAbsolutePath>`) as the upgrade tool does not need it anymore.
Now that your existing Mule instance is upgraded, you can delete the recently downloaded version (referenced in the example as `<newMuleDistributionPath>`) as the upgrade tool does not need it anymore.
// end::UpgradeOrUpdateMule[]

// Roll Back Upgrade Or Update
Expand Down