Upgrade tasks

Run the Upgrade Installer

Instructions for Windows:

1. Unzip the setup.zip file. Go to the directory to which the files have been extracted and run the setup.exe upgrade file.
2. On the Introduction screen, read the information and click Next.
3. Read the license agreement and select I accept the terms of the License Agreement. Click Next to continue with the installation.

4. Verify that you want to upgrade to CSA version 4.80.0002 and click OK.

5. Select the JRE used by CSA.

   • Use OpenJDK JRE if you want to use the JRE that is installed with CSA version 4.80.0002.
   • Use Oracle JRE if you want to use an Oracle JRE. You must manually export the CSA certificate from the existing truststore and import it into the Oracle JRE truststore.

   In this documentation, the directory in which the JRE is installed will be referred to as <csa_jre>.

   For a list of supported JREs, refer to the Support Matrix.

6. Install CSA database components onto the database instance to create the CSA database schema, if it does not exist.

   • Select Yes to install CSA database components and upgrade the CSA database schema, then click Next. When you select this option, the CSA service automatically starts when you exit the installer.
   • Select No if you are using an existing CSA database schema that was created as part of a prior successful installation of CSA version 4.80.0002. When you select this option, you cannot use the installer to deploy sample content, you cannot create a new database schema, and the CSA service does not start when you exit the installer.
   Note: In this version of CSA, Organizations are now stored in the Identity Management component, not in CSA. If you selected Yes during the upgrade, the CSA installer will populate the database and migrate the organizations automatically; however, if you selected No during the upgrade, you will need to populate the database and migrate organizations manually using CSA tools.

   Follow the next steps if you selected No during the upgrade and need to import content into the database and your organizations into the Identity Management componentfor CSA:

   1. Run the SchemaInstallationTool to populate the database.
   2. Run the OrgMigrationTool to migrate organizations from CSA to the Identity Management component.

   3. Run the UCMDBComponentImportTool to import HPE CSA (CI Type based) Components for Sequence Design.

   You can access the SchemaInstallationTool by using the following command:

   Windows:

   • Go to <CSA_HOME>\Tools\SchemaInstallationTool\
   • Run <JAVA_HOME>\bin\java.exe –jar schema-installation-tool.jar

   Linux:

   • Go to <CSA_HOME>/Tools/SchemaInstallationTool/
   • Run <JAVA_HOME>/bin/java –jar schema-installation-tool.jar

   You can access the OrgMigrationTool by using the following command:

   Windows:

   • Go to <CSA_HOME>\Tools\OrgMigrationTool\
   • Run <JAVA_HOME>\bin\java.exe -jar org-migration-tool.jar -c config.properties --csa.home <CSA_HOME> -t json -j <JDBC_DRIVER_JAR>

   Linux:

   • Go to <CSA_HOME>/Tools/OrgMigrationTool/
   • Run <JAVA_HOME>/bin/java –jar org-migration-tool.jar –c config.properties –csa.home <CSA_HOME> -t json –j <JDBC_DRIVER>

   You can access the UCMDBComponentImportTool by using the following command:

   Windows:

   • Go to <CSA_HOME>\Tools\UCMDBComponentImportTool>
   • Run <JAVA_HOME>\bin\java.exe -jar ucmdb-component-import-tool-04.80.000-SNAPSHOT.jar

   Linux:

   • Go to <CSA_HOME>\Tools\UCMDBComponentImportTool>
   • Run <JAVA_HOME>\bin\java -jar ucmdb-component-import

   Post the tool execution, check the components are imported in the CSA UI: /Designs/Sequenced/Components

   Refer to the end of this section for information on how to start and stop the CSA service.

7. Select the environment in which CSA is running and click Next.

   This selection determines the file from which the database instance information is read. For example, if you select standalone, the database instance information is read from the JBoss server's standalone.xml file (%CSA_HOME%\jboss-as\standalone\configuration\standalone.xml). If you select cluster, the database instance information is read from the JBoss server's domain.xmlstandalone-full-ha.xml file (%CSA_HOME%\domain\jboss-as\standalone\configuration\domain.xmlstandalone-full-ha.xml).

