Setting up the Rule Engine on Linux

Follow these steps to set up the Rule Engine on Linux.

Step 1: Download the required zip file from broadcom.com

1. Log in to the Support page and click on Download Management .

2. Using the search bar, enter CA Automic followed by package you want to download. Example: Automic Automation
   
3. After downloading the file, unzip it to a temporary directory
4. Locate the flink installation file in the following directory: <automic>/External.Resources/flink
5. Untar the flink installation file and copy this file to your target installation machine in Step 2 below.
   

Step 2: Install the Rule Engine

1. Create a directory on your target machine that looks like this: <automic>/External.Resources/flink
2. Copy the untarred flink installation file content into <automic>/External.Resources/flink directory. The directory should look like this:

bin

conf

examples

lib

log

opt

resources

tools

NOTICE

README

3. Copy the following script into a text editor and save it as start.sh in the following directory: <automic>/External.Resources/flink/bin.

   Important! In the following script replace the "%JDK%" with your actual jdk path.

   #!/usr/bin/env bash
   echo Starting up Flink
   
   stop_flink() {
       echo Stopping flink > flink_stop.out
       ./stop-cluster.sh
       echo Shutdown finished >> flink_stop.out
       exit
   }
   
   trap stop_flink SIGHUP SIGINT SIGTERM SIGUSR1 SIGKILL
   
   export JAVA_HOME=%JDK%
   export PATH=${JAVA_HOME}/bin:$PATH
   
   ./start-cluster.sh > flink.out 2>&1
   
   while true
   do
       sleep 1
   done

4. In the <automic>/External.Resources/flink/bin directory under a root user make the file executable.
   Example: run the command chmod +x ./start.sh.

Step 3: Add the Rule Engine to the Service Manager SMD File

Important! Note, for steps 3 and 4 Service Manager should be installed. If you do not have Service Manager installed, see the following links: ServiceManager, Start Parameters - ServiceManager.

1. Open the uc4.smd file found here : <automic>/Automation.Platform/ServiceManager/bin/uc4.smd and add the following line to the file and close:

DEFINE RULE-ENGINE;<automic>/External.Resources/flink/bin/start.sh;

<automic>/External.Resources/flink/bin

Step 4: Add the Rule Engine to the Service Manager SMC File

1. Open the uc4.smc  file found here: <automic>/Automation.Platform/ServiceManager/bin/uc4.smc andinsert the following two lines (in bold) and close and restart the service manager or simply start the RULE-ENGINE service:

   WAIT 10

   CREATE RULE-ENGINE

   WAIT 3

   CREATE ANALYTICS-DATASTORE

   WAIT 14

   CREATE ANALYTICS-BACKEND

   WAIT 3

   CREATE STREAMING-PLATFORM

   Note: This step can not be completed until you install the Analytics Backend. If you have not done this, take note of the following host and port configuration.

Step 5: Update the Configuration File

1. Some modifications must be made in the application.properties configuration file. This file can be found here: <automic>/Automation.Platform/Analytics/backend/application.properties

   Set the Flink installation via:

   flink.host=hostip

   Host where flink job manager runs.

    

   flink.web_port=8081

   The port that the Flink job manager web interface runs. This defaults to 8081 which is also the default setting of jobmanager.web.port in the flink-conf.yaml file.

    

   flink.monitoring_interval_seconds=60

   Interval in seconds (default 60) that is used for monitoring if the rules are still running on Flink.

    

   flink.monitoring_heartbeat_interval_minutes=3

   Interval in minutes (default 3) that is used for monitoring if there are abandoned rules running on Flink that should not run anymore.

    

   WARNING: To enable the external event ingestion, “collector.events.enabled”

   (false by default) needs to be enabled.

Step 6: Secure the Rule Engine (optional)

For more information, see TLS/SSL Setup and Configuration for the Rule Engine.