Initial setup

Before you run the upgrade installer, the following steps must be completed.

1. The following files must be manually backed up outside of CSA_HOME (these files are not automatically restored nor backed up by the upgrade installer):

   • CSA_HOME\openjre\lib\security\cacerts
   • CSA_HOME\openjre\lib\security\java.security
   • The keystore file defined by the certificate-key-file property of the connector attribute in CSA_HOME\jboss-as\standalone\configuration\standalone.xml if you are not using the default keystore file (the default keystore file is automatically backed up and restored)

   • Any .jar files used by dynamic query scripts. Any Java server page (.jsp) files created for the Codar dashboard and saved in a directory within the Codar 1.50 or 1.60 installation but not in a directory whose content is backed up by the upgrade installer (the directory where the Codar Console expects to find these files is defined in the CSA_HOME\jboss-as\standalone\deployments\csa.war\dashboard\config.json configuration file.

2. You MUST back up all files that you have created, customized, or manually installed in the CSA_HOME installation directory that are not automatically restored or backed up by the upgrade installer. See Customized files affected by upgrade for a list of customized files and the action performed during the upgrade. These files should be backed up outside of CSA_HOME.

   You must back up these files to preserve them. While the upgrade installer will back up some files and directories, it does not back up all files and directories. If the upgrade installer fails before it backs up the selected files and directories, these files and directories may be deleted or corrupted.

   Examples of files that you may have created, customized, or manually installed that may not be automatically backed up include custom graphic files, Oracle JDBC drivers, and jar files used by custom widgets or dynamic query scripts.

   Note If you are not sure which files may have been created, customized, or manually installed in the Codar installation directory, back up the entire CSA_HOME directory.

   Caution Back up files outside of CSA_HOME. The existing Codar installation directory and all of its contents are deleted during upgrade.

   Caution Do not remove any directories in CSA_HOME. Doing so may cause the upgrade to fail.

3. Back up the database.

   Caution If the upgrade installer fails, the database may be corrupted.

4. If it exists, back up the registry file (outside of CSA_HOME).

   Windows
   The registry file name and location is C:\Program Files\Zero G Registry\.com.zerog.registry.xml.

   Linux
   The registry file name and location is /home/codaruser/.com.zerog.registry.xml or /var/.com.zerog.registry.xml.

   Caution If the upgrade installer fails, the registry file may be corrupted or deleted.

5. On Linux, if you mounted a file system within the Codar installation directory (for example, within CSA_HOME), you must unmount the file system. The upgrade installer cannot remove the mounted file system during the upgrade.

   Caution The upgrade will fail if you do not unmount the file system.

6. Create a database instance, user, and schema for the Identity Management component. Work with the database administrator to do the following (or refer to the manufacturer’s documentation for more information):

   Caution On Windows, the database name and user name cannot contain more than one dollar sign symbol ($). For example, c$adb is a valid name but c$$adb and c$ad$b are not valid names.

   1. Create a database instance that is used by the Identity Management component.
   2. Create a schema for the Identity Management component by creating a database user (for example, codaridmdbuser).

   3. Create a role for this Codar database user (for example, codaridmdbrole) and grant the following privileges to the role:

      • CREATE SESSION
      • CREATE TABLE
      • CREATE VIEW
      • CREATE SEQUENCE
      • CREATE ANY SYNONYM
      • UNLIMITED TABLESPACE
   4. Grant the role to the database user.
   5. Alter the database user by setting this role as the user's default role.

   For example, run the following commands to create the codaridmdbrole role and codaridmdbuser user:

   Create user codaridmdbuser identified by codaridmdbuser;
   Create role codaridmdbrole;
   Grant CREATE SESSION, CREATE TABLE, CREATE VIEW, CREATE SEQUENCE,
   CREATE ANY SYNONYM, UNLIMITED TABLESPACE to codaridmdbuser;
   Grant codaridmdbrole to codaridmdbuser;
   Alter user codaridmdbuser default role codaridmdbrole;

   You must provide this database's SID, database user name and, user's password when prompted for the Identity Management component database information during the upgrade of Codar.

7. Stop Codar:

   Windows

   1. Open a command prompt and navigate to CSA_HOME\jboss-as\bin.

   2. Run the following command:

      jbosscli.bat connectcommand=:shutdown

   3. Close the command prompt.

   4. Navigate to Start > Administrative Tools > Services.

   5. Close the Control Panel.

   Linux

   1. Open a command prompt.

   2. Run the following command:

      service codar stop
      

   3. Close the command prompt.

8. Verify that you have upgraded to the latest versions of software components required for Codar version 1.80. For example, for some resource providers, you may need to install a hotfix or service pack. See the Codar System and Software Support Matrix for the latest versions of software components required for Codar version 1.80.

9. If you are integrating with an existing external HPE Operations Orchestration, do the following:

   1. Install Operations Orchestration to the correct version and patch level. See Codar System and Software Support Matrix for version requirements.

   2. If you have upgraded Operations Orchestration, you may need to upgrade your content packs. See the Operations Orchestration Release Notes for more information.

   3. Export Operations Orchestration's certificate from Operations Orchestration's truststore and, if Operations Orchestration and Codar are not installed on the same system, copy the certificate to the Codar system. This certificate will be imported into Codar's truststore by the Codar installer. TLS must be configured between Codar and Operations Orchestration.

      For example, complete the following steps:

      1. On the system running Operations Orchestration, open a command prompt and change to the directory where Operations Orchestration is installed.

      2. Run the appropriate command shown below. This command will generate a certificate file in the path shown in the command based on the platform (Windows/Linux).

         C:\oo.cer (Windows) and /tmp/oo.cer (Linux) are examples of file names and locations used to store the exported root certificate (you can choose a different file name and location). <password> is the password you create. Be sure to store it in a secure location that you can access.

         Windows
         .\java\bin\keytool -export -alias tomcat -file C:\oo.cer -keystore .\Central\var\security\key.store -storepass <password>

         Linux
         ./java/bin/keytool -export -alias tomcat -file /tmp/oo.cer -keystore ./Central/var/security/key.store -storepass <password>

      3. If Operations Orchestration is not running on the same system as Codar, copy oo.cer from the Operations Orchestration system to the system running Codar.

10. If you had installed the embedded Operations Orchestration, export the certificate from the truststore of Operations Orchestration as it is needed during the upgrade process. Do the following:

    1. Open a command prompt and navigate to a directory outside of CSA_HOME and the embedded Operations Orchestration installation (for example, the embedded Operations Orchestration may be installed in C:\Program Files\HPE\HPE Operations Orchestration\) in which you will store the certificate file (for example, create the directory C:\tmp and store the certificate file in this directory).

    2. Run the following command:

       "CSA_HOME\openjre\bin\keytool" -exportcert -keystore 
       "C:\ProgramFiles\Hewlett Packard\HPE Operations Orchestration\central\var\
       security\key.store" -alias tomcat -file .\<filename> storepass <password>

       where CSA_HOME\openjre is the directory in which the JRE that is used by Codar is installed and <filename> is a unique file name given to the certificate file that will be imported into Codar version 1.80 later during the upgrade process.

11. Because the JRE has been upgraded in this release, you must export the certificate from the truststore of Codar version 1.50 or 1.60 so that you may import it (at a later time during the upgrade process) into the truststore of Codar version 1.80.

    To export the certificate, do the following:

    1. Open a command prompt and navigate to a directory outside of CSA_HOME in which you will store the certificate file.

    2. Run the following command:

       CSA_HOME\openjre\bin\keytool ‑exportcert ‑keystore
CSA_HOME\jboss-as\standalone\configuration\.keystore ‑alias <alias> ‑file .\<filename>

       CSA_HOME\openjre\ is the directory in which the JRE that is used by Codar is installed.

       keystore is the keystore file defined by the certificate-key-file property of the connector attribute in CSA_HOME\openjre\jboss-as\standalone\configuration\standalone.xml.

       <alias> is the name used by the Codar server keystore to identify the SSL certificate.

       <file_name> is a unique file name given to the certificate file that will be imported into Codar version 1.80 later during the upgrade process:

       For example, run the following command if the JRE used by Codar version 1.50 is located in CSA_HOME, the alias used to identify the certificate is codar, and the file the certificate is saved to is codar.cert:
       

       CSA_HOME\openjre\bin\keytool ‑exportcert ‑keystore
CSA_HOME\jboss-as\standalone\configuration\.keystore ‑alias codar ‑file .\codar.cert

12. Close all command prompts (for Windows, close all instances of Windows Explorer) and exit all programs that are running on the system.

    Caution The upgrade will fail if any program is accessing an Codar file or directory.