8. Verify that you have stopped the CSA services and click OK.

9. Enter the CSA database user password and click Next.

10. If you configured a reporting database user, enter the reporting database user and password and click Next. If you did not configure a reporting database user, click Next.

11. Define the Identity Management component database instance and click Next.

    Field Name	Description
    Identity Management component Database Host	The hostname or IP address of the server where the Identity Management component database is located.
    Identity Management component Database Name	The service name of the database used by Identity Management component.
    Identity Management component Database Port	The Identity Management component database port number. For example, 1433: (Microsoft SQL Server), 1521: (Oracle), 5432: (PostgreSQL).
    Identity Management component Database User Name	The user name of the database user you configured for the Identity Management component database.
    Identity Management component Database Password	The password for the Identity Management component database user.

12. Note
    If you have chosen to upgrade the embedded Operations Orchestration from the previous CSA installation, and the upgrade has failed, you will need to delete the CSA home folder that includes the unfinished installation, then restart the installer and resume the installation.
    Note
    If you have chosen to install a new version of the Embedded OO during the CSA upgrade, and the upgrade fails, do the following:
    • Stop the HPE Operations Orchestration Central service (Windows)
    • Issue the command " OO-install-dir/central/bin/central stop " (Linux)
    • Clear the database schema used for the Operations Orchestration installation
    • Finally, restart the installer and resume installation.

13. Define the Operations Orchestration instance with which CSA is to be integrated. Enter the following information and click Next.

    Field Name	Description
    OO Hostname	The OO Hostname is the This is the fully-qualified domain name or IP address of the server on which Operations Orchestration is located. Specify the host name that was used to generate Operations Orchestration's certificate. The host name is used for TLS validation and to build the URL that the Cloud Service Management Console uses to interact with Operations Orchestration (for example, in the subscription event overview section of the Operations area in the Cloud Service Management Console, selecting the Process ID opens Operations Orchestration to the detailed page of the selected process when these properties are configured). When specifying an IPv6 address, it must be enclosed in square brackets. For example, [f000:253c::9c10:b4b4] or [::1].
    OO Port	The port number used to communicate with Operations Orchestration, such as 8443. The port number is used to build the URL that the Cloud Service Management Console uses to interact with Operations Orchestration. By default, Operations Orchestration uses this port and port 8080. Applications running on the system on which Operations Orchestration is installed should not be using these ports.
    OO User	The name of the user who logs on to Operations Orchestration Central. You should use the admin user. If you followed all the steps documented in the Install Operations Orchestration section, this is the admin user. This is the user that was configured for provisioning topology designs (typically, admin).
    OO Password	The password used by the OO user to log on to Operations Orchestration Central. If you followed all the steps documented in the Install Operations Orchestration section of this guide, use the password cloud.
    OO Certificate File	The file name and location of Operations Orchestration's certificate from Operations Orchestration's truststore on the CSA system. If you have not already done so, export Operations Orchestration's certificate and copy it to the CSA system. See the Install Operations Orchestration section in the Installation Guide or the Initial Setup section in the Upgrade Guide for more information).

    Note This information is used to set the Operations Orchestration properties in the csa.properties file and import Operations Orchestration's certificate into CSA's truststore. See the Configuration Overview for more information about these properties.

14. Enter the OO installation folder. This is the location in which to install the embedded Operations Orchestration.

15. Define the user and port used by the embedded Operations Orchestration. Enter the following information and click Next.

    Field Name	Description
    OO User Name	This is the name of the user used for provisioning topology designs. This user is given the ADMINISTRATOR and SYSTEM_ADMIN roles. The recommended username is admin.
    OO User Password (and Confirm Password)	This is the password used by the embedded Operations Orchestration for the user who provisions topology designs. The recommended password is cloud.
    OO Port	The embedded Operations Orchestration port number, such as 8445. By default, Operations Orchestration uses this port and port 8080. Applications running on the system on which CSA and the embedded Operations Orchestration are installed should not be using these ports.

