foliolib.helper.platform.upgrade_platform

foliolib.helper.platform.upgrade_platform(platform: str, tenantid: str, node: str = None, deploy_async: bool = False, unsecure_okapi=False, install_new=False, loadSample: bool = False, loadReference: bool = False, exclude: list = None, uninstall: list = False, preupgrade: list = None, **kwargs)

Upgrade a folio tenants to a new platform.

It is recommended to unsecure okapi before upgrading.

It may be necessary to upgrade okapi before.

Parameters

  • platform (str) – Path to the folder of the folio platform.

  • tenantid (str) – tenant id. (‘all’ for all tenants.)

  • node (str) – The node id on which module should be deployed. Default first node from nodes list.

  • deploy_async (bool, optional) – Wether to deploy asynchronously. Defaults to False.

  • unsecure_okapi (bool, optional) – Wether to unsecure okapi before upgrade. Default to False.

  • install_new (bool, optional) – Wether to install new modules from the release. Default to False.

  • loadSample (bool, optional) – load samples for new installed modules. Defaults to False.

  • loadReference (bool, optional) – load example reference data for new installed modules. Defaults to False.

  • exclude (list, optional) – Exclude module from upgrade, e.g. mod-remote-storage.

  • uninstall (list, optional) – List of module names, e.g. [mod-remote-storage]. Uninstall modules before upgrade. Default to None.

  • preupgrade (list, optional) – List of module names, e.g. [mod-users]. Upgrade module before other modules upgraded. Default to None.

  • **kwargs (properties) – Keyword Arguments

Keyword Arguments

  • ignoreErrors (boolean) – default = false Okapi 4.2.0 and later, it is possible to ignore errors during the install operation. This is done by supplying parameter ignoreErrors=true. In this case, Okapi will try to upgrade all modules in the modules list, regardless if one of them fails. However, for individual modules, if they fail, their upgrade will not be commited. This is an experimental parameter which was added to be able to inspect all problem(s) with module upgrade(s).

  • invoke (boolean) – default = true Whether to invoke for tenant init/permissions/purge

  • npmSnapshot (boolean) – default = true Whether to include NPM module snapshots (default:true).

  • preRelease (boolean) – default = true Whether pre-releases should be considered for installation.

  • purge (boolean) – default = false Disabled modules will also be purged.

  • reinstall – (boolean - default: false) Whether to install modules even if up-to-update.

  • simulate (boolean) – default = false Whether the installation is simulated