Skip to main content

Veritran Docs

Package Deployment

Deploying a package involves executing a previously assembled package (in this case, the VT_FULL_IMPLE) in the client environment, applying configurations, transactions, and all other elements included in the package.

This process can be:

Read Business Application Package to learn how to create a BAP and how to convert the package to a stable version for its delivery.

Important

After the changes impact on the target environment, the user in charge of the release can download a changelog to compare the new app version against the older one and generate documentation for the client.

Pre-requisites

Before starting a deployment with Jenkins or VT-Wizard, you need an already assembled package and an API token that will be used when executing the BAP deployment.

To create a token, follow these steps:

  1. Log in to Workspace.

  2. Select New API Token.

  3. Complete the token name with bap_deployer_token.

  4. Select all permissions for the BAPDEPLOYER group.

  5. Create and save the generated API Token.

This type of deployment takes the full implementation package to the target environment and executes the VT-Wizard scripts.

Important

This deployment method should only be used for on-premise environments that do not allow a deployment through Jenkins.

Follow these steps to deploy the package manually:

  1. Transfer the FULL_IMPLE package to the target server, and store it in the standards implementation folder (e.g., /opt/veritran/packages). You can use scp, FTP, or another transfer method.

  2. Decompress the FULL_IMPLE package in the target server:

    tar -xvzf VT-FULL-IMPLE_TEST_BAP_V001.tar.gz
  3. Decompress the VT-NET objects file:

    tar -xvzf IMPLE_VTNET_OBJECTS.tar.gz
  4. Execute VT-Wizard with the following parameters:

    ./vt-wizard/vt-wizard-core.sh \
      -s /path/to/imples/IMPLE_BAP_V001/ \
      -d /veritran/ \
      -e <SERVER_CODE_NAME> \
      -n <NODE_NAME> \
      -k <WORKSPACE_TOKEN>

    (s = source path of the implementation folder, d = destination folder (commonly /veritran/), e = server code name, n = node name, k = Workspace token with BAP Deployer permissions)

The VT-Wizard generates an execution log that should be kept for auditing reasons.

  1. Log in to Jenkins and select the job corresponding to the client/package.

  2. Click Build with Parameters.

  3. Complete the following fields:

    • IMPLENAME: Name of the implementation folder in the repository.

    • NODE: Node where the implementation will be executed.

    • TOKEN: Enter the token generated in Workspace.

  4. Check the Execute option.

  5. Execute the build. The tool should mark the process with the Success status when it is ready.

After the Deployment

After both manual or automated deployments, you need to execute a warmboot to apply changes. To do so, go to Middleware console, and click Operator in the top menu. Then, execute the following command:

WARMBOOT proc .*

Important

Verify with the project's internal IT team if there is any other additional command you should execute after each deploy.

The Middleware console will also reflect updated information. To verify the deployment was executed correctly:

  1. Go to User Application > Configuration Management and look for your app's configuration type. Validate the BAP version.

  2. Go to Auth > Transactions and validate the updated transactions, if applicable.

After the changes impact on the target environment, the user in charge of the release can download a changelog to compare the new app version against the older one and generate documentation for the client.