Skip to content

Environment Setup

This guide will help you set up your development environment for aletyx Build of Apache KIE X. We'll cover installation and configuration of all required tools and dependencies.

Prerequisites Overview

The following tools are required for development:

  • Java 17 (Eclipse Temurin, Amazon Corretto, or other community distribution)
  • Maven 3.9.6 or higher
  • Git
  • Container runtime (Docker or Podman)
  • Kubernetes tools (kubectl)
  • OpenShift CLI (oc)
  • VS Code with extensions

Package Manager Setup

If possible, to simplify the configurations, we recommend the usage of Package Managers like Homebrew, Chocolatey, or Apt to get the required elements for your environment. This is not required, but greatly simplifies the process.

  1. Open PowerShell as Administrator (Right-click, "Run as Administrator")

  2. Install Chocolatey:

    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

  3. Verify installation:

    choco --version

  1. Install Homebrew: 

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. Add Homebrew to your PATH:

    1. For Apple Silicon Macs 

      echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc

    2. For Intel Macs 

      echo 'eval "$(/usr/local/bin/brew shellenv)"' >> ~/.zshrc

  3. Reload your shell configuration: 

    source ~/.zshrc

Linux generally comes with its package manager, but ensure it's up to date:

    sudo apt update && sudo apt upgrade

Initial Java Setup with Maven

We recommend using Eclipse Temurin (formerly AdoptOpenJDK) 17 for development:

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Java
brew install --cask temurin17

# Install Maven
brew install maven

# Install Java
sudo apt-get update
sudo apt-get install -y temurin-17-jdk

# Install Maven
sudo apt-get install maven

# Using Chocolatey
choco install temurin17
choco install maven

# Install SDKMAN!
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

# Install Java and Maven
sdk install java 17.0.10-tem
sdk install maven 3.9.9

# Install SDKMAN!
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

# Install Java and Maven
sdk install java 17.0.10-tem
sdk install maven 3.9.9

Container Runtime

brew install --cask docker

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Download and install Docker Desktop

brew install podman
podman machine init
podman machine start

sudo apt-get update
sudo apt-get install -y podman

Download and install Podman Desktop