xAPPnow LOW CODE PLATFORM - User Manual 

Still no account yet?
×

Training Platform Update

 

Overview

 
The goal of this topic is to train you in the update of xAPPnow Low Code Platform. The platform administrator is the responsible of the update.
 

Exercise

In this exercise you will update xAPPnow platform. xAPPnow Low Code Platform is distributed as a tar archives which needs to be unpacked to separate directories.
The following pre-installation tasks have to be done:
 
  • download the bundle appollo-install-base-bundle.tar from the URL provided by xAPPnow Systems
  • obtain license file and mail configuration file mail-config.properties, both files given by xAPPnow team.
 
 
Exercise 1: Update xAPPnow Platform
 
  • Step 1: Decompress appollo-install-base-bundle.tar on an empty directory APPOLLO_HOME:
     
tar -xvpf appollo-install-base-bundle.tar  -C <APPOLLO_HOME>
 
Parameter Explanation:
  • APPOLLO_HOME is the root directory for the installation
 
  • Step 2: Stop the instance:
 
./appollo-stop.sh <INSTANCE_NAME>
 
Parameter Explanation:
  • INSTANCE_NAME - An arbitrary user selected name that will be associated with the installation.
 
 
  • Step 3: Execute update command:
 
./appollo-update.sh --name <INSTANCE_NAME> --port <WEB_PORT> --yf-lic <LICENSE_FILE> [--pg-password-file <PASSWORD_FILE>]  [--pg-port <PG_PORT>]  [--pg-external-name <POSTGRES_EXTERNAL>]  [--mail-config <MAIL_CONF>] [--secrets-conf <SECRETS_FILE>] [--environment-conf-path <ENVIRONMENT_FILE>] [--no-dwh]  [--enable-kibana]  [--db-archive-path <MOUNT_VOLUME_PATH>]  [--ldap-config <LDAP_CONF>] [--enable-metrics] [--flush-metrics]
 
If parameter PG_PORT is not specified, an assigned free port will be used.
 
Parameter Explanation:
  • INSTANCE_NAME - An arbitrary user selected name that will be associated with the installation.
  • WEB_PORT - The port used to access the xAPPnow Digital Innovation Platform web interfaces.
  • LICENSE_FILE - The path to license file
  • MAIL_CONF - is an optional parameter, is the path to a file with email definitions, this configuration allows the system to send mail from processes.
  • POSTGRES_EXTERNAL - is the instance name of another postgresql server, that may be used to host databases. When --pg-external option is not specified, installation uses postgres-server as default instance name.
  • SECRETS_FILE - contains the passwords of the system administrators
  • ENVIRONMENT_FILE - contains the DB internal configuration
  • PASSWORD_FILE is an optional parameter used when the service dwh is to be used. The file contains the password defined for postgresql external database used inside dwh service. When --no-dwh option is used, the service dwh will not be enabled, parameter --pg-password-file is not needed.
  • PG_PORT is xAPPnow postgresql port definition. When used as 127.0.0.1:PORT it means the port is exposed internal to the server, example: 127.0.0.1:54321. See example below. If prefix “127.0.0.1:” is not used the port is exposed external to the server.
  • LDAP_CONF is an optional parameter, is the path to xml file with camunda ldap integration configuration in case ldap integration for authentication is to be used.
  • --enable-kibana option is used to visualize services logs on kibana.
  • --enable-metrics option is used to enable metric reports on camunda.
  • --flush-metrics option allows to flush camunda metrics table.
 
Example:
./appollo-update.sh --name release --port 8088 --pg-port 127.0.0.1:54321 --yf-lic ../licenseOverrideDeveloper.js --mail-config ../mail-config.properties --pg-external-name postgres-external11 --secrets-conf ../secrets-docker.txt --environment-conf-path ../db-environment-automatic-conf.txt