This topic provides the systematic instructions to install Zookeeper cluster setup.

1. Untar/unzip the kafka binary and move them to the folder that will be the kafka home directory.
2. The user should create three folders, named node1, node2, and node3, in the Kafka parent directory for unzipping the Kafka binary. Kafka and Zookeeper will store their logs in these folders. Create two subfolders, named kafka-logs and zookeeper, in each of these folders.

   Note:

   Clear the logs folder if it is already present.
3. In the zookeeper folder of every nodeX(e.g. node1), create a myid file without any file extension. e.g. <Kafka-Home>/node1/zookeeper/myid
   The myid file contains a single line text of machine ID. The server 1 myid has the text as 1 and nothing else, similarly for server 2 and 3 will contain value as 2 and 3 respectively. The ID must be unique within the ensemble and have a value between 1 and 255.
4. Edit the configuration file named zookeeper.properties at <kafka home directory> /kafka_2.13-3.7.0/config. Inside kafka/config folder there would be a file named zookeeper.properties, copy that and create three similar files zookeeper1.properties, zookeeper2.properties, zookeeper3.properties.
5. Add the below set of properties and values to the file.

   dataDir= <kafka home directory>/nodeX/zookeeper
   e.g. node1/zookeeper
   tickTime=2000
   clientPort= Zookeeper client Port value (2181)
   initLimit=10
   syncLimit=5
   
   server.1=<hostname> :< peer port> :< leader port>
   #1 is the id that we put in myid file.
   
   server.2= <hostname> :< peer port> :< leader port>
   #2 is the id that we will put in myid file of second
   node
   
   server.3=<hostname> :< peer port> :< leader port>
   #3 is the id that we will put in myid file of third

   Note:

   Any odd number of zookeeper servers can be configured under the cluster. The properties with the key as server.x are only required if you want to have a multinode kafka setup..
6. Start the zookeeper on each node machine.
7. Navigate to <kafka home directory>/kafka_2.13-3.7.0 and execute the below command.

   /bin/zookeeper-server-start.sh /config/zookeeper1.properties

   /bin/zookeeper-server-start.sh /config/zookeeper2.properties

   /bin/zookeeper-server-start.sh /config/zookeeper3.properties

8. To see the leader and followers in the cluster, run the below command on each node.

   echo stat | nc localhost 2181

9. To check the zoo cluster functioning (dynamic leader election), kill the zookeeper process on the leader node and check again with the below command on the remaining live zookeeper node.

   echo stat | nc localhost 2181

This topic provides the systematic instructions for Kafka cluster setup.

1. Untar/unzip the kafka binary and move them to the folder that will be the kafka home directory.
2. User can create three folders in the directory where kafka folder is present. User can name them as node1, node2, node3. These folders are for storing kafka and zookeeper logs. Within each of these folders, create two folders called kafka-logs and zookeeper.

   Note:

   Please skip the above two steps if already completed during Zookeeper setup.

3. Navigate to <kafka home directory>/kafka_2.13-3.7.0/Inside kafka/config folder, there would be a file named server.properties, copy that and create three similar files server1.properties, server2.properties, server3.properties.Edit the below lines in the <kafka home directory>/kafka_2.13-3.7.0/config/server1.properties,server2.properties,server3.properties

   broker.id= 0 for node1, broker.id= 1 for node2, broker.id= 2 for node3(Unique Integer which identifies the kafka broker in the
   cluster.)
   listeners=PLAINTEXT://<hostname>:<Kafka broker listen port for server1 use port as 9092,server2 use port as 9093 and server3 use 9094 port.
   log.dirs=<kafka home directory>/nodeX/kafka-logs
   e.g. node1/kafka-logs
   log.retention.hours= <The number of hours to keep a log file before
   deleting it (in hours),tertiary to log.retention.ms property>
   log.retention.bytes= <The maximum size of the log before deleting it>
   log.segment.bytes= <The maximum size of a single log file>
   log.retention.check.interval.ms= <The frequency in milliseconds that
   the log cleaner checks whether any log is eligible for deletion>
   zookeeper.connect=<zookeeper_hostname_1>:<zookeeper_client_port>,<zook
   eeper_hostname_2>:<zookeeper_client_port>,<zookeeper_hostname_3>:<zook
   eeper_client_port>,
   offsets.topic.replication.factor=3
   offsets.topic.min.insync.replicas=2
   transaction.state.log.replication.factor=3
   transaction.state.log.min.isr=2
   min.insync.replicas=2

   Note:

   For the setup to work properly, atleast two kafka nodes should be up and running at every point of time.
4. To start the kafka, navigate to <kafka home directory>/kafka_2.13-3.7.0/ folder and run the below commands on each node.

   export JMX_PORT=[PORT VALUE1]
   nohup bin/kafka-server-start.sh config/server1.properties &
   

   export JMX_PORT=[PORT VALUE2]
   nohup bin/kafka-server-start.sh config/server2.properties &

   export JMX_PORT=[PORT VALUE3]
   nohup bin/kafka-server-start.sh config/server3.properties &

   The Default value of JMX Port is 9999.

   Tail the log for server status.

