Upgrade Using Command Central

Supported Upgrade Scenarios

To see which products support upgrade/migration using Command Central, see Software AG Command Central Feature Support Matrix.

Same Installation Directory, Hosts, and Ports; Live Database

Command Central renames the old product installation directory, then uses the old directory name for the new product installation.

Benefits: Simple; similar to overinstall in that all paths, hosts, and ports remain the same. Can fully automate using custom composite templates.

Cautions: Risky; rollback is complicated. Significant downtime. Must back up live databases; use of cloned databases is not supported. Requires double disk space because old installation is still present. Requires extensive automated testing before production environments can be migrated.

Command Central provides templates you can use for this scenario on GitHub at https://github.com/SoftwareAG/sagdevops-templates/tree/master/templates/

New Installation Directory, Same Hosts and Ports, Cloned Database

Benefits: New installation is almost identical to old. Safer than first scenario; rollback is much simpler. Can start old installation after shutting down new installation, and vice versa. Can fully automate using custom composite templates or can perform step by step using a combination of the Command Central web user interface and commands.

Cautions: Requires double disk space because old installation is still present. Must adjust third-party tooling to point to new installation directory.

New Installation Directory and Ports, Same Hosts, Cloned Database

Benefits: Safer than first scenario; rollback is much simpler. Downtime is less than first and second scenarios; can migrate gradually while old installation continues to operate. Can fully automate using custom composite templates.

Cautions: Preparation for migration is more complex than first and second scenarios. Requires double disk space because old installation is still present. Must change endpoints to reflect new ports. Must adjust third-party tooling to new installation.

New Hosts, Live or Cloned Database

Typically required because of upgrades to hardware and operating systems. Use of same installation directory and ports can minimize change. Use of DNS to control IP-to-host mapping for the old and new environment can greatly simplify impact on external clients.

Benefits: Safest scenario, and minimal downtime. Easiest scenario when environment runs in a private or public cloud that allows temporary increase of capacity to host new environment and then release resources used by old environment. Can phase migration. Must adjust third-party tooling to new installation. Can fully automate using custom composite templates or can perform step by step using a combination of the Command Central web user interface and commands.

Cautions: Some products allow cross-operating system migration, but for other products, this type of migration might have unpredictable results, especially when old machine is Windows and new machine is non-Windows, or vice versa.

Upgrade Approaches

  • If you want to upgrade products in a single environment using Command Central, follow the instructions in this chapter. If you are not using software stacks, you can watch a demo relating to upgrade in the Command Central area of the Software AG TECHcommunity website. You can also read an article on generating keystores and certificates for Command Central in the same area. You can read articles and watch webinars about upgrading with Command Central on the Software AG TECHcommunity website.
  • If you want to fully automate product upgrade for multiple similar environments using Command Central, see the composite template instructions in Software AG Command Central Help. You can reconfigure endpoints such as host names and ports by adding actions in the templates. You will still need to perform the manual tasks in the other chapters in this guide if you cannot script them.
  • If you want to simplify upgrade now and in the future, you can use Command Central software stacks, as the upgrade procedure for stacks is simpler than the procedure for standalone product installations. A software stack is a set of product runtimes and related database components that serve one or more purposes, such as application integration, API management, or business process management. Software stacks enable you to use Command Central to create, monitor, and maintain multiple product installations using bulk operations. The stack upgrade feature is available in the Command Central GUI and lets you automatically generate composite templates that you can then use to upgrade a single environment or to automate the upgrade of multiple environments. Follow the instructions for upgrading software stacks in this chapter.

Upgrade Products in a Single Environment

Read all chapters in this guide to understand all information and tasks beyond Command Central, such as cluster upgrade guidelines, preparing the old installation, and manual tasks that need to be performed after data migration.

Follow the instructions in Software AG Command Central Help to install your new products and fixes, install fixes on your old products, shut down the old products, and create ZIP files of the old installations to use as sources for cross-host migration.

The preparation steps for the old Integration Server or Microservices Runtime include suspending and draining triggers. You can perform this task from Command Central.

Use the Command Central command sagcc exec administration to migrate database components. The command syntax is shown below. The parameters are the parameters you use when running the Database Component Configurator and are documented in Installing Software AG Products. To check the progress of the migration in Command Central, click Jobs on the Command Central web user interface.

sagcc exec administration product DCC_node_alias DatabaseComponentConfigurator
database migrate [parm1=value1 ] [parm2=value2 ]...

