-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhance documentation regarding arm/m1 (#2453)
* Update docs to help Apple Mac M1 Users * Update missing information about * building react app * Update prerequisites docs Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
- Loading branch information
Showing
6 changed files
with
96 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,70 @@ | ||
### Building the application locally | ||
# Build & Run | ||
|
||
Once you installed the prerequisites and cloned the repository, run the following commands in your project directory: | ||
Once you installed the prerequisites and cloned the repository, run the following steps in your project directory: | ||
|
||
Build a docker container with the app: | ||
## Step 1 : Build | ||
> **_NOTE:_** If you are an macOS M1 User then please keep in mind below things | ||
> Make sure you have ARM supported java installed | ||
> Skip the maven tests as they might not be successful | ||
> Comment out `com.spotify` plugin in `kafka-ui-api` pom file | ||
> Once your build is successful you need to create docker image manually as you'd commented `com.spotify` plugin | ||
> ```docker build --platform linux/arm64 -t provectuslabs/kafka-ui:latest --build-arg JAR_FILE=kafka-ui-api-0.0.1-SNAPSHOT.jar .``` | ||
|
||
- if you need to build the frontend `kafka-ui-react-app`, go here | ||
- [kafka-ui-react-app-build-documentation](../../../kafka-ui-react-app/README.md) | ||
|
||
- Build a docker image with the app | ||
```sh | ||
./mvnw clean install -Pprod | ||
``` | ||
|
||
- In case you want to build `kafka-ui-api` by skipping the tests | ||
```sh | ||
./mvnw clean install -Dmaven.test.skip=true -Pprod | ||
``` | ||
Start the app with Kafka clusters: | ||
|
||
- To build only the `kafka-ui-api` you can use this command: | ||
```sh | ||
./mvnw -f kafka-ui-api/pom.xml clean install -Pprod -DskipUIBuild=true | ||
``` | ||
|
||
If this step is successful, it should create a docker image named `provectuslabs/kafka-ui` with `latest` tag on your local machine except macOS M1. | ||
|
||
## Step 2 : Run | ||
#### Using Docker Compose | ||
> **_NOTE:_** If you are an macOS M1 User then you can use arm64 supported docker compose script `./documentation/compose/kafka-ui-arm64.yaml` | ||
- Start the `kafka-ui` app using docker image built in step 1 along with Kafka clusters: | ||
```sh | ||
docker-compose -f ./documentation/compose/kafka-ui.yaml up -d | ||
``` | ||
To see the app, navigate to http://localhost:8080. | ||
``` | ||
|
||
If you want to start only kafka clusters (to run the app via `spring-boot:run`): | ||
#### Using Spring Boot Run | ||
- If you want to start only kafka clusters (to run the `kafka-ui` app via `spring-boot:run`): | ||
```sh | ||
docker-compose -f ./documentation/compose/kafka-clusters-only.yaml up -d | ||
``` | ||
- Then start the app. | ||
```sh | ||
./mvnw spring-boot:run -Pprod | ||
|
||
Then, start the app. | ||
|
||
### Building only the API | ||
# or | ||
|
||
To build only the kafka-ui-api you can use this command: | ||
```sh | ||
./mvnw -f kafka-ui-api/pom.xml clean install -Pprod -DskipUIBuild=true | ||
./mvnw spring-boot:run -Pprod -Dspring.config.location=file:///path/to/conf.yaml | ||
``` | ||
|
||
## Where to go next | ||
|
||
In the next section, you'll [learn how to run the application](running.md). | ||
#### Running in kubernetes | ||
- Using Helm Charts | ||
```sh bash | ||
helm repo add kafka-ui https://provectus.github.io/kafka-ui | ||
helm install kafka-ui kafka-ui/kafka-ui | ||
``` | ||
To read more please follow to [chart documentation](../../../charts/kafka-ui/README.md). | ||
|
||
## Step 4 : Access Kafka-UI | ||
- To see the `kafka-ui` app running, navigate to http://localhost:8080. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
### Prerequisites | ||
|
||
This page explains how to get the software you need to use a Linux or macOS | ||
machine for local development. | ||
|
||
Before you begin contributing you must have: | ||
|
||
* A GitHub account | ||
* `Java` 13 or newer | ||
* `Git` | ||
* `Docker` | ||
|
||
### Installing prerequisites on macOS | ||
1. Install [brew](https://brew.sh/). | ||
2. Install brew cask: | ||
```sh | ||
brew cask | ||
``` | ||
3. Install JDK 13 via Homebrew cask: | ||
```sh | ||
brew tap adoptopenjdk/openjdk | ||
brew install adoptopenjdk13 | ||
``` | ||
4. Verify Installation | ||
```sh | ||
java -version | ||
``` | ||
Note : In case JAVA13 is not set as your default Java then you can consider to include JAVA13 in your PATH after installation | ||
```sh | ||
export PATH="/Library/Java/JavaVirtualMachines/adoptopenjdk-13.jdk/Contents/Home/bin:$PATH | ||
``` | ||
## Tips | ||
Consider allocating not less than 4GB of memory for your docker. | ||
Otherwise, some apps within a stack (e.g. `kafka-ui.yaml`) might crash. | ||
## Where to go next | ||
In the next section, you'll [learn how to Build and Run kafka-ui](building.md). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.