kafka-ui/documentation/project/contributing/prerequisites.md
Jochen Schalanda 62f35e3e29
Upgrade to Java 17 (Azul Zulu) (#2879)
* Feature: Upgrade to Java 17 (Azul Zulu)

Java/OpenJDK 13 has reached end of life (and end of security support)
more than 2.5 years ago: https://endoflife.date/java

This change set updates the build, CI pipeline, and Docker image of Kafka UI to Java 17 (LTS).

* Add back maven-compile-plugin to kafka-ui-e2e-checks
2022-11-07 14:57:59 +04:00

42 lines
1,003 B
Markdown

### 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` 17 or newer
* `Git`
* `Docker`
### Installing prerequisites on macOS
1. Install [brew](https://brew.sh/).
2. Install brew cask:
```sh
brew cask
```
3. Install Eclipse Temurin 17 via Homebrew cask:
```sh
brew tap homebrew/cask-versions
brew install temurin17
```
4. Verify Installation
```sh
java -version
```
Note : In case OpenJDK 17 is not set as your default Java, you can consider to include it in your `$PATH` after installation
```sh
export PATH="$(/usr/libexec/java_home -v 17)/bin:$PATH"
export JAVA_HOME="$(/usr/libexec/java_home -v 17)"
```
## 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).