You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: metadata-jobs/mae-consumer-job/README.md
+16-8Lines changed: 16 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -17,35 +17,43 @@ Today the job consumes from two important Kafka topics:
17
17
> Where does the name **Metadata Audit Event** come from? Well, history. Previously, this job consumed
18
18
> a single `MetadataAuditEvent` topic which has been deprecated and removed from the critical path. Hence, the name!
19
19
20
-
## Pre-requisites
21
-
* You need to have [JDK8](https://www.oracle.com/java/technologies/jdk8-downloads.html)
22
-
installed on your machine to be able to build `DataHub Metadata Service`.
20
+
## Prerequisites
21
+
22
+
Follow the [main developer guide](../../docs/developers.md)to set up your development environment and install the required dependencies.
23
23
24
24
## Build
25
+
25
26
`Metadata Audit Event Consumer Job` is already built as part of top level build:
26
-
```
27
+
28
+
```shell
27
29
./gradlew build
28
30
```
31
+
29
32
However, if you only want to build `MAE Consumer Job` specifically:
30
-
```
33
+
34
+
```shell
31
35
./gradlew :metadata-jobs:mae-consumer-job:build
32
36
```
33
37
34
38
## Dependencies
35
-
Before starting `Metadata Audit Event Consumer Job`, you need to make sure that [Kafka, Schema Registry & Zookeeper](../../docker/kafka-setup),
36
-
[Elasticsearch](../../docker/elasticsearch), and [Neo4j](../../docker/neo4j) Docker containers are up and running.
39
+
40
+
Before starting `Metadata Audit Event Consumer Job`, you need to make sure that all backend services, including Kafka and ElasticSearch, are up and running. If GMS is healthy, then Kafka and ElasticSearch should be healthy as well.
37
41
38
42
## Start via Docker image
43
+
39
44
The quickest way to try out `Metadata Audit Event Consumer Job` is running the [Docker image](../../docker/datahub-mae-consumer).
40
45
41
46
## Start via command line
47
+
42
48
If you do modify things and want to try it out quickly without building the Docker image, you can also run
43
49
the application directly from command line after a successful [build](#build):
0 commit comments