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- Log in asssgconfigand open a privileged command shell from theAPI Gatewaymain menu.
- At the command prompt, type:rpm -q ssgThe installed version of theAPI Gatewayis displayed.
To determine the version of the
:API Gateway
under Solaris- At the command prompt, type:pkginfo -l L7TECHssgYou 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- (Optional, but recommended)Back up the database.
- Stop theAPI Gateway.
- Ensure that a Java SE Development Kit (JDK) has been installed.
- 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/
- Stop the slave in MySQL on all nodes in the cluster.
- Set the permissions and upload the relevant patch files to theAPI 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
- 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>
- Openmy.cnffor editing:# edit my.cnf
- Add the following property tomy.cnf:log_bin_trust_function_creators=1The following property may also need to be added; contact your system administrator if it is required for your installation:slave_exec_mode=IDEMPOTENTThe 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
- Restart the MySQL service on all nodes in the cluster.
- Restart theAPI Gateway.
- Upgrade theAPI Gatewaydatabase on one node.Tip:To do this, use option1("Upgrade the Layer 7 Gateway database") on the Gateway Main Menu (Software).
- Start theAPI 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:- Stop theAPI Gatewayservice with this command:# /opt/SecureSpan/Gateway/runtime/bin/gateway.sh stop
- Back up the previous embedded database by copying this directory to your local directory:/opt/SecureSpan/Gateway/node/default/var/db
- Remove this directory:/opt/SecureSpan
- Reboot the computer.
- Install theAPI Gatewaysoftware with this command:# rpm -Uvh ssg-<version>.noarch.rpmwhere"<version>"is the version number of the newAPI Gateway.
- Run the following to configure theAPI Gateway:# /opt/SecureSpan/Gateway/runtime/bin/setup.shTheAPI Gatewaymain menu appears.
- Select option2(Configure the Gateway).
- Select option1(Java VM) and verify that the Java VM settings are correct.
- Select option2(Database Connection) and then configure theAPI Gatewayto use the embedded database.
- Exit theAPI Gatewaymain menu and reboot the computer.
- Restore the database by copying the backup made to this directory:/opt/SecureSpan/Gateway/node/default/var/
- 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) fromroottogateway.
- Change the permissions of database directory torwxrwxr-x
- Change the permissions of the following directory and all its subdirectories torwxrwxr-x/opt/SecureSpan/Gateway/node/default/var/db/ssgdb
- Change the permissions of all files within the "ssgdb" directory (from above) torw-rw-r- -
- Change the permissions of the subdirectories within the "ssgdb" directory (from above) torwxrwxr-x
- Change the permissions of the following log file torw-rw-r- -/opt/SecureSpan/Gateway/node/default/var/db/derby.log
- Start theAPI Gatewaywith this command:# /opt/SecureSpan/Gateway/runtime/bin/gateway.sh startThe upgrade is now complete.
Upgrade
API Gateway
s on SolarisPerform 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:- On the SolarisAPI Gatewayserver, install the JDK for Solaris and note the installation path. This JDK is available fromjava.sun.com/javase/downloads/index.jsp.
- 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/
- 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-binlogNext, do the following to upgrade theAPI Gatewaysoftware:
- Stop the slave in MySQL on all nodes in the cluster.
- Run the following command to remove the old installation:# pkgrm L7TECHssg
- Copy the newAPI Gatewaysoftware packageL7TECHssg-<version>.pkgto the host machine.
- Run the following command to install theAPI Gatewaysoftware:# pkgadd -d L7TECHssg-<version>.pkg
- Select the package(s) to process.
- Openmy.cnffor editing:# edit my.cnf
- Add the following properties tomy.cnf:log_bin_trust_function_creators=1 slave_exec_mode=IDEMPOTENT
- Restart the MySQL service on all nodes in the cluster.
- Run the following to configure theAPI Gateway:/opt/SecureSpan/Gateway/runtime/bin/setup.shTheAPI Gatewaymain menu appears .
- Select option2(Configure the Gateway).
- Select option1(Java VM) and verify that the Java VM settings are correct.
- Select option2(Database Connection) and then verify that the database connection settings are correct. The settings from the previous version of theAPI Gatewayshould 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.
- Select option1(Upgrade the Gateway database) and follow the prompts to upgrade the database.
- Start theAPI 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:- Stop theAPI Gatewayservice with this command:/opt/SecureSpan/Gateway/runtime/bin/gateway.sh stop
- Back up the previous embedded database by copying this directory to your local directory:/opt/SecureSpan/Gateway/node/default/var/db
- Remove the old installation with this command:# pkgrm L7TECHssg-<version>
- Remove this directory:/opt/SecureSpan
- Reboot the computer.
- Copy the newAPI Gatewaysoftware packageL7TECHssg-<version>.pkgto the host machine.
- Install theAPI Gatewaysoftware with this command:# pkgadd -d L7TECHssg-<version>.pkg
- EnterYwhen prompted whether to install the conflicting files, then enterYto confirm installing <L7TECHssg>.
- Run the following to configure theAPI Gateway:# /opt/SecureSpan/Gateway/runtime/bin/setup.shTheAPI Gatewaymain menu appears.
- Select option2(Configure the Gateway).
- Select option1(Java VM) and verify that the Java VM settings are correct.
- Select option2(Database Connection) and then configure theAPI Gatewayto use the embedded database.
- Exit the Gateway main menu and reboot the computer.
- Restore the database by copying the backup to this directory:/opt/SecureSpan/Gateway/node/default/var/
- 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) fromroottogateway.
- Change the permissions of database directory torwxrwxr-x
- Change the permissions of the following directory and all its subdirectories torwxrwxr-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 torw-rw-r- -
- Change the permissions of the following log file torw-rw-r- -/opt/SecureSpan/Gateway/node/default/var/db/derby.log
- Start theAPI Gatewaywith this command:
/opt/SecureSpan/Gateway/runtime/bin/gateway.sh start
The upgrade is now complete.