Skip to content

Commit 2d19b12

Browse files
authored
Updated building instructions (mvn -> gradle) (#43)
1 parent fafbe63 commit 2d19b12

File tree

3 files changed

+17
-26
lines changed

3 files changed

+17
-26
lines changed

Diff for: configuration/serialization-serde.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ If selected serde couldn't be applied (exception was thrown), then fallback (Str
185185

186186
You can implement your own serde and register it in kafbat-ui application. To do so:
187187

188-
1. Add `serde-api` dependency (should be downloadable via maven central)
188+
1. Add `serde-api` dependency, [link to maven central](https://central.sonatype.com/artifact/io.kafbat.ui/serde-api)
189189
2. Implement `io.kafbat.ui.serde.api.Serde` interface. See javadoc for implementation requirements.
190190
3. Pack your serde into uber jar, or provide directory with no-dependency jar and it's dependencies jars
191191

Diff for: development/building/with-docker.md

+15-24
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,29 @@ Once you installed the prerequisites and cloned the repository, run the followin
66

77
### Step 1 : Build
88

9-
> Skip the maven tests as they might not be successful
10-
119
* Build a docker image with the app
1210

1311
```
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>
2321
```
2422

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.
3324
### Step 2 : Run
3425

3526
**Using Docker Compose**
3627

3728
* Start the app using docker image built in step 1 along with Kafka clusters:
3829

3930
```
40-
docker-compose -f ./documentation/compose/kafbat-ui.yaml up -d
31+
docker-compose -f ./.dev/dev.yaml up -d
4132
```
4233

4334
**Using Spring Boot Run**
@@ -51,20 +42,20 @@ docker-compose -f ./documentation/compose/kafka-clusters-only.yaml up -d
5142
* Then start the app.
5243

5344
```
54-
./mvnw spring-boot:run -Pprod
45+
./gradlew bootRun -x test
5546
5647
# or
5748
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
5950
```
6051

6152
**Running in kubernetes**
6253

6354
* Using Helm Charts
6455

6556
```
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
6859
```
6960

7061
To read more please follow to chart documentation.

Diff for: development/building/without-docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ java -Dspring.config.additional-location=<path-to-application-local.yml> --add-o
2222

2323
> _**NOTE:**_ If you want to get kafbat-ui up and running locally quickly without building the jar file manually, then just follow Running Without Docker Quickly
2424
25-
> Comment out `docker-maven-plugin` plugin in `api` module `pom.xml`
25+
Proceed with building instructions from [[with-docker]] and disable/remove `build-docker-images` flag.
2626

2727
* Command to build the jar
2828

0 commit comments

Comments
 (0)