In the examples below, the database components are on a SQL Server RDBMS at jdbc:wm:sqlserver://DBserver:1433;databaseName=TESTDB, and the database user is webmuser with password webmpass.

  • To upgrade Integration Server database components from 9.9 to the latest release:
    sagcc exec administration product local DatabaseComponentConfigurator
    database migrate db.type=sqlserver product=IS version=latest
    db.username=webmuser db.password=webmpass db.name=TESTDB
    db.url=“jdbc:wm:sqlserver://DBserver:1433;databaseName=TESTDB”
  • To upgrade the My webMethods Server database components from 9.9 to the latest release:

    sagcc exec administration product local DatabaseComponentConfigurator
    database migrate db.type=sqlserver component=MWS version=latest
    db.username=webmuser db.password=webmpass db.name=TESTDB
    db.url=“jdbc:wm:sqlserver://DBserver:1433;databaseName=TESTDB”

Use the commands below to migrate the product configurations, data, and assets.

Product Migration Command
Application Platform (Deprecated)
sagcc exec administration product target_node_alias 
PLSCore migration migrate
{srcDir|srcFile}=full_path_to_{old_Software AG_directory|ZIP file}
Digital Event Services
sagcc exec administration product target_node_alias 
DEVRuntime migration migrate
{srcDir|srcFile}=full_path_to_{old_Software AG_directory|ZIP file}
Integration Server or Microservices Runtime and Hosted Wm Packages Command

If you want to run a custom migration, first run the migration utility manually, and then specify the resulting migrate.dat file on the importFile parameter. If you are upgrade on the same machine and you want to migrate all instances, do not specify the instanceName parameter. If you are upgrade Integration Server on a new machine, migrate one instance at a time to avoid causing concurrency issues with your database.

sagcc exec administration product target_node_alias 
integrationServer migration migrate
{srcDir|srcFile}=full_path_to_{old_Software AG_directory|ZIP file}
[importFile=full_path_to_migrate.dat]
[instanceName=name [newInstanceName=name]]
[cloneDbURL=URL cloneDbUser=user cloneDbPassword=password]
My webMethods Server

If you want to run a custom migration, first run the migration utility manually, and then specify the resulting migrate.dat file on the importFile parameter. If you want to migrate all instances, do not specify the instanceName parameter.

sagcc exec administration product target_node_alias 
MwsProgramFiles migration migrate
{srcDir|srcFile}=full_path_to_{old_Software AG_directory|ZIP file}
[importFile=full_path_to_migrate.dat]
[instanceName=name[,name...]]
[newNodeName=instance_name:new_node_name[,instance_name:new_node_name...]]
[cloneDbURL=URL cloneDbUser=user cloneDbPassword=password]
Note: If you migrate the instances, and then have to re-run the migration later for some reason, Command Central handles the re-migration differently than the migration utility. If migrated instances in the new installation have the same name as old instances, the utility deletes the migrated instances and then re-migrates the old instances. Command Central, conversely, skips the migrated instances and only re-migrates old instances that do not yet exist in the new installation.
Universal Messaging

If you want to run a custom migration, first run the migration utility manually, and then specify the resulting migrate.dat file on the importFile parameter. If you want to migrate all instances, do not specify the instanceName parameter.

sagcc exec administration product case_sensitive_target_node_alias 
NUMRealmServer migration migrate
{srcDir|srcFile}=full_path_to_{old_Software AG_directory|ZIP file}
[importFile=full_path_to_migrate.dat]
[instanceName=name[,name...]]

Upgrade Products Using Software Stacks (10.1 and Later)

You can upgrade Command Central software stacks using this procedure, or you can create stacks from existing product installations managed by Command Central and then upgrade them using this procedure.