16. Define the database instance used by the embedded Operations Orchestration. Enter the following information and click Next.

    Field Name	Description
    Database Host: Microsoft SQL Server, Oracle, PostgreSQL	This is the hostname or IP address of the server where the embedded Operations Orchestration database is located.
    Database Port: Microsoft SQL Server, Oracle, PostgreSQL	This is the embedded Operations Orchestration database port number: 1433 : (Microsoft SQL Server) 1521: (Oracle) 5432: (PostgreSQL)
    OO Database Name Oracle OO service name	This is the service (global database) name of the database instance used by the embedded Operations Orchestration.
    OO Database User Name	This is the username of the database user you configured for the Operations Orchestration database.
    OO Database Password	This is the password for the Operations Orchestration database user.

17. A new component called OO Workflow Designer exists in CSA 4.8 which was not there in earlier CSA versions. This requires a separate database schema to be created when upgrading to a new version.

    • On the Workflow Designer screen, configure a Workflow Designer component. Depending on whether you wish to add a new

      database or reuse an existing one, select one of the following options, and click Next.

      • No. I will provide new database information.

      • Yes. Reuse configuration files from an existing node.

    • Based on the option you selected in the previous step, do one of the following:

      • If you chose to provide new database information, specify the following details:

        Field Name	Description
        Database Host: MSSQL, Oracle, or PostgreSQL	The hostname or IP address of the server where the database is located.
        Database Port: MSSQL, Oracle, or PostgreSQL	The database port number. For example, 1433: (Microsoft SQL Server), 1521: (Oracle), 5432: (PostgreSQL).
        Workflow Designer Database Name/ Oracle service name	The name of the database instance on which the CSA database schema will be installed. If you are creating a new CSA database schema, this is the name of the database instance on which the CSA database components will be installed. If you are using an existing CSA database schema that was created as part of a prior successful installation of CSA version 4.80, this is the name of the database instance on which the CSA database schema exists. For an Oracle database, this is the System ID (SID). NOTE The database used by the embedded Workflow Designer must be the same type of database used by CSA (Oracle / Microsoft SQL Server / PostgreSQL) .
        Workflow Designer Database User Name	The user name of the database user you configured for the Workflow Designer database in the Configure (Oracle / Microsoft SQL Server / PostgreSQL) section of this guide (for example, csadbuser).
        Workflow Designer Database Password	The password for the database user.

    • If you chose to provide configuration files from an existing node, select the respective properties files available in an existing Workflow Designer to reuse the configuration values for the new installation by clicking the Choose button and navigating to the respective location of the properties file.

      Following are the parameters representing configuration files on machine with finished installation:

      CSA_HOME/workflow-designer/designer/conf/database.properties

      CSA_HOME/workflow-designer/designer/var/security/secured.properties

      CSA_HOME/workflow-designer/designer/var/security/encryption.properties

      CSA_HOME/workflow-designer/designer/var/security/encryption_repository

      where CSA_HOME is the directory in which CSA is installed.

    • Enter the Workflow Designer Port number click Next. The default port number is 8446.

    • Verify the default endpoint details and click Next.

      You can change the endpoint details by clicking Use a specific endpoint to connect to Workflow Designer, and providing the required details.

      NOTE: By default, there is no need to specify the Workflow Designer component endpoint as it is running on the same machine as HPE Cloud Service Automation. However, in case of a cluster installation, it is possible to connect to the component using a virtual IP (load balancer).

    By default, sample content (service designs and the components and Operations Orchestration flows required by the designs) can be installed with CSA. You can choose to deploy this content during upgrade (making the sample service designs available in the Design area of the Cloud Service Management Console) or deploy the content at a later time (refer to the CSA/Codar Content at a Glance Guide or Cloud Service Automation Configuration Guide for more information).

    To deploy the sample content during the CSA installation process, select Install additional provider integration service designs, components and content and click Next.

    To deploy the sample content at a later time, select Skip content installation and click Next.

    If you choose to skip content installation, you can install the content at a later time by running the Cloud Content Capsule Installer. Refer to the CSA/Codar Content at a Glance Guide or Cloud Service Automation Configuration Guide for more information.

    Note If you chose not to install the database components, this dialog will not display.

18. Review your selections and click Install to complete the upgrade.
19. Review the system information and click Next to continue.
20. Review the system and database information and click Install to complete the upgrade.
21. Click Done to exit the installer.

