Upgrade a Software Gateway

This section describes how to upgrade s in the software form factor. This section assumes familiarity with uploading and installing patch files.
gateway91
This section describes how to upgrade
API Gateway
s in the software form factor. This section assumes familiarity with uploading and installing patch files.
Determine the Existing Version
Before upgrading, you can use the procedure below to verify the version of the
API Gateway
 currently installed. After upgrading, you can use these steps to validate that the installation packages were installed correctly.
To determine the version of the
API Gateway
 under RHEL/CentOS/SUSE Linux
:
  1. Log in as
    ssgconfig
    and open a privileged command shell from the
    API Gateway
     main menu.
  2. At the command prompt, type:
    rpm -q ssg
    The installed version of the
    API Gateway
     is displayed.
To determine the version of the
API Gateway
 under Solaris
:
  • At the command prompt, type:
    pkginfo -l L7TECHssg
    You should see something similar to the following:
    PKGINST: L7TECHssg NAME: CA API Gateway XML Networking Gateway CATEGORY: JAVAAPPS,application,ssg ARCH: all VERSION: 8.4.00 BASEDIR: / VENDOR: CA Technologies Inc. DESC: CA API Gateway Gateway Software Package PSTAMP: 20150828 INSTDATE: Aug 18 2015 15:47 HOTLINE: 888.681.9377 EMAIL: support@ca.com STATUS: completely installed FILES: 2580 installed pathnames 63 directories 16 executables 651625 blocks used (approx)
The version number is shown next to VERSION and verify that STATUS shows "completely installed".
Upgrade Gateways on RHEL/CentOS/SUSE Linux
Perform the appropriate section to upgrade the
API Gateway
 running on Red Hat Enterprise Linux (RHEL), CentOS, or SUSE Linux.
If Using the MySQL Database
To upgrade the
API Gateway
under RHEL/CentOS/SUSE Linux with a MySQL database
:
  1. (Optional, but recommended)
    Back up the database.
  2. Stop the
    API Gateway
    .
  3. Ensure that a Java SE Development Kit (JDK) has been installed.
  4. Download the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 8 from the Oracle web site. Unzip the files and then copy them to the following directory (assuming the JDK 1.8 was installed to the default directory
    /usr/j2se/
    ):
    # cp UnlimitedJCEPolicy/* /usr/j2se/jdk1.8.0_
    xx
    /jre/lib/security/
  5. Stop the slave in MySQL on all nodes in the cluster.
  6. Set the permissions and upload the relevant patch files to the
    API Gateway
    . These files are available from the CA Support download site.
    # chmod 755 /opt/SecureSpan/Controller/*.L7P # /opt/SecureSpan/Controller/bin/patch.sh upload /opt/SecureSpan/Controller/<patchFileName>.L7P
  7. Install each uploaded patch file. Unless noted otherwise, the patch files may be installed in any order.
    # /opt/SecureSpan/Controller/bin/patch.sh install <patchFileName>
  8. Open
    my.cnf
    for editing:
    # edit my.cnf
  9. Add the following property to
    my.cnf
    :
    log_bin_trust_function_creators=1
    The following property may also need to be added; contact your system administrator if it is required for your installation:
    slave_exec_mode=IDEMPOTENT
    The properties should be added to this section:
    # Uncommment log-bin and log-slave-update if a clustered # db server log-bin=/var/lib/mysql/ssgbin-log log_bin_trust_function_creators=1 log-slave-update # uncomment the next item on 1st db master server server-id=1 # uncomment the next item on 2nd db master servers #server-id=2 relay-log = /var/lib/mysql/ssgrelay-bin relay-log-index = /var/lib/mysql/ssgrelay-bin.index relay-log-info-file = /var/lib/mysql/ssgrelay-bin.info # Slave reliability items: slave-skip-errors=126,1053,1105,1129,1158,1159,1160,1161 slave_compressed_protocol=1 slave-net-timeout=30 slave_exec_mode=IDEMPOTENT
  10. Restart the MySQL service on all nodes in the cluster.
  11. Restart the
    API Gateway
    .
  12. Upgrade the
    API Gateway
     database on one node.
    Tip:
    To do this, use option
    1
    ("Upgrade the Layer 7 Gateway database") on the Gateway Main Menu (Software).
  13. Start the
    API Gateway
    . The databases on the other nodes will be replicated from the primary database.
The upgrade is now complete.
If Using the Embedded Database
To upgrade the
API Gateway
 under RHEL/CentOS/SUSE Linux with the embedded database:
  1. Stop the
    API Gateway
     service with this command:
    # /opt/SecureSpan/Gateway/runtime/bin/gateway.sh stop
  2. Back up the previous embedded database by copying this directory to your local directory:
    /opt/SecureSpan/Gateway/node/default/var/db
  3. Remove this directory:
    /opt/SecureSpan
  4. Reboot the computer.
  5. Install the
    API Gateway
     software with this command:
    # rpm -Uvh ssg-<version>.noarch.rpm
    where
    "<version>"
    is the version number of the new
    API Gateway
    .
  6. Run the following to configure the
    API Gateway
    :
    # /opt/SecureSpan/Gateway/runtime/bin/setup.sh
    The
    API Gateway
     main menu appears.
  7. Select option
    2
    (Configure the Gateway).
  8. Select option
    1
    (Java VM) and verify that the Java VM settings are correct.
  9. Select option
    2
    (Database Connection) and then configure the
    API Gateway
     to use the embedded database.
  10. Exit the
    API Gateway
     main menu and reboot the computer.
  11. Restore the database by copying the backup made to this directory:
    /opt/SecureSpan/Gateway/node/default/var/
  12. Change the ownership and permissions back for the database directory and all of its subdirectories/files
    • Change the owner of database directory (in the previous step) from
      root
      to
      gateway
      .
    • Change the permissions of database directory to
      rwxrwxr-x
    • Change the permissions of the following directory and all its subdirectories to
      rwxrwxr-x
      /opt/SecureSpan/Gateway/node/default/var/db/ssgdb
    • Change the permissions of all files within the "ssgdb" directory (from above) to
      rw-rw-r- -
    • Change the permissions of the subdirectories within the "ssgdb" directory (from above) to
      rwxrwxr-x
    • Change the permissions of the following log file to
      rw-rw-r- -
      /opt/SecureSpan/Gateway/node/default/var/db/derby.log
  13. Start the
    API Gateway
    with this command:
    # /opt/SecureSpan/Gateway/runtime/bin/gateway.sh start
    The upgrade is now complete.
