Prerequisites
Prerequisites
This page explains how to get the software you need to use on Linux or macOS for local development.
java 17
package or newergit
installeddocker
installed
Note: For contribution, you must have a
github
account.
For Linux
Install
OpenJDK 17
package or newer:
Check java version using the command
java -version
.
Note: In case OpenJDK 17 is not set as your default Java, run sudo update-alternatives --config java
command to list all installed Java versions.
you can set it as the default by entering the selection number for it in the list and pressing Enter. For example, to set Java 17 as the default, you would enter "3" and press Enter.
Install
git
:
Install
docker
:
To execute the docker
Command without sudo
:
For macOS
Install brew.
Install brew cask:
Install Eclipse Temurin 17 via Homebrew cask:
Verify Installation
Note: In case OpenJDK 17 is not set as your default Java, you can consider including it in your $PATH
after installation
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.
To check how much memory is allocated to docker, use docker info
.
You will find the total memory and used memory in the output. if you won't find used memory that means memory limits are not set for containers.
To allocate 4GB of memory for Docker:
MacOS
Edit docker daemon settings within docker dashboard
For Ubuntu
Open the Docker configuration file in a text editor using the following command:
Add the following line to the file to allocate 4GB of memory to Docker:
Save the file and exit the text editor.
Restart the Docker service using the following command:
Verify that the memory limit has been set correctly by running the following command:
Note that the warning messages are expected as they relate to the kernel not supporting cgroup memory limits.
Now any containers you run in docker will be limited to this amount of memory. You can also increase the memory limit as per your preference.
Where to go next
In the next section, you'll learn how to Build and Run kafka-ui.
Last updated