Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

(tick)One Application per combined schema installationYou can import multiple applications into AIP Console, however, there must be only one Application (the one to be imported) declared in any existing Management schema. In other words, the Applications to be imported must have dedicated combined schemas (Management, Analysis and Dashboard schemas).
(tick)Application/schema version

The application you want to import into AIP Console must have the same AIP schema version number as the AIP Node you are importing into.

Info
Note that in AIP Console ≥ 1.25, this limitation has been removed: you can import an Application with an AIP schema version number that is older than the AIP Node you are importing into. You can then upgrade this application to match the AIP Node AIP version number.


(tick)Delivery folder

Format

AIP Console requires a different format of Delivery folder (since version 1.13) than the format that is used in legacy deployments of CAST AIP. Therefore, before an application can be imported into AIP Console, the files stored in the existing/source Delivery folder relative to the Applications to be imported must be transformed into the format that the AIP Console can understand. This process is explained below in Step 1.

CAST's recommended best practice if you want to transform multiple applications in Step 1 is to only specify in config.json the applications that will then be imported in Step 3 into the same AIP Node.

Location

Each AIP Node managed by AIP Console requires a Delivery folder in which to store Application data. CAST's recommended best practice is to use a common/shared Delivery folder for all AIP Nodes that are managed in AIP Console. This Delivery folder can be located on a network share. See Configure AIP Node storage folder locations - optional.

(tick)Deployment folderThe Deployment folder configured for an application you would like to import does not need to be identical in CAST Management Studio and on the AIP Node. It can be identical if required, but it is not mandatory.
(tick)CAST Storage Service / PostgreSQL instance

In an AIP Console environment, each AIP Node (a server where CAST AIP core is installed and which is managed through AIP Console) can only be associated with one single CAST Storage Service/PostgreSQL instance, therefore the CAST AIP schemas (Management, Analysis and Dashboard schemas) associated with the applications you want to transform and import into AIP Console must already be present on the CAST Storage Service/PostgreSQL instance associated to the AIP Node in to which the applications will be imported.

You can check which CAST Storage Service/PostgreSQL instance is associated to your target AIP Node using the <installation>\AipNode\data\aip-node-app.properties file and checking the database.server.name option:

Code Block
# =============================
# CSS Server parameters
# -----------------------------
database.server.name=192.168.200.104:2282

This requirement may not already be the case. For example:

  • You would like to import 5 Applications into AIP Node "1"
  • AIP Node "1" is associated with CAST Storage Service/PostgreSQL instance "A"
  • Of the Applications that will be imported to AIP Node "1", three applications use CAST AIP schemas on CAST Storage Service/PostgreSQL instance "A" and two applications use CAST AIP schemas on CAST Storage Service/PostgreSQL instance "B".

In this scenario, you will need to perform the following:

  • backup the Management, Analysis and Dashboard schemas that are stored on CAST Storage Service/PostgreSQL instance "B"
  • restore the schemas on CAST Storage Service/PostgreSQL instance "A"

See Maintenance activities for CAST Storage Service and PostgreSQL for more information about backing up and restoring schemas.

(tick)Access to resources

The server on which you are running the migration.bat transformation tool explained in Step 1, must have access to:

  • the existing Delivery folder configured in the CAST Management Studio
  • the Delivery folder configured for the target AIP Node in to which the application(s) will be imported
  • the CAST Storage Service/PostgreSQL instance hosting the schemas for the Applications to transform
(tick)Configure required third-party source code

If the source code of the Application to import uses third-party source code (such as .NET Assemblies, or Maven repos), ensure you configure AIP Console to use the third-party code from the SAME location as defined in the CAST Management Studio. See the following pages:

(tick)Enable the path matching featureEnsure you enable the Path matching option for source code delivery rescan. This will help to ensure that the source code you upload for the base-line analysis/snapshot after importing the Application is consistent.

...

The files/scripts described in Step 1 are available as a downloadable extensionThe latest release of this extension is delivered with each major or minor release of AIP Console on EACH AIP Node. If in doubt, CAST recommends downloading and using the tool to ensure that you have the latest release of the files/scripts. The instructions below assume you are using the files/scripts provided on each AIP Node - if you are using the files/scripts provided as an extension, simply change the path to the file that is specified.

...

Locate %PROGRAMFILES%\CAST\AipConsole\AipNode\bin\dmt-migration-tool\config.json on your AIP Node or use the file provided in the downloadable extensionThis file will be provided out-of-the-box as follows:

...

delivery_folder_location

Enter the location of the Delivery folder defined in the CAST Management Studio for the Application (s) you want to transform. See note below about the required path syntax for the config.json file.

destination_delivery_folder_location

Enter the location of the Delivery folder defined for the AIP Node. This can be an empty folder if you are importing into an AIP Node that has been recently added to AIP Console. For example:

"destination_delivery_folder_location": "S:\\Delivery",

The transformation tool will:

  • copy the Applications specified in applications into the destination_delivery_folder_location
  • the transformation of these Applications will then occur in destination_delivery_folder_location
  • delivery_folder_location will remain unchanged for roll back purposes

See note below about the required path syntax for the config.json file.

log_file_location

Enter a full path to a folder that will be used to store a log file called delivery.folder.migration.tool.logrecord that will contain log for the transformation process, for example:

Code Block
languagetext
"log_file_location": "D:\\temp",

See note below about the required path syntax for the config.json file.

css_servers

Check that the css_servers details correspond to the CAST Storage Server/PostgreSQL instance which is used to host the CAST AIP schemas for the Applications you are transforming. 

Info
The encrypted key in the password parameter corresponds to the default password for the operator user. If your CAST Storage Server/PostgreSQL instance uses different credentials, you can generate a new encryption key for the password entry, please see Using the aip-encryption-tool to encrypt credentials.


applications

Enter the names of the applications you want to include in the transformation process, separated by a comma and space if there is more than one. All Applications must be located in the same delivery_folder_location. CAST's recommended best practice if you want to transform multiple applications is to only specify those applications that will be imported (in Step 3) into the same AIP Node.

Code Block
languagetext
"applications": ["app1", "app2", "app3"]


...

AIP Console requires that source code is delivered in a ZIP file or in a source code folder. To structure it properly, follow the instructions in the section below. Also as stated in the prerequisites, ensure that you enable the path matching feature to help identify missing or altered source code during the base-line code analysis following the import of the Application - see Path matching option for source code delivery rescan.

...