Instructions for Linux:

1. Log in to the system as the root user.

2. Check the owner and group of $CSA_JRE_HOME/lib/security/cacerts, where <CSA_JRE_HOME> is the directory in which the JRE that is used by CSA is installed..

   If the owner is not csauser or the group is not csagrp, reset the owner or group. For example, enter the following:

   chown csauser:csagrp $CSA_JRE_HOME/lib/security/cacerts

3. Log out as the root user and log in as csauser.

4. Check the values of the CSA_HOME, PS1, and TITLEBAR environment variables. If they are set, verify that they do not contain any escape sequences. If any of these variables contain an escape sequence, the variable causes the installer to fail. Either set the variable to a value that does not contain an escape sequence or change the variable so that is it not set.

5. Source the startup file in which you set the CSA_HOME and PATH environment variables. If you edited RHELinux:.bash_profile, enter the following: RHELinux:..bash_profile

   Linux:.bashrc

6. Copy the CSA upgrade file (setup.bin) to the system and go to the directory in which it has been copied.

7. Verify that setup.bin is owned by csauser and that csauser has full permissions to the file. If necessary, do the following:

   1. Log in as the root user

   2. Enter the following commands:

      chown csauser setup.bin
chmod 755 setup.bin

   3. Log out as the root user and then log in as csauser.

8. Run the setup.bin upgrade file as the csauser.

   Note You must run setup.bin as the csauser. If you install CSA as any other user, you may not be able to run CSA .

   As the csauser, enter the following:

   ./setup.bin

9. Introduction

   Read the Introduction and click enter to continue with the installation.

10. License Agreement

    Read the license agreement. Click enter after reading each page to scroll through the entire agreement.

11. DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT?

    • Select Y and enter to accept the license agreement and continue with the installation.
    • Type N and enter if you do not accept the license agreement and to exit the installation.

12. Stop CSA

    Verify that you have stopped CSA version 4.6x or 4.7x and click enter.

13. CSA Installation Detected

    Select the environment in which CSA is running.
    
    This selection determines the file from which the database instance information is read. For example, if you select standalone, the database instance information is read from the JBoss server's standalone.xml file ($CSA_HOME/jboss-as/standalone/configuration/standalone.xml). If you select cluster, the database instance information is read from the JBoss server's domain.xmlstandalone-full-ha.xml file ($CSA_HOME/jboss-as/standalone/configuration/domain.xmlstandalone-full-ha.xml).The installer detects if you are upgrading a remote installation of the Marketplace Portal. Click enter to continue.

14. Select appropriate JRE

    • Select the JRE used by CSA and click Enter.
      
      
    • Select OpenJDK JRE if you want to use the JRE that is installed with CSA version 4.80.0002.
      
      
    • Select Oracle JRE if you want to use an Oracle JRE . Then, select the location in which you installed this JRE. You must manually export the CSA certificate from the existing truststore and import it into the Oracle JRE truststore.
      
      In this documentation, the directory in which the JRE is installed will be referred to as <csa_jre>.
      
      For a list of supported JREs, refer to the Cloud Service Automation System and Software Support Matrix Guide.

    Guides are available on the HPE Software Support web site at: https://softwaresupport.hpe.com (this site requires a Passport ID). Select Dashboards > Manuals.

    cannot use the existing JRE.

    Note: Use the existing JRE to continue using the JRE that was used with your previous CSA version. No additional configuration is required if you use the existing JRE

15. CSA Installation Detected

    Verify the database instance information and click enter.
    
    If the upgrade installer could not find the database instance information, a message is displayed and you will need to re-enter the database information. Continue to the next screen to re-enter the database information and click enter to continue.

16. CSA Database User Password

    Enter the CSA database user password and click enter.

17. Reporting User

    Enter the CSA reporting database user and click enter. If you did not configure a reporting database user, click enter to continue.

    If you entered a reporting database user, enter the CSA reporting database user password and click enter. If you did not enter a reporting database user, this option is not available.

18. Install Database Components?

    Type 1 (Yes) to install CSA database components and upgrade the CSA database schema then click enter.

