xAPPnow LOW CODE PLATFORM - User Manual 

Still no account yet?
×

xAPPnow Low Code Platform - Installation Procedure

 
 
All steps required to install the xAPPnow Low Code Platform are described in detail in the Installation Manual.
 
Unpacking
xAPPnow Digital Innovation 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 docker images file cloud-image-project.tar
  • download the bundle appollo-installation-cloud-<version>-bundle.tar from the URL provided by Appollo Systems.
  • download the file proxy-<version>.tar from the URL provided by Appollo Systems.
  • obtain license file and mail configuration file mail-config.properties, both files  given by Appollo team.
 
 

xAPPnow Docker Images Installation

 
1. Decompress cloud-image-project.tar
 
tar -xvpf cloud-image-project.tar
 
2. Install xAPPnow docker images
 
cd cloud-image-project
./setup-images.sh appollo
 
 
3. Verify docker images were installed
 
docker image ls
 
Output should be similar to this:
 
 
 

External Postgresql Server Installation

 
1. Decompress appollo-installation-cloud-<version>-bundle.tar on an empty user directory APPOLLO_HOME
 
tar -xvpf appollo-install-base-bundle.tar -C <APPOLLO_HOME>
 
Parameter Explanation:
  • APPOLLO_HOME is the root directory for the installation
 
 
2. Create file with external postgresql server password
 
3. Give permissions to file using the following command:
 
chmod 600 <POSTGRES_PASSWORD_FILE>
 
Parameter Explanation:
  • PASSWORD_FILE - file with postgresql server password.
 
Example: Show PASSWORD_FILE content
 
$ cat postgres-password.txt
postgresexample
 
The file postgres-password.txt in the example contains a line with the text testpostgres
 
 
In the following steps will be configured a postgresql server accessible from outside the cloud server.
Assuming the user has already admin privileges. The following installation tasks have to be executed to start the installation procedure:
 
4. Change current directory to APPOLLO_HOME
 
cd  <APPOLLO_HOME>
 
5. Execute install command
 
./appollo-install-postgres.sh --name <CONTAINER_NAME> --port <PG_PORT> --pg-password-file <PASSWORD_FILE> [--network-instances <NETWORK_INSTANCES>] [--db-archive-path <MOUNT_VOLUME_PATH>]
 
Parameter Explanation:
  • CONTAINER_NAME - The postgresql container to be used
  • PG_PORT - The port for the PostgreSQL Server
  • NETWORK_INSTANCES can specify multiple networks to be linked. A network instance is for example a network used by appollo installation containers, automatically created during installation. Using a link to network allows dwh service to connect to postgresql external container using its container name as a dns name in dwh configuration.
  • MOUNT_VOLUME_PATH is a directory to mount database container backup volume used for log shipping.
 
Example with one instance:
./appollo-install-postgres.sh --name postgres-external --port 5433  --pg-password-file /home/appollo/password-postgres.txt --network-instances ams
 
Example using multiple instances:
./appollo-install-postgres.sh --name postgres-external --port 5433  --pg-password-file /home/appollo/password-postgres.txt --network-instances ams,develop,test
 
Backup directory configuration for log shipping:
./appollo-install-postgres.sh --name postgres-external --port 5433  --pg-password-file /home/appollo/password-postgres.txt --network-instances ams,develop --db-archive-path /home/appollo/archive-postgres-external
 
 

xAPPnow Installation

 
Assuming the user has already admin privileges the following installation tasks have to be executed to start the installation procedure:
 
1. Change current directory to APPOLLO_HOME
 
cd  <APPOLLO_HOME>
 
2. Execute install command
 
./appollo-install.sh --name <INSTANCE_NAME> --port <WEB_PORT> --yf-lic <LICENSE_FILE> [--mail-config <MAIL_CONF>] [--pg-external-name <POSTGRES_EXTERNAL>] [--secrets-conf <SECRETS_FILE>] [--environment-conf-path <ENVIRONMENT_FILE>] [--pg-password-file <PASSWORD_FILE>] [--pg-port <PG_PORT>] [--no-dwh][--enable-kibana]  [--db-archive-path <MOUNT_VOLUME_PATH>]  [--ldap-config <LDAP_CONF>] [--enable-metrics] [--flush-metrics]
 
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.
 
Install Command Examples:
 
Enable DWH service: needs supply PASSWORD_FILE: parameter
 
./appollo-install.sh --name ams --port 8082 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt
 
Example not enabling dwh service:
./appollo-install.sh --name ams --port 8082 --yf-lic license.txt  --mail-config mail-config.properties --no-dwh
 
Example enabling loggin to kibana:
./appollo-install.sh --name ams --port 8082 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt –enable-kibana
 
Example configuring postgres internal port as 54321:
./appollo-install.sh --name ams --port 8082 --pg-port 127.0.0.1:54321 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt
 
Example configuring postgres port 5433 accessible from other server for streaming replication:
./appollo-install.sh --name ams --port 8082 --pg-port 5433 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt --db-archive-path /home/appollo/archive-postgres-ams
 
Example using ldap option and config file:
./appollo-install.sh --name ams --port 8082 --pg-port 5433 --yf-lic license.txt  --mail-config mail-config.properties --no-dwh --ldap-config ldap-config.xml
 
Example enable camunda metrics:
./appollo-install.sh --name ams --port 8082 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt --enable-metrics
 
Example flush camunda metrics table:
./appollo-install.sh --name ams --port 8082 --yf-lic license.txt  --mail-config mail-config.properties --pg-password-file password-postgres.txt
--flush-metrics
 
To see more examples, see the command help:
./appollo-install.sh --h