Contents
This topic describes how to upgrade an existing
11.1.1.x
installation of API Gateway to version 11.1.2.3.0. API Gateway 11.1.2.3.0 provides a
sysupgrade
script to export your data from an existing installation, upgrade it,
and import it into a new API Gateway 11.1.2.3.0 installation.
This section describes the steps involved in an upgrade from version 11.1.1.x (old installation) to version 11.1.2.3.0 (new installation).
Back up the old 11.1.1.x installation on all nodes, including any databases.
-
Back up the directory containing your old installation of API Gateway.
-
Back up any databases by creating a DMP file of the tables in use.
Install API Gateway 11.1.2.3.0 in a different directory to your old
11.1.1.x
installation on all nodes. For example, if the old installation is installed in
OLD_INSTALL_DIR
, you should install the new installation in
NEW_INSTALL_DIR
. For more information on installation, see the Installation topic.
![]() |
Note |
---|---|
|
To copy the upgrade tools from the new 11.1.2.3.0 installation to the old installation, copy the
upgrade
directory from the 11.1.2.3.0 installation to the old installation.
Copy this directory from your 11.1.2.3.0 installation:
Windows
NEW_INSTALL_DIR\apigateway\upgrade
UNIX/Linux
NEW_INSTALL_DIR/apigateway/upgrade
After copying, the old installation should contain the upgrade
directory.
For example:
Windows
OLD_INSTALL_DIR\apigateway\upgrade
UNIX/Linux
OLD_INSTALL_DIR/apigateway/upgrade
The exporter tool differs based on the version of your old installation. Ensure you install the correct tool for your version.
Perform these steps to install the exporter tool on your old installation:
-
Open a command prompt at the following directory in your old installation:
Windows
OLD_INSTALL_DIR\apigateway\upgrade\legacy\6.x
UNIX/Linux
OLD_INSTALL_DIR/apigateway/upgrade/legacy/6.x
-
Run the
install
command. -
Repeat on each node of the old installation.
![]() |
Note |
---|---|
Before you export, ensure that the Node Managers and API Gateways are running on the old installation. |
Perform these steps to export the data from your old installation:
-
Open a command prompt at the following directory in your old installation:
Windows
OLD_INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux
OLD_INSTALL_DIR/apigateway/posix/bin
-
Delete the
out
directory if it already exists. -
Run the
sysupgrade
command to export the data.Windows
sysupgrade export
UNIX/Linux
./sysupgrade export
The data is exported to the
out
directory. -
Repeat on each node of the old installation.
To copy the exported data from the old installation to the new 11.1.2.3.0 installation, copy the
out
directory from the old installation to the 11.1.2.3.0 installation.
Copy this directory from your old installation:
Windows
OLD_INSTALL_DIR\apigateway\Win32\bin\out
UNIX/Linux
OLD_INSTALL_DIR/apigateway/posix/bin/out
After copying, the new installation should contain the following directory:
Windows
NEW_INSTALL_DIR\apigateway\Win32\bin\out
UNIX/Linux
NEW_INSTALL_DIR/apigateway/posix/bin/out
Perform these steps to upgrade the data exported from your old installation:
-
Open a command prompt at the following directory in your new 11.1.2.3.0 installation:
Windows
NEW_INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux
NEW_INSTALL_DIR/apigateway/posix/bin
-
Run the
sysupgrade
command to upgrade the exported data in theout
directory.Windows
sysupgrade upgrade --component=topology,extlib,sysconfig,esgroups
UNIX/Linux
./sysupgrade upgrade --component=topology,extlib,sysconfig,esgroups
The data in the
out
directory is upgraded to version 11.1.2.3.0. -
Repeat on each node of the new installation.
![]() |
Note |
---|---|
You must shut down any Node Managers or API Gateways on the old installation before applying the upgrade. |
Perform these steps to apply the upgraded data to your new 11.1.2.3.0 installation:
-
Open a command prompt at the following directory in your new 11.1.2.3.0 installation:
Windows
NEW_INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux
NEW_INSTALL_DIR/apigateway/posix/bin
-
Run the
sysupgrade
command to apply the upgrades in theout
directory.Windows
sysupgrade apply
UNIX/Linux
./sysupgrade apply
The upgrades are applied to the new 11.1.2.3.0 installation.
-
Repeat on each node of the new installation.
The following additional steps might be required, depending on your configuration:
-
API Gateway Analytics database tables – If you have an existing installation of API Gateway Analytics version 11.1.1.6.x, you can upgrade your database tables to version 11.1.2.0.x using the
dbsetup
script. For more information, see the section called “Upgrade API Gateway Analytics database tables”. -
API Gateway Analytics – If you have made changes to the configuration of an existing installation of API Gateway Analytics, and you do not wish to reconfigure these changes, you can use the
upgradeconfig
script to upgrade API Gateway Analytics. For more information, see the section called “Upgrade API Gateway Analytics”. -
RBAC – In API Gateway version 11.1.2.0.0, the Role-Based Access Control (RBAC) support changed to use a JSON-based implementation with new API Gateway user roles. If you are upgrading from version 11.1.1.6.x, you must reconfigure your RBAC settings using the
pdMigrate.py
script. For more information, see the section called “Upgrade RBAC”.
![]() |
Important |
---|---|
You must upgrade version 11.1.1.6.x database schemas to 11.1.2.x for API Gateway to function correctly. Database schema upgrades are not supported for versions earlier than 11.1.1.6.x. If your existing API Gateway installation is version 11.1.2.x, you do not need to upgrade the database tables. |
The dbsetup
utility always checks the existing version, and modifies
only if an update is required. For example, to start an interactive upgrade, run
this script as follows:
> dbsetup.bat Connecting to configuration at: federated:file:///INSTALL_DIR\oaganalytics/conf/fed/ configs.xml Using Configured Database: DB Name: Default Database Connection DB URL: jdbc:mysql://127.0.0.1:3306/reports DB User: root Current schema version: 000-initial Latest schema version: 001-topology Continue with upgrade (Y, N) [N]: y Schema successfully upgraded to: 001-topology
The dbsetup
utility uses SQL upgrade scripts located in the
following directory:
INSTALL_DIR/system/conf/sql/upgrade
The subdirectories are named for the upgrade applied, and the order in which they must be executed. The following upgrades are currently available:
Upgrade Name | Description |
---|---|
000-initial
|
11.1.1.6.x version of the schema. |
001-topology
|
11.1.2.x version of the schema. |
To upgrade API Gateway Analytics, run the upgradeconfig
script from the
following location:
Windows
INSTALL_DIR\oaganalytics\Win32\bin
UNIX/Linux
INSTALL_DIR/oaganalytics/posix/bin
For more details on running this script, see the version 11.1.2.2.1 API Gateway Installation and Configuration Guide.
![]() |
Note |
---|---|
This step is normally not required unless you have made significant changes to the configuration of an existing installation of API Gateway Analytics (for example, for RBAC). |
If you are upgrading from version 11.1.1.6.x, you must reconfigure your RBAC settings and migrate your existing users using the following sample script:
INSTALL_DIR/samples/migrate/pdMigrate.py
This script extracts the existing users from the pdEntities.xml
file
in the old installation and places them in a adminUsers.json
file
in the new installation.
For more details on running this script, see the version 11.1.2.2.1 API Gateway Installation and Configuration Guide.
For more details on RBAC, see the Oracle API Gateway Administrator Guide.