5. To create topic, navigate to <kafka home directory>/kafka_2.13-3.7.0/ folder and run the below command.

   /bin/kafka-topics.sh --create --bootstrap-server <hostname>:<client port>, <hostname>:<client port>, <hostname>:<client port> --replication-factor 3 --partitions 3 --topic <topic name>

6. To list the available topic on kafka server, navigate to <kafka home directory>/kafka_2.13-3.7.0/ folder and run the below command.

   ./bin/kafka-topics.sh --list --bootstrap-server <hostname>:<port>, <hostname>:<port>, <hostname>:<port>

7. To describe the topic, navigate to <kafka home directory>/kafka_2.13-3.7.0/ folder and run the below command.

   ./bin/kafka-topics.sh --describe --topic <topic name> --bootstrap-server <hostname>:<port>,<hostname>:<port>,<hostname>:<port>

8. To start a producer, navigate to <kafka home directory>/kafka_2.13-3.7.0/ folder and run the below command.

   export JMX_PORT=[PORT VALUE]//Different Value from the server
   JMX port
   
   ./bin/kafka-console-producer.sh --broker-list
   <hostname>:<port>, <hostname>:<port>, <hostname>:<port> topic <topic name>

   Note:

   By default, port is taken as 9092 for the producer.
9. To start a consumer console for viewing the received messages sent by the producer, use the following command.

   export JMX_PORT=[PORT VALUE]//Different Value from the server
   JMX port
   
   ./bin/kafka-console-consumer.sh --bootstrap-server
   <hostname>:<port>,<hostname>:<port>,<hostname>:<port> --topic <topic_name> --
   from-beginning

Configure a Standalone Kafka Instance in Cluster Mode

If there is already a standalone Kafka instance with Oracle Banking Microservices Architecture services running on it, it is expected the topics are already created in the Kafka instances. In this case, use the below steps to enable replication of messages between Kafka brokers:

10. Download and edit the increase.json to have all the topics and their replication confirmation updated.
    Example: If you have a 3 node setup, the json will look like the attached sample. It is ideal to have the number of replicas equal to the number of brokers.

    {"version":1,
      "partitions":[
         {"topic":"<Topic Name>","partition":0<if there is just one partition, else there has to be a 
         different record for each partition per topic>,"replicas":[comma separated list of broker ids]}
    ]}

11. Run the following command
    .\bin\windows\kafka-reassign-partitions.bat --bootstrap-server localhost:9092 --reassignment-json-file increase.json --execute

This topic describes about the Kafka Security setup.

keytool -genkeypair -alias alias -keyalg keyalg -keysize keysize -sigalg 
sigalg -validity valDays -keystore keystore

keytool -genkeypair -alias certificates -keyalg RSA -keysize 1024 -sigalg SHA512withRSA 
-validity 365 -keystore /scratch/Data/Certificates/KafkaServerKeystore.jks

keytool -export -alias <alias_name> -file <export_certificate_file_name_with_location.cer> 
-keystore <keystore_name.jks> -keypass <Private key Password> -storepass <Store Password>

keytool -export -alias certs -file /scratch/Data/Certificates/KafkaCert.cer 
-keystore /scratch/Data/Certificates/KafkaServerKeystore.jks -keypass oracle123 
-storepass oracle123

keytool -import -alias alias -file cert_file -keystore truststore –storepass storepass

keytool -import -alias certs -file /scratch/Data/Certificates/KafkaCert.cer 
–keystore /scratch/Data/Certificates/KafkaServerTrustStore.jks -storepass oracle123

keytool -import -alias certs -file /scratch/Data/Certificates/KafkaCert.cer 
-keystore /scratch/Data/Certificates/KafkaClientTrustStore.jks -storepass oracle123

./kafka-console-consumer.sh --bootstrap-server kafka-server --topic topicName 
--consumer.config absolute-path-of-consumer-config --from-beginning

./kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic test_topic 
--consumer.config =/scratch/kafka/config/ssl.properties --from-beginning

This topic provides the systematic instructions for Kafka cluster setup.

This topic describes systematic instructions of Tesseract installation.

sudo yum install <LIBRARY_NAME>

This topic provides the systematic instructions to install conductor.

1. Set the required properties in the config.properties file found in {unzip the file} THIRD_PARTY_SOFTWARES\CONDUCTOR_SERVER\CONFIG.
   Refer to the following table to find the description of properties in the config.properties. This file should be placed at <<CONFIG.PROPERTIES LOCATION >>.
2. An additional environment variable is required for setting up the conductor. Include the below mentioned –Dparam along with the existing environment variables.

   -Dconductor.properties = << CONFIG.PROPERTIES LOCATION >>/config.properties

3. Deploy the conductor-server.war file in the weblogic.
   To deploy application, refer to Deploy Application section in Configuration and Deployment Guide.