19. Operations Orchestration Configuration

    Note
    If you have chosen to upgrade the embedded Operations Orchestration from the previous CSA installation, and the upgrade has failed, you will need to delete the CSA home folder that includes the unfinished installation, then restart the installer and resume the installation.
    Note
    If you have chosen to install a new version of the Embedded OO during the CSA upgrade, and the upgrade fails, do the following:
    • Stop the HPE Operations Orchestration Central service (Windows)
    • Issue the command " OO-install-dir/central/bin/central stop " (Linux)
    • Clear the database schema used for the Operations Orchestration installation
    • Finally, restart the installer and resume installation.

20. Define the Operations Orchestration 10.50 instance with which CSA is to be integrated. Enter the following information (select Enter after each entry).

    1. Enter the Operations Orchestration hostname.

       This is the fully-qualified domain name or IP address of the server on which Operations Orchestration is located. Specify the host name that was used to generate Operations Orchestration's certificate.

       The host name is used for TLS validation and to build the URL that the Cloud Service Management Console uses to interact with Operations Orchestration (for example, in the subscription event overview section of the Operations area in the Cloud Service Management Console, selecting the Process ID opens Operations Orchestration to the detailed page of the selected process when these properties are configured).
       
       When specifying an IPv6 address, it must be enclosed in square brackets. For example, [f000:253c::9c10:b4b4] or [::1].

    2. Enter the Operations Orchestration port. This is the port number used to communicate with Operations Orchestration, such as 8443. The port number is used to build the URL that the Cloud Service Management Console uses to interact with Operations Orchestration. By default, Operations Orchestration uses this port and port 8080. Applications running on the system on which Operations Orchestration is installed should not be using these ports.
    3. Enter the Operations Orchestration user. This is the name of the user who logs on to Operations Orchestration Central. You should use the admin user. If you followed all the steps documented in the Install Operations Orchestration section, this is the admin user. This is the user that was configured for provisioning topology designs (typically, admin).
    4. Enter the Operations Orchestration password. This is the password used by the OO user to log on to Operations Orchestration Central. If you followed all the steps documented in the Install Operations Orchestration section of this guide, use the password cloud.
    5. Enter the Operations Orchestration certificate file. This is the file name and location of Operations Orchestration's certificate from Operations Orchestration's truststore on the CSA system. If you have not already done so, export Operations Orchestration's certificate and copy it to the CSA system. See the Install Operations Orchestration section in the Installation Guide or the Initial Setup section in the Upgrade Guide for more information).

    Note This information is used to set the Operations Orchestration properties in the csa.properties file and import Operations Orchestration's certificate into CSA's truststore. See the Configuration Overview for more information about these properties.

21. Operations Orchestration Installation Folder

    Enter the Operations Orchestration installation folder. This is the location in which to install the embedded Operations Orchestration.

22. Operations Orchestration Database Configuration

    Configure the database instance used by the embedded Operations Orchestration. Enter the following information (select Enter after each entry).

    1. Enter the database hostname. This is the hostname or IP address of the server where the embedded Operations Orchestration database is located.
    2. Enter the database port. This is the embedded Operations Orchestration database port number. For example, 1433: (Microsoft SQL Server), 1521: (Oracle), 5432: (PostgreSQL).
    3. Enter the Operations Orchestration database name or Oracle Operations Orchestration service name. This is the service (global database) name of the database instance used by the embedded Operations Orchestration.
    4. Enter the database username. This is the username of the database user you configured for the Operations Orchestration database.
    5. Enter the database password. This is the password for the Operations Orchestration database user.

23. Operations Orchestration Port

    Enter the embedded Operations Orchestration port number, such as 8445. By default, Operations Orchestration uses this port and port 8080. Applications running on the system on which CSA and the embedded Operations Orchestration are installed should not be using these ports.

24. Operations Orchestration User

    Enter the Operations Orchestration user. This is the name of the user used for provisioning topology designs. This user is given the ADMINISTRATOR and SYSTEM_ADMIN roles. The recommended username is admin.

