@@ -6,38 +6,29 @@ Once you installed the prerequisites and cloned the repository, run the followin
6
6
7
7
### Step 1 : Build
8
8
9
- > Skip the maven tests as they might not be successful
10
-
11
9
* Build a docker image with the app
12
10
13
11
```
14
- ./mvnw clean install -Pprod
15
- ```
16
-
17
- * if you need to build the frontend module, go to
18
- * frontend-build-documentation
19
- * In case you want to build ` api ` module by skipping the tests
20
-
21
- ```
22
- ./mvnw clean install -Dmaven.test.skip=true -Pprod
12
+ ./gradlew clean build \
13
+ # -x skips goals, in this cases tests. Tests take time, run them separately if needed.
14
+ -x test \
15
+ # building an app without frontend part could be useful for developing frontend or for using the app like an API client
16
+ -Pinclude-frontend=true \
17
+ # skip building a docker image if you only need a jar
18
+ -Pbuild-docker-images=true \
19
+ # version will be displayed in UI and used for tagging docker image. You can remove it.
20
+ -Pversion=<version>
23
21
```
24
22
25
- * To build only the ` api ` module you can use this command:
26
-
27
- ```
28
- ./mvnw -f api/pom.xml clean install -Pprod -DskipUIBuild=true
29
- ```
30
-
31
- If this step is successful, it should create a docker image named ` ghcr.io/kafbat/kafka-ui ` with ` latest ` tag on your local machine except macOS M1.
32
-
23
+ A successful build should produce a docker image named ` ghcr.io/kafbat/kafka-ui ` with whatever version you've supplied.
33
24
### Step 2 : Run
34
25
35
26
** Using Docker Compose**
36
27
37
28
* Start the app using docker image built in step 1 along with Kafka clusters:
38
29
39
30
```
40
- docker-compose -f ./documentation/compose/kafbat-ui .yaml up -d
31
+ docker-compose -f ./.dev/dev .yaml up -d
41
32
```
42
33
43
34
** Using Spring Boot Run**
@@ -51,20 +42,20 @@ docker-compose -f ./documentation/compose/kafka-clusters-only.yaml up -d
51
42
* Then start the app.
52
43
53
44
```
54
- ./mvnw spring-boot:run -Pprod
45
+ ./gradlew bootRun -x test
55
46
56
47
# or
57
48
58
- ./mvnw spring-boot:run -Pprod -Dspring.config.location=file:///path/to/conf.yaml
49
+ ./gradlew bootRun -x test -Dspring.config.location=file:///path/to/conf.yaml
59
50
```
60
51
61
52
** Running in kubernetes**
62
53
63
54
* Using Helm Charts
64
55
65
56
```
66
- helm repo add kafbat-ui https://kafbat.github.io/helm-charts
67
- helm install kafka -ui kafka-ui /kafka-ui
57
+ helm repo add kafbat https://ui.charts.kafbat.io
58
+ helm install kafbat -ui kafbat /kafka-ui
68
59
```
69
60
70
61
To read more please follow to chart documentation.
0 commit comments