Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 4.66 KB

preparing-environment.adoc

File metadata and controls

107 lines (84 loc) · 4.66 KB
Raw

Environment setup

This guide lists the different ways to set up your environment for {product_name} development. If you are new, start with the minimal one.

Prerequisites

Minimal local environment setup

Recommended steps to set up 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 set up Knative Serving and Eventing for you and the cluster should be running.

  5. Install the {operator_name} manually.

  6. Install Knative Workflow CLI.

  7. Install Visual Studio Code with our extension that simplifies development of workflows by providing 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 local environment setup.

Example 1. To start up the selected cluster without quickstart, use the following command:
Minikube with Docker
Configure and startup minikube with Docker
# Set a driver and container runtime
minikube config set driver docker
minikube config set container-runtime docker

# Start the cluster
# Set the memory to at least 4096, increase to 6144 or 8192 if possible
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 knative
Minikube with Podman
Configure and startup minikube with Podman
# Set a driver and container runtime
minikube config set driver podman
minikube config set container-runtime podman

# Start the cluster
# Set the memory to at least 4096, increase to 6144 or 8192 if possible
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 knative
Kind
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 {java_min_version} and configure JAVA_HOME appropriately by adding it to the PATH.

  2. Install Apache Maven {maven_min_version}.

  3. Install Quarkus CLI corresponding to the currently supported version by {product_name}. Currently, it is {quarkus_version}.

Additional options for local environment setup

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