25. Operations Orchestration Password and Confirm Password

    Enter the Operations Orchestration password. This is the password used by the embedded Operations Orchestration for the user who provisions topology designs. The recommended password is cloud.

26. Pre-Installation Summary

    Review your selections and click enter to complete the installation or ctrl-c to exit the installation.

27. A new component called OO Workflow Designer exists in CSA 4.8 which was not there in earlier CSA versions. This requires a separate database schema to be created when upgrading to a new version.

28. On the Workflow Designer screen, configure a Workflow Designer component. Depending on whether you wish to add a new database or reuse an existing one, select one of the following options, and click Next.
    On the Workflow Designer screen, configure a Workflow Designer component. Depending on whether you wish to add a new database or reuse an existing one, select one of the following options, and click Next.

    • Option 1: No. I will provide new database information.

    • Option 2: Yes. Reuse configuration files from an existing node.

      Enter a comma separated list of number for selecting the required choice OR select the default.

      If this is standalone installation or first installation of clustered instance just hit Enter to choose default option which is option 1.

      In case of clustered installation choose option 2.

29. 1. Based on the option you selected in the previous step, do one of the following:

       • If you chose to provide new database information, specify the following details:

       • Field Name	Description
         Database Host: MSSQL, Oracle, or PostgreSQL	The hostname or IP address of the server where the database is located.
         Database Port: MSSQL, Oracle, or PostgreSQL	The database port number. For example, 1433: (Microsoft SQL Server), 1521: (Oracle), 5432: (PostgreSQL).
         Workflow Designer Database Name/ Oracle service name	The name of the database instance on which the CSA database schema will be installed. If you are creating a new CSA database schema, this is the name of the database instance on which the CSA database components will be installed. If you are using an existing CSA database schema that was created as part of a prior successful installation of CSA version 4.80, this is the name of the database instance on which the CSA database schema exists. For an Oracle database, this is the System ID (SID). NOTE The database used by the embedded Workflow Designer must be the same type of database used by CSA (Oracle / Microsoft SQL Server / PostgreSQL) . Default: ooddb
         Workflow Designer Database User Name	The user name of the database user you configured for the Workflow Designer database in the Configure (Oracle / Microsoft SQL Server / PostgreSQL) section of this guide (for example, csadbuser). Default: oouser
         Workflow Designer Database Password	The password for the database user.

       • If you chose to provide configuration files from an existing node, select the respective properties files available in an existing Workflow Designer to reuse the configuration values for the new installation by clicking the Choose button and navigating to the respective location of the properties file.

       Following are the parameters representing configuration files on machine with finished installation:

       CSA_HOME/workflow-designer/designer/conf/database.properties

       CSA_HOME/workflow-designer/designer/var/security/secured.properties

       CSA_HOME/workflow-designer/designer/var/security/encryption.properties

       CSA_HOME/workflow-designer/designer/var/security/encryption_repository

       where CSA_HOME is the directory in which CSA is installed.

    2. Enter the Workflow Designer Port number click Next. The default port number is 8446.
       

    3. Verify the default endpoint details and click Next.

       You can change the endpoint details by clicking Use a specific endpoint to connect to Workflow Designer, and providing the required details.

       NOTE: By default, there is no need to specify the Workflow Designer component endpoint as it is running on the same machine as HPE Cloud Service Automation. However, in case of a cluster installation, it is possible to connect to the component using a virtual IP (load balancer).
30. When the installation completes, click enter to exit the installer.

31. Upgrade the CSA services to start and stop the CSA process and the Marketplace Portal process.

    1. Log in as the root user.

    2. Remove the old version of the CSA scripts. Enter the following:

       rm /etc/init.d/csa
rm /etc/init.d/mpp

    3. Go to the directory in which CSA is installed. For example:

       cd /usr/local/hpe/csa

    4. Copy the new scripts to the /etc/init.d directory. Enter the following:

       cp ./scripts/csa /etc/init.d
cp ./scripts/mpp /etc/init.d
cp ./scripts/elasticsearch /etc/init.d

    5. Change permissions of the scripts. Enter the following:

       chmod 755 /etc/init.d/csa
chmod 755 /etc/init.d/mpp
chmod 755 /etc/init.d/elasticsearch