Home Roles: Suite Mgmt suite_upgrade Role Variables Example Playbook

suite_upgrade¤

This role validates if a given MAS installation is ready for the core platform to be upgraded to a specific subscription channel, and (as long as dry run mode is not enabled) will execute the upgrade.

• It will validate that the current subscription channel is able to be upgraded to the target channel.
• It will validate that all installed applications have already been upgraded to versions compatible with the new version of the Core Platform.
• It will upgrade the MAS core platform to the desired channel (as long as dry run is not enabled).
• It will validate that the core platform has been successfully reconciled at the upgraded version.
• It will not validate that all core services successfully deploy after the reconcile (but we will be working on this limitation).

Role Variables¤

mas_instance_id¤

The ID of the MAS instance to upgrade.

• Required
• Environment Variable: MAS_INSTANCE_ID
• Default: None

mas_channel¤

The name of the MAS subscription channel that you want to upgrade to, if not provided the correct version to upgrade to will be automatically selected based on the current version of MAS installed.

• Optional
• Environment Variable: MAS_CHANNEL
• Default: None

mas_upgrade_dryrun¤

When set to true will ensure that the role only preforms upgrade validation checks and does not make any changes to the target installation.

• Optional
• Environment Variable: MAS_UPGRADE_DRYRUN
• Default: False

skip_compatibility_check¤

When set to true will skip compatibility check before the upgrade install. By default, compatibility check will be performed to validate the specific target mas_channel is valid or not based on the existing mas version.

• Optional
• Environment Variable: SKIP_COMPATIBILITY_CHECK
• Default: False

Example Playbook¤

Automatic Target Selection¤

Running this playbook will upgrade MAS to the next release. If you run this playbook when you are already on the latest release then it will take no action.

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_instance_id: instance1
    mas_upgrade_dryrun: False
  roles:
    - ibm.mas_devops.suite_upgrade_check

Explicit Upgrade Target¤

Running this playbook will attempt to upgrade MAS to the specified release. If the specified release cannot be upgraded to from the installed version of MAS then no action will be taken.

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_instance_id: instance1
    mas_channel: 8.8.x
    mas_upgrade_dryrun: False
  roles:
    - ibm.mas_devops.suite_upgrade_check