For more information, go to https://tech.forums.softwareag.com/t/announcing-one-click-upgrades-for-webmethods/242399 on the Software AG TECHcommunity website. You can find videos on upgrading using stacks on Youtube; search on "Software AG Command Central" to find videos from which to choose.

  1. Complete the tasks in Prepare for Upgrade and the Prepare the Old Installation sections in the product-specific chapters in this guide.
  2. Install the new release of Command Central and then open Command Central using instructions in Software AG Command Central Help).
  3. Upgrade from 10.1: Install wmFix.SPM 17 and wMFix.SDRepository 9 on the Platform Manager of each installation you are upgrading. If the stack includes a database layer, install wMFix.DatabaseComponentConfigurator 3 on Database Component Configurator.

    Upgrade from 10.3: Install wmFix.SPM 12 on the Platform Manager of each installation you are upgrading. If the stack includes a database layer, install wMFix.DatabaseComponentConfigurator 6 on Database Component Configurator.

    For instructions on installing fixes, see Software AG Command Central Help.

  4. If the installations you want to upgrade currently exist as standalone installations, create stacks from those installations. To do so, you will identify installations to Command Central, and Command Central will create one stack for each set of installations that are the same release, are installed on the same operating system and in a directory of the same name, and whose Platform Manager uses the same port and protocol (HTTP or HTTPS).
    Note: An installation can be part in only one stack. If an installation is already part of an existing, therefore, it will not be added to the new stack.
    1. Go to Environments, click the environment that contains the installations from which to create stacks, click at the bottom right of the Environments pane, and then click Auto-create stacks.
    2. In the Auto-create stacks dialog box, in the Product releases drop down, click the release of the installations from which to create stacks or click ALL.

      By default, Command Central will name the stacks 1, 2, 3, and so on. In the Stack prefix field, specify a prefix for those names that will help you better identify the stacks later.

    3. Click OK to create the stacks.
    4. If you need a database layer in a stack, add it manually.
    5. If you do not want to include a particular layer in a stack, delete it.
  5. Command Central needs its bootstrapper to install Platform Manager in the new product installation. Follow the instructions in your installation email from Software AG to download the bootstrapper of the new release for your operating system. Store the bootstrapper in the Command Central_directory/profiles/CCE/data/installers directory.
  6. If you are going to install the new products on UNIX or Windows operating systems, make sure the target machines have a Secure Shell (SSH) server running and the system is configured for remote access with the user account for your products. For Windows, the table below explains the next action to take.
    If your Windows release... Take this action...
    Has out-of-the-box SSH support Use the default SSH server on the Windows machine
    Does not support SSH by default Set up OpenSSH on the Windows machine using a third-party tool such as Cygwin. For information about how to install Cygwin, go to https://cygwin.com/install.html or follow the instructions in the Using Cygwin to Configure OpenSSH When Installing Platform Manager on a Remote Windows Machine article located on Software AG TECHcommunity.
  7. Create product and fix repositories for the new product release, import product license keys, and register any necessary credentials for the target machines. For instructions, see Software AG Command Central Help.
  8. Depending on whether Command Central uses HTTP or HTTPS to connect to the Platform Manager installations from the infrastructure layer of the stack, ensure that the next port number or the one preceding it is free.
    • If Command Central uses HTTP to connects to а Platform Manager, make sure that this port number incremented by one is free. For example, if Command Central uses port 8092 to connect to а Platform Manager, ensure that port 8093 is free.
    • If Command Central uses HTTPS to connect to а Platform Manager, make sure that this port number decremented by one is free. For example, if Command Central uses port 8093 to connect to а Platform Manager, ensure that port 8092 is free.
    Note:

    You must keep this additional port free only during the stack upgrade.

  9. Upgrade the stack as described below.
    1. Click Stacks at the top of the GUI.
    2. On the stack to upgrade, click, click Upgrade stack, click the type of upgrade to perform, and provide the requested values.
    3. Click Dry run at the bottom of the configuration page. Command Central generates a composite template for each runtime component in the stack.
    4. You might want or need to edit the generated templates for reasons such as the following:
      • To reflect changes, deprecations, and removals specified in the product readmes.
      • Command Central indicates that a product in a template does not exist in the repositories for the new release, so you need to remove the product entry from the template or specify the replacement product.
      • Upgrade from 10.1 or 10.3: The stack contains a database layer, which means you need to copy the database product IDs from the database scripts section to the products section.

      To edit the generated templates:

      1. Click Templates at the top of the GUI. You will see a list of templates named migration_generated_stack_name.
      2. Download a template and edit with a text editing tool.
      3. Click to import the template.
      4. Repeat the steps above for other templates as necessary.
      5. Click Stacks again, click, click Upgrade stack again, and choose to use existing templates.
    5. When the generated templates are ready, you can perform the upgrade by clicking Upgrade stack at the bottom of the configuration page, or you can use the templates in automated upgrades.

  10. Complete the product upgrades as explained in the product-specific chapters in this guide.