Application Packaging Standard

Last updated 18-Mar-2019

Deployment and Synchronization

Deployment

To test a package on a platform lab system (deployment target), the developer should deploy the package on the system, configure a service template with resources, and then provision the resources to a test customer.

The IDE allows you to deploy a package (first of the above steps) directly. The process includes:

  1. Importing the package to the deployment target.
  2. Creating a requested APS application endpoint.
  3. Installing an APS application instance.

Follow these steps to deploy an APS package for the first time:

  1. Once you have your APS project opened in IDE, use one of the following methods to initiate the deployment configuration:

    • Right click on the Package Context folder and select the Deploy package.. item.
    • Click on the Deploy Package icon in the toolbar.
    ../../../../_images/deployment-select.png
  2. In the Deploy APS package pop-up window, assign a target by choosing one from the selection list. If the list is empty or you need a target different from those available in the list, click on the Target link to start the process of adding more targets or editing an existing target:

    ../../../../_images/target-selection.png
    • In the APS Deployment Targets pop-up window, you can add, edit, or remove targets. To add a target, click Add...

      ../../../../_images/target-list.png
    • In the simplest case, for example when you use a developer sandbox, the name and password you set in the pop-up window would be enough to configure the whole deployment target. If you have to configure the target components individually, click Details to open the full configuration list.

      ../../../../_images/target-config-simple.png
    • In the full configuration list, configure the target interfaces individually and then click OK.

      ../../../../_images/target-config-list.png
    • After you have the needed list of targets, click OK to save it. Select the newly configured target in the target selection list.

  3. In the Deploy APS package pop-up window, complete the target configuration:

    • To deploy the application provisioning logic on the endpoint host, select the Deploy end-point on selected deployment target and specify the application endpoint suffix.

    • If the application root resource requires some parameters, add them in the Application properties list.

    • Specify necessary setup tasks by selecting the proper checkboxes:

      ../../../../_images/target-config-complete.png
      • Delete installed instance - removes all APS application instances on the specified APS application endpoint.
      • Provision instance - install an APS application instance on the specified endpoint.
      • Synchronize on build - start automatically package synchronization every time you build the package.
      • Build before deploy - when you require a package deployment, start building the package before the deployment.
  4. Start deployment by clicking Deploy.

The APS Deployment Console will show the logged process similar to this:

Deploying end-point...
Uploading scripts [OK]
Uploading APP-META.xml [OK]
Uploading setup-endpoint.sh [OK]
Set permissions to /tmp/setup-endpoint.sh [OK]
Setup end-point... [OK]
End-point https://endpoint.b.isv1.aps-demo.org/basic1p is configured successfully.
End-point files are located at /var/www/html/basic1p.
Configure PHP Remote Debug configuration [OK]
Starting debug configuration [OK]
Uploading Sample_Basic_Single_Page-1.0-0.app.zip... [OK] - OA AppID is 122 (from server)
OA AppID = 122
Check import status... [OK]
Installing application... [OK] - OA Application Instance ID = 13
Check installation status... [OK]
Open the platform control panel: http://b.isv1.aps-demo.org:8080

When you start the package deployment for the second and all subsequent times on the same target, the system will recognize the package and request you for one of the options:

../../../../_images/deployment-update.png
  • Cancel Deployment - cancel the whole deployment process
  • Overwrite - recreate the APS application endpoint along with the APS application instance
  • Update - update application files on the endpoint host

Synchronization with Deployment Target

If you updated a package, you can sync the updates with the deployed package on the deployment target. Use one of the following ways to initiate the process:

  • Right click on the Package Context folder and select the Synchronize Package item, and then select the node to sync with.
  • Click on the Synchronize Package icon in the toolbar.
../../../../_images/sync-start.png

The process will start immediately.

Instead of syncing the package manually, you can set the Synchronize on build option when configuring the deployment process. More over, you can start the package building automatically by selecting the Build Automatically option in the Build menu. In the latter case, after you update a file and save it, the IDE will build the package and then sync it with the depoyment target.