4. To control the Log Level, the following property has to be added as a –Dparam along with the existing environment variables:
   -Dplato.conductor.logging.level = << LOG-LEVEL >>

   By default, the log level is “DEBUG”. To obtain only ERROR logs value has to be given as “ERROR” and to completely switch of conductor logs, the value has to be set as “OFF”.

   Table 10-6 config.properties

   Property Name	Property Description
   flyway.enabled	Set this to true to enable flyway and false to disable flyway.
   flyway.setbaselineOnMigrate	Set this to true to enable flyway baselineOnMigrate and false to disable.
   eureka.registration.enabled rpm -ivh	Should be set to true to enable discovery registration.
   eureka.hostName	plato-o
   eureka.instanceId	plato-o:<port-number>
   eureka.serviceUrl.default	Discovery service URL (http://<hostname>:<port>/plato-discovery-service/eureka)
   eureka.registerWithEureka	true
   eureka.name	plato-o
   eureka.vipAddress	plato-o
   eureka.port	Port Number on which the conductor server war file is deployed.
   conductor.entity.list	DEFAULTENTITY~jdbc/PLATO-O DEFAULTENTITY is entity Id jdbc/PLATO-O is JNDI name of Conductor Datasource The entity added, need to make changes in this property. Multiple entities can be added using “,” as a delimiter. For example, ENTITY1~jdbc/PLATO-O1, ENTITY2~jdbc/PLATO-O2
   workflow.elasticsearch.instanceType	EXTERNAL
   multi.entity.enabled	By default, it is false. To enable multi-entity, set it to true.
   decider.sweep.disable	true
   db	oracle
   isSSLenabled	By default, it is false. To enable SSL, set it to true
   security.protocol	Kafka SSL property. Valid only if SSL is enabled. Value has to be set as SASL_SSL
   ssl.truststore.location ssl.truststore.password sasl.mechanism sasl.jaas.config	All are kafka SSL related properties. These are valid only if SSL is enabled. ALL ARE ENVIRONMENT SPECIFIC.

   Note:

   If ssl enabled is true then: For plato-orch-service, in properties table update the key

   plato.orchestration.uri as https

   example: plato.orchestrator.uri = https://100.76.138.119/plato-orch/api/

   If ssl enabled is false then: For plato-orch-service, in properties table update the key

   plato.orchestration.uri as http

   example: plato.orchestrator.uri = http://100.76.138.119/plato-orch/api/

This topic provides the systematic instructions to install report service.

Install setUserOverrides.sh file

Perform the following steps:

1. Create a file called setUserOverrides.sh inside the Web Logic bin location.
2. The following formats of the setUserOverrides.sh file and the list of parameters that need to be passed to run the plato services properly.

   Note:

   Below are the list of -D params (ENV Variables), which needs to be set for all the individual services. Set a single –Dparam as follows:

   JAVA_OPTIONS="${JAVA_OPTIONS} -DParam =<ParamValue>”

   export JAVA_OPTIONS

   //Plato Report Service

   -Dflyway.domain.placeholders.report-service.hostname=<http://<REPORT_SERVOICE_HOSTNAME>:<REPORT_SERVICE_PORT>/report-service/api/>

   -Dflyway.domain.placeholders.report-service.server.port=<REPORT_SERVICE_PORT>

   -Dflyway.domain.placeholders.report-service.domain.jndi=<JNDI_SCHEMA>

   -Dflyway.domain.placeholders.report-service.template-metadata-directory=/scratch/OBMA/report-service/template_metadata

   -Dflyway.domain.placeholders.report-service.output-directory=/scratch/OBMA/report-service/output/

   -Dflyway.domain.placeholders.report-service.fop-config-file=/scratch/OBMA/report-service/fop.xconf

Plato Reporting Deployment Order

Figure 10-1 Plato Reporting Deployment Order

Description of "Figure 10-1 Plato Reporting Deployment Order"

Table 10-8 Installation Summary for Plato Reporting Service:

Application	Archive name	OSDC path	Targets
sms-core-Service	sms-core-Service-{version}.war	{unzip the file}PLATO\sms-core-service\	Sms-core-Service
cmc-base-services	cmc-base-services-{version}.war	{unzip the file}PLATO\cmc-base-service\	cmc-base-Service
cmc-branch-services	cmc-branch-services-{version}.war	{unzip the file}PLATO\cmc-branch-service\	cmc-branch-Service
cmc-currency-services	cmc-currency-services-{version}.war	{unzip the file}PLATO\cmc-currency-service\	cmc-currency-Service
cmc-component-server	cmc-component-services-{version}.war	{unzip the file}PLATO\cmc-component-service\	cmc-component-Service
plato-report-Services	plato-report-Services-{version}.war	{unzip the file}PLATO\plato-report-services\	Plato-report-Server
sms-component-server	sms-component-services-{version}.war	{unzip the file}PLATO\sms-component-service\	sms-component-Service

Note:

Refer to OSDC file for the exact version number for each service.