Environment setup

This guide lists the different ways to set up your environment for OpenShift Serverless Logic development. If you are new, start with the minimal one.

Minimal local environment setup

Recommended steps to setup your local development environment. By completing these steps you are able to start the development on your local machine using our guides.

Procedure

  1. Install Docker or Podman.

  2. Install minikube or kind.

  3. Install Kubernetes CLI.

  4. Install Knative using quickstart. This will also setup Knative Serving and Eventing for you and the cluster should be running.

  5. Install the Serverless Logic Operator

  6. Install Knative Workflow CLI.

  7. Install Visual Studio Code with our extension that simplifies development of workflows by provifing visual aids and auto-complete features.

Starting the cluster for local development

If you have used Knative using quickstart guide, your selected cluster should be running and properly configured to work with our guides.

Please note, that if the knative quickstart procedure is not used, you need to install Knative Serving and Eventing manually. See Additional options for environment setup.

  • Minikube

  • Kind

Configure and startup minikube
# Set a driver and container runtime
minikube config set driver docker/podman
minikube config set container-runtime docker/podman

# Set cpu and memory
# 4096 is minimal baseline, increase to 6144 or 8192 if possible
minikube config set cpus 4
minikube config set memory 4096

# Start the cluster
minikube start --cpus 4 --memory 4096 --addons registry --addons metrics-server --insecure-registry "10.0.0.0/24" --insecure-registry "localhost:5000"

# Set the active profile
minikube profile minikube
Start a kind cluster
kind create cluster

Advanced local environment setup

If you are interested in our Java and Quarkus development path, consider completing this procedure in addition to the Minimal local environment setup. By completing these steps you are able to start the development of applications on your local machine using our advanced developer guides.

Procedure

  1. Install OpenJDK 17+ and cofigure JAVA_HOME appropriately by adding it to the PATH.

  2. Install Apache Maven 3.9.6.

  3. Install Quarkus CLI corresponding to currently supported version by OpenShift Serverless Logic. Currently it is 3.2.9.Final-redhat-00003.

Additional options for environment setup

Points listed in this section provide extra posibilties when working with our guides and are considered optional.

  • Install GraalVM 22.3.0. This will allow you to create native image of your OpenShift Serverless Logic application.

  • Install Knative Serving for advanced customizations or in cases where you are working with Openshift.

  • Install Knative Eventing for advanced customizations or in cases where you are working with Openshift.

Additional resources

Found an issue?

If you find an issue or any misleading information, please feel free to report it here. We really appreciate it!