Upgrade 
API Gateway
s on Solaris
Perform the appropriate section to upgrade the 
API Gateway
 running on Solaris.
If Using the MySQL Database
To upgrade the Solaris version of the
API Gateway
 using MySQL database:
  1. On the Solaris
    API Gateway
     server, install the JDK for Solaris and note the installation path. This JDK is available from
    java.sun.com/javase/downloads/index.jsp
    .
  2. Download the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 8 from the Oracle web site. Unzip the files to the following directory (assuming JDK 1.8 was installed to the default directory
    /usr/j2se/
    ):
    cp UnlimitedJCEPolicy/* /usr/j2se/jdk1.8.0_
    xx
    /jre/lib/security/
  3. If you have previously upgraded the MySQL software but not yet run "mysql_upgrade", navigate to the MySQL directory and run:
    # mysql_upgrade --skip-write-binlog
    Next, do the following to upgrade the
    API Gateway
     software:
  4. Stop the slave in MySQL on all nodes in the cluster.
  5. Run the following command to remove the old installation:
    # pkgrm L7TECHssg
  6. Copy the new
    API Gateway
     software package
    L7TECHssg
    -
    <version>
    .pkg
    to the host machine.
  7. Run the following command to install the
    API Gateway
     software:
    # pkgadd -d L7TECHssg-<version>.pkg
  8. Select the package(s) to process.
  9. Open
    my.cnf
    for editing:
    # edit my.cnf
  10. Add the following properties to
    my.cnf
    :
    log_bin_trust_function_creators=1 slave_exec_mode=IDEMPOTENT
  11. Restart the MySQL service on all nodes in the cluster.
  12. Run the following to configure the
    API Gateway
    :
    /opt/SecureSpan/Gateway/runtime/bin/setup.sh
    The
    API Gateway
     main menu appears .
  13. Select option
    2
    (Configure the Gateway).
  14. Select option
    1
    (Java VM) and verify that the Java VM settings are correct.
  15. Select option
    2
    (Database Connection) and then verify that the database connection settings are correct. The settings from the previous version of the
    API Gateway
     should be displayed as the default for each setting. Press [
    Enter
    ] to use the existing value from the previous installation. You will need to enter the password of the database from the previous installation.
    You will see an error stating ‘Database version mismatch’. This is expected because you have just updated the Gateway software. The database will be updated in the next step.
  16. Select option
    1
    (Upgrade the Gateway database) and follow the prompts to upgrade the database.
  17. Start the
    API Gateway
    :
/opt/SecureSpan/Gateway/runtime/bin/gateway.sh start
The upgrade is now complete.
If Using the Embedded Database
To upgrade the Solaris version of the
API Gateway
 using the embedded database:
  1. Stop the
    API Gateway
     service with this command:
    /opt/SecureSpan/Gateway/runtime/bin/gateway.sh stop
  2. Back up the previous embedded database by copying this directory to your local directory:
    /opt/SecureSpan/Gateway/node/default/var/db
  3. Remove the old installation with this command:
    # pkgrm L7TECHssg-<version>
  4. Remove this directory:
    /opt/SecureSpan
  5. Reboot the computer.
  6. Copy the new
    API Gateway
    software package
    L7TECHssg-<version>.pkg
    to the host machine.
  7. Install the
    API Gateway
     software with this command:
    # pkgadd -d L7TECHssg-<version>.pkg
  8. Enter
    Y
    when prompted whether to install the conflicting files, then enter
    Y
    to confirm installing <L7TECHssg>.
  9. Run the following to configure the
    API Gateway
    :
    # /opt/SecureSpan/Gateway/runtime/bin/setup.sh
    The
    API Gateway
    main menu appears.
  10. Select option
    2
    (Configure the Gateway).
  11. Select option
    1
    (Java VM) and verify that the Java VM settings are correct.
  12. Select option
    2
    (Database Connection) and then configure the
    API Gateway
     to use the embedded database.
  13. Exit the Gateway main menu and reboot the computer.
  14. Restore the database by copying the backup to this directory:
    /opt/SecureSpan/Gateway/node/default/var/
  15. Change the ownership and permissions back for the database directory and all of its subdirectories/files:
    • Change the owner of database directory (in the previous step) from
      root
      to
      gateway
      .
    • Change the permissions of database directory to
      rwxrwxr-x
    • Change the permissions of the following directory and all its subdirectories to
      rwxrwxr-x
      /opt/SecureSpan/Gateway/node/default/var/db/ssgdb
    • Change the permissions of all files within the "ssgdb" directory (from above) and all its subdirectories to
      rw-rw-r- -
    • Change the permissions of the following log file to
      rw-rw-r- -
      /opt/SecureSpan/Gateway/node/default/var/db/derby.log
  16. Start the
    API Gateway
     with this command:
/opt/SecureSpan/Gateway/runtime/bin/gateway.sh start
The upgrade is now complete.