Migrate CA Live API Creator

Migrate CA Live API Creator
lac42
If you are running 
CA Live API Creator
 4.x or earlier, migrate your APIs and other API Server definitions–such as the authentication provider definitions, the managed data server definitions, and CA API Gateway configuration definition–to 
CA Live API Creator
 5.0. In
CA Live API Creator
 4.x or earlier, API Server stored your admin and API metadata in an admin database. As of 
CA Live API Creator
 5.0, API Server stores your data in the admin repository.
This article explains how to migrate your API definition that is in the admin database to the admin repository in 
CA Live API Creator
 5.0 using the migration service, which is a utility that simplifies the migration process.
For more information:
In this article:
Verify the Prerequisites
Before you begin migrating from 
CA Live API Creator
 4.x or earlier to 
CA Live API Creator
 5.0, verify the following prerequisites:
  • You have obtained and installed the license for 
    CA Live API Creator
     5.0.
    For more information about how to obtain and install the API Server license, see Import the API Server License.
  • You have cleared your browser cache.
  • You have
    CA Live API Creator
     4.x or earlier and
    CA Live API Creator
     5.0 installed and running.
    For more information about how to install 
    CA Live API Creator
    , see Installing and Upgrading.
  • You have accepted the terms of the end-user license agreement (EULA).
  • You have downloaded the migration service (the 
    migrate.sh
     shell script or the 
    migrate.bat
     batch file) from the MigrationService GitHub site.
  • You have the password for the system administrator (
    sa
    ) user and default TeamSpace user for 
    CA Live API Creator
     4.x and earlier.
    If the 
    default
     TeamSpace is the only TeamSpace that exists, you are the initial API developer (a TeamSpace user), and you are just starting to use API Creator, the user name for this user is 
    admin
    .
  • You have the password for the 
    default
     TeamSpace user for
    CA Live API Creator
     5.0.
Migrate your APIs Using the Migration Service
Migrate your APIs and other API Server definitions from 
CA Live API Creator
 4.x or earlier to 
CA Live API Creator
 5.0 using the migration service.
The following diagram illustrates how to migrate your APIs using the migration service:
MigrationService
MigrationService
Generate the Export and Import Scripts
Generate the export and import scripts that you use to migrate to 
CA Live API Creator
 5.0.
From terminal or a command prompt, run the migration service based on your operating system:
(Mac/Linux)
migrate.sh
(Windows)
migrate.bat
This migration service generates the following migration scripts:
  • The 
    MasterExport-1.sh
     export script: This script exports your APIs and other API Server definitions from 
    CA Live API Creator
     4.x and earlier.
  • The 
    MasterImport-2.sh
     import script: This script imports the exported APIs and other API Server definitions into
    CA Live API Creator
     5.0.
These scripts use the
CA Live API Creator
Admin command-line interface (Admin CLI),
lacadmin
(or the alias
liveapicreatoradmin
).
Install the 
CA Live API Creator
 Admin Command-Line Interface
The migration scripts use the 
CA Live API Creator
 Admin command-line interface (Admin CLI), 
lacadmin
 (or the alias 
liveapicreatoradmin
). Based on the platform that you are running your migration scripts, copy the 
lacadmin
 that is located in the 
<MigrationService>/macos|linux|windows
 directory to the directory where you plan to run the migration scripts.
Export your APIs and Other API Server Definitions
Prerequisite:
 If you are exporting APIs from multiple TeamSpaces, you must have the appropriate access to export TeamSpaces.
Follow these steps:
  1. Configure the 
    MasterExport-1.sh
     export script. In a text editor, open the script and update your TeamSpace user credentials (username and password) to your credentials in
    CA Live API Creator
     4.x or earlier, and then save the changes to the script.
  2. Run the export script.
    The 
    workspace
     directory is created. The APIs and the other API Server definitions from 
    CA Live API Creator
     4.x or earlier are exported to the 
    workspace
     directory in JSON file format.
  3. Confirm that the 
    workspace
     directory contains the APIs and the other API Server definitions that you exported, as per the definition in the export script.
Create the TeamSpace and TeamSpace Users
If your 
CA Live API Creator
 5.0 installation includes more than one TeamSpace, create the TeamSpace and the TeamSpace users.
For more information:
Import your APIs and Other API Server Definitions
  1. Configure the 
    MasterImport-2.sh
     import script. In a text editor, open the script and update your TeamSpace user credentials (username and password) to the credentials that you have in
    CA Live API Creator
     5.0, and then save the changes to the script.
  2. Run the import script.
    Your APIs and the other API Server definitions that are located in the 
    workspace
     directory are imported to the admin repository in 
    CA Live API Creator
     5.0.
  3. Confirm that the APIs and the other API Server definitions have been imported into 
    CA Live API Creator
     5.0.
Confirm the Migration of your APIs
Verify that you have migrated your APIs and other API Server definitions from 
CA Live API Creator
 4.x or earlier to 
CA Live API Creator
 5.0 successfully by running your automated regression tests.
Next Steps
Complete the following procedures after you have migrated your APIs and other API Server definitions from 
CA Live API Creator
 4.x and earlier to 
CA Live API Creator
 5.0.
Remove the JNDI Data Source for your Admin Database
If you are have configured for database connections using a Java Naming and Directory Interface (JNDI) data source in 
CA Live API Creator
 4.x and earlier, consider removing this data source. As of 
CA Live API Creator
5.0, 
CA Live API Creator
 stores your API metadata in an in-memory Derby database, and then synchronizes it to an admin repository on the local file system. It does not require this data source.
For more information about the admin repository, see View your API Definition.
Update External Logging
The logging system property names (the 
lac.logging.config.file
 option and the 
java.util.logging.config.file
 option) have changed in 
CA Live API Creator
 5.0. If you have configured external logging, set the absolute path of the logging configuration file by adding the 
LAC_LOGGING_CONFIG_FILE
 option when you start API Server.
For more information:
  • About how to set the absolute path of the logging configuration file, see External Logging.
  • The 
    LAC_LOGGING_CONFIG_FILE
     option and other options that you can add when you start API Server, see API Server Startup Options.
  • About the name change for this option, see Release Notes.
Deploy your APIs to a Cluster
For more information about how to deploy your APIs to 
CA Live API Creator
 running as a cluster, see Configure Live API Creator to Run as a Cluster.