Merge pull request #745 from SurabhiAngadi/release-5.7.0

Issue KN-923 doc: Modified README.md file

transaction-event-processor/README.md

@@ -1,13 +1,13 @@
-# Audit Event Generator
+# Transaction Event Processor
 
-Audit Event Generator job generates an audit event for every transaction in Graph updation for content data modification
+Transaction Event Processor job generates an audit event for every transaction in Graph updation for content data modification. The job utilizes the neo4j mutation data to create an index of transactions for audit purposes. For each neo4j transaction, the job will audit the old and new values of the updated object.
 
 ## Getting Started
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a yarn or kubernetes.
 ### Prerequisites
 
-1. Download flink-1.13.6-scala_2.12 from [apache-flink-downloads](https://www.apache.org/dyn/closer.lua/flink/flink-1.13.6/flink-1.13.6-bin-scala_2.12.tgz). 
+1. Download flink-1.13.6-scala_2.12 from [apache-flink-downloads](https://www.apache.org/dyn/closer.lua/flink/flink-1.13.6/flink-1.13.6-bin-scala_2.12.tgz).
 2. Download [hadoop dependencies](https://repo.maven.apache.org/maven2/org/apache/flink/flink-shaded-hadoop-2-uber/2.8.3-10.0/flink-shaded-hadoop-2-uber-2.8.3-10.0.jar) (only for running on Yarn). Copy the hadoop dependency jar under lib folder of the flink download.
 3. export HADOOP_CLASSPATH=`<hadoop-executable-dir>/hadoop classpath` either in .bashrc or current execution shell.
 4. Docker installed.
@@ -24,7 +24,7 @@ mvn clean install
 Flink requires memory to be allocated for both job-manager and task manager. -yjm parameter assigns job-manager memory and -ytm assigns task-manager memory.
 
 ```
-./bin/flink run -m yarn-cluster -p 2 -yjm 1024m -ytm 1024m <knowledge-platform-jobs>/audit-event-generator/target/audit-event-generator-0.0.1.jar
+./bin/flink run -m yarn-cluster -p 2 -yjm 1024m -ytm 1024m <knowledge-platform-jobs>/transaction-event-processor/target/transaction-event-processor-0.0.1.jar
 ```
 
 ### Kubernetes
@@ -52,7 +52,7 @@ kubectl create -f knowledge-platform-job/kubernetes/taskmanager-deployment.yaml
 kubectl port-forward deployment/flink-jobmanager 8081:8081
 
 # Submit the job to the Kubernetes single node cluster flink-cluster
-./bin/flink run -m localhost:8081 <knowledge-platform-job>/audit-event-generator/target/audit-event-generator-0.0.1.jar
+./bin/flink run -m localhost:8081 <knowledge-platform-job>/transaction-event-processor/target/transaction-event-processor-0.0.1.jar
 
 # Commands to delete the pods created in the cluster
 kubectl delete deployment/flink-jobmanager
@@ -62,4 +62,4 @@ kubectl delete configmaps/flink-config
 
 # Command to stop the single-node cluster
 k3d stop --name="flink-cluster"
-```
+```