Logo
 
 

Upgrading CloudPortal Business Manager

 
 
 
 
The supported upgrade paths to CloudPortal Business Manager (CPBM) are as follows:
  • CPBM versions 1.4.3 through 1.4.7 to CPBM 2.4.x.

    For information on the upgrade steps, refer to the Migration Guide.

  • CPBM 2.1.x to CPBM 2.4.x.
  • CPBM 2.2.x to CPBM 2.4.x.
  • CPBM 2.3.x to CPBM 2.4.x.
Important Notes:
  • From CPBM 2.3.0 onwards, the workflows.xml and transactionWorkflowMap.xml XML files are moved from citrix.cpbm.custom.common bundle to /usr/share/vts3/repository/prop directory. If you have customized these files then you must merge new changes made into these files. New version of these files are saved with ".rpmnew" extension under /usr/share/vts3/repository/prop directory.
  • From CPBM 2.1.1 onwards, a new directory connectors_ext has been created under /usr/share/vts3/ directory. This directory contains the com.citrix.cpbm.connector.ext.plan and the connector-ext.properties file. Customers must deploy their connectors into this directory and edit the appropriate plan. Contents of com.citrix.cpbm.plan and com.citrix.cpbm.connector.plan must not be modified.
  • In CPBM 2.1.0, if you had deployed your own connectors instead of CPBM connectors such as, Apache CloudStack, Accelerite CloudPlatform under the connectors/ directory, then move the deployed connector bundles to the connectors_ext directory and edit the plan appropriately.
    Example:
    1. Move your connector artifact, for example:
      <artifact type="bundle" name="<bundle.artifact.id>" version="[<x.x.x>, <x.x.x>]"/>
      from com.citrix.cpbm.connector.plan located at /usr/share/vts3/connectors and add it to com.citrix.cpbm.connector.ext.plan located at /usr/share/vts3/connectors_ext after the line:
      <artifact type="configuration" name="connector-ext"/>
    2. Copy the connector OSGi service bundle in the Virgo's /usr/share/vts3/connectors_ext directory.
  • As part of the upgrade, the contents of the /usr/share/vts3/patches/ directory is removed because the latest version includes all the fixes. After the upgrade, the /usr/share/vts3/patches/ directory contains the patches.plan along with the patches.properties file. It is recommended that you back up the patches folder before the upgrade.
  • For CPBM 2.4, the supported MySQL server version is 5.6. Therefore, you must first complete the upgrade to MySQL 5.6.
  • For CPBM 2.4, the supported Java version is 1.7. During the upgrade process, select "y" to upgrade to Java 1.7.
Note: Do not delete the patches.properties and connector-ext.properties files.
Prerequisites
  • Before upgrade, if the cloud.properties file contains encrypted values of any property, they must be replaced by the clear-text (or decrypted) values. These properties can be replaced by encrypted values post upgrade. The cloud.properties file path is:
  • Accelerite CloudPlatform management server must be up and running while performing the CPBM upgrade.
  • Make sure that you have taken a backup of CPBM database (DB).
  • If upgrade fails, automatic system rollback is not supported. It is therefore strongly recommended to take the complete Virtual Machine (VM) backup or snapshot of the CPBM server and DB.
  • In a clustered environment, code upgrade must be performed on all the servers, but the DB upgrade (Shell script) must be run only on one of the nodes.
  • Make sure that the cloud-portal service is stopped before the upgrade is performed. In a clustered setup, the cloud-portal service must be stopped on all the nodes before upgrade.
  • If there is any customization done in your setup, then merge your changes with the latest customization code before upgrade. For more information, refer to Installing and building custom components.
Requirements
RequirementVersion
CloudPortal Business Manager (old) 2.1.x (any) or 2.2.x (any) or 2.3.x (any)
CloudPortal Business Manager (new) 2.4.x
Python Default with CentOS (Python 2.6 for CentOS 6.3)
Use the following commands:
yum -y install MySQL-python
yum -y install unzip
yum –y install mysql
if you want to:
  • install the required packages, if they do not exist.
  • update the packages with their respective latest version.
Steps to upgrade CloudPortal Business Manager 2.1.x / 2.2.x / 2.3.x to CloudPortal Business Manager 2.4.x
 
  1. Download the CPBM v2.4.x tar ball from the CPBM download site.
  2. Stop the cloud-portal service on all the active nodes using the command:

    service cloud-portal stop

  3. Go to the console of your DB node and perform the following steps:
  4. Copy and extract the CPBM tar ball in any location, <untar_location>.
    tar -zxvf CloudPortal-2.4.x-centos.tar.gz
  5. cd <untar_location>.
  6. Run the installer using:

    ./install.sh 2>&1 | tee installer.log

    Note: Make sure that you take a backup of CPBM and DB (preferably, the complete CPBM VM).
  7. Read and accept Accelerite End User License Agreement.
  8. From the Installer options available in the menu, select the option D to upgrade to MySQL 5.6.
    Note: For CPBM 2.4, the supported MySQL server version is 5.6. Therefore, you must upgrade to MySQL 5.6.
  9. Follow the instructions that appear in the wizard.
  10. Select the option Q to quit.
  11. Go to the console of your primary node and perform the following steps:
  12. Copy and extract the CPBM tar ball in any location, <untar_location>.
    tar -zxvf CloudPortal-2.4.x-centos.tar.gz
  13. cd <untar_location>
  14. Run the installer using:
    ./install.sh 2>&1 | tee installer.log
    Note: Make sure that you take a backup of CPBM and DB (preferably, the complete CPBM VM).
  15. Read and accept Accelerite End User License Agreement.
  16. From the Installer options available in the menu, select the option U to upgrade.
  17. Follow the instructions that appear in the Upgrade wizard.
    Note: For CPBM 2.4, the supported Java version is 1.7. During the upgrade process, select "y" to upgrade to Java 1.7.
  18. Select the option Q to quit.
  19. Check if any ".rpmsave" or ".rpmnew" file is created under directories "/usr/share/vts3/repository/prop", "/usr/share/vts3/pickup/", "/usr/share/vts3/patches", "/usr/share/vts3/connectors_ext", and "/usr/share/vts3/connectors".

    If the ".rpmnew" file is created for any configuration file, then it means the new CPBM version has some changes in the configuration file and the new file is saved as ".rpmnew" without touching the existing configuration file. In such a case, compare these files to find out the updates and modify the configuration file accordingly.

    If the ".rpmsave" file is created for any configuration file, then it means that the file is being replaced by new CPBM version and the existing file has been saved as ".rpmsave". In such a case, update the configuration file with the changes that you made previously.

    Once the files are merged, you must delete these backup files: ".rpmsave" and ".rpmnew".

  20. Following are the commands for the database upgrade of CPBM, that must be run only once (on any one node in the clustered environment):
    1. If the current version of CPBM is 2.1.x:
      cd <untar_location>/migration/2.4/from/2.1/scripts  ./dbupgrader.sh 2>&1 | tee dbupgrader.log
    2. If current version of CPBM is 2.2.x:
      cd <untar_location>/migration/2.4/from/2.2/scripts  ./dbupgrader.sh 2>&1 | tee dbupgrader.log
    3. If current version of CPBM is 2.3.x:
      cd <untar_location>/migration/2.4/from/2.3/scripts  ./dbupgrader.sh 2>&1 | tee dbupgrader.log
  21. After the steps 9 to 20 are successful, start the CPBM server by using the command:

    service cloud-portal start

  22. In a clustered environment, repeat steps 12 to 18 for each of the secondary nodes (except the DB node).
  23. If the cloud.properties file contains encrypted values of any property then, after the upgrade follow these steps:
    1. Replace these properties by the encrypted values.
    2. Modify the file /etc/init.d/cloud-portal:

      Replace the text ' IS_CLOUD_PORTAL_ENCRYPTED=0 ' with ' IS_CLOUD_PORTAL_ENCRYPTED=1 '

  24. Start the cloud-portal service on each of the secondary nodes using the command:

    service cloud-portal start

    Note: Make sure that the browser cache is cleaned after upgrade.
 
Note: If you have customized the Accelerite CloudPlatform connector UI on any earlier release of CPBM 2.x, and wish to upgrade to 2.4.x, you need to redo the customization using CCP-connector-customization package that has been shipped with 2.4.x and deploy the connector in /usr/share/vts3/custom_connectors.
Note: After upgrading to CPBM 2.4, an account Dashboard displays a fewer number of active subscriptions than before the upgrade. This reduction in number is because in CPBM 2.4 only purchased subscriptions (or subscriptions that are associated with a product bundle) are considered as Active subscriptions, while utility subscriptions are no longer counted as active subscriptions.
 
他にご質問がございましたら、リクエストを送信してください

コメント

 
Adding comment, please wait....

Provide Feedback on Article:

Subject:
Comments:*
Powered by Zendesk