Migrate CA Live API Creator

If you are running
CA Live API Creator
4.x or earlier, migrate your API 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.
lac51
If you are running
CA Live API Creator
4.x or earlier, migrate your API 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 and earlier, API Server stored the API definition in a shared admin database. In
CA Live API Creator
5.x, API Server stores the definition in the admin repository, which is a set of files and directories. As part of the migration workflow, you migrate from
CA Live API Creator
4.x and earlier to
CA Live API Creator
5.0, and then upgrade to the latest version of
CA Live API Creator
.
The following image shows the workflow:
migration_upgrade_LAC_workflow
migration_upgrade_LAC_workflow
This article explains how to migrate the API definition that is in the admin database for
CA Live API Creator
4.x and earlier to the admin repository that is in
CA Live API Creator
5.0 using the migration service. This service is a utility that simplifies the process of migrating your APIs.
If you are running
CA Live API Creator
5.x, your API definition is already stored in the admin repository, and you can skip the migration process. Upgrade to the latest version of
CA Live API Creator
.
For more information about how to upgrade to the latest version of
CA Live API Creator
, see Upgrade Live API Creator.
For more information:
In this article:
Verify the Prerequisites
Before you begin migrating to the latest version of
CA Live API Creator
, verify the following prerequisites:
  • You have obtained and installed the license for
    CA Live API Creator
    5.x.
    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.
    You can install
    CA Live API Creator
    5.0 on a different server for the purpose of this migration activity.
    CA Live API Creator
    5.0 is required only for the migration process.
    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.cmd
    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 or 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 API definitions from
CA Live API Creator
4.x or earlier to
CA Live API Creator
5.0 using the migration service.
Use the following process to migrate your APIs:
  1. Generate the export and import scripts.
  2. Install the CA Live API Creator Admin command-line interface (Admin CLI), lacadmin (or the alias liveapicreatoradmin).
  3. Export your API definitions.
  4. Create the TeamSpace and TeamSpace users.
  5. Import your API definitions.
The following diagram illustrates a summary of the steps on how to use the migration service to migrate to
CA Live API Creator
5.0:
MigrationService
MigrationService
Generate the Export and Import Scripts
Generate the export and import scripts that you use to migrate to the latest version of
CA Live API Creator
. Run the migration service based on your operating system:
(Mac/Linux)
From terminal, run the migration service by issuing the following command:
migrate.sh
(Windows)
From a command prompt, run the migration service by issuing the following command:
migrate.cmd
This migration service generates the following migration scripts:
  • The export scripts ((Mac/Linux)
    MasterExport-1.sh
    and (Windows)
    MasterExport-1.bat
    ). These scripts export the API definitions from
    CA Live API Creator
    4.x or earlier.
  • The import scripts ((Mac/Linux)
    MasterImport-2.sh
    and (Windows)
    MasterImport-2.bat
    ). These scripts import the exported API definitions into
    CA Live API Creator
    5.0.
Install the
CA Live API Creator
Admin Command-Line Interface
The migration scripts use the Admin CLI. Based on the platform (Mac/Linux/Windows) on which you are running your migration scripts, copy the
lacadmin
file that is located in the
<MigrationService>/macos|linux|windows
directory to the directories for
CA Live API Creator
4.x or earlier and for
CA Live API Creator
5.0 where you plan to run the migration scripts.
Export your API Definitions
You export your API definitions using the export script.
Prerequisite:
If you are exporting APIs from multiple TeamSpaces, you must have the appropriate access to export TeamSpaces.
Follow these steps:
  1. Configure the export script ((Mac/Linux)
    MasterExport-1.sh
    and (Windows)
    MasterExport-1.bat
    ). In a text editor, open the script and update your TeamSpace user credentials (username and password) to the credentials that you have for
    CA Live API Creator
    4.x or earlier, and then save the changes to the script.
  2. Start
    CA Live API Creator
    4.x and earlier.
  3. Run the export script.
    The
    workspace
    directory is created. The API definitions from
    CA Live API Creator
    4.x and earlier are exported to the
    workspace
    directory in JSON file format.
    The API definitions that the export script saves to the
    workspace
    directory are required only for the migration process.
  4. Confirm that the
    workspace
    directory contains the API definitions that you exported.
  5. Stop
    CA Live API Creator
    4.x and earlier.
Create the TeamSpace and TeamSpace Users
If
CA Live API Creator
5.0 includes more than one TeamSpace, create the TeamSpace and the TeamSpace users.
For more information:
Import your API Definitions
  1. Configure the import script ((Mac/Linux)
    MasterImport-2.sh
    and (Windows)
    MasterImport-2.bat
    ). In a text editor, open the script and update your TeamSpace user credentials (username and password) to the credentials that you have for
    CA Live API Creator
    5.0, and then save the changes to the script.
  2. Start
    CA Live API Creator
    5.0.
  3. Run the import script.
The API definitions that you exported (that are located in the
workspace
directory) are imported into the admin repository for
CA Live API Creator
5.0.
Confirm the Migration of your APIs
Verify that the migration service has migrated your API definitions to the admin repository for
CA Live API Creator
5.0 successfully from
CA Live API Creator
4.x or earlier by running your automated regression tests. The location of the admin repository is dependent on the Java container on which you are running
CA Live API Creator
.
For more information about the location of the admin repository, see View your API Definition.
Next Steps
Now that you have migrated
CA Live API Creator
4.x or earlier to
CA Live API Creator
5.0, upgrade
CA Live API Creator
to the latest version. You use the output from the migration process (the API definition that is in the admin repository for
CA Live API Creator
5.0) to upgrade.
For more information about how to upgrade
CA Live API Creator
, see Upgrade Live API Creator.