Link Search Menu Expand Document
Open Integration Hub

Minikube Development Guide

The minikube-based development setup enables users to bring up a local implementation of the OIH Framework based on the current service images found on Docker Hub, while individually selecting which services they would like to deploy from their own local source folders. linux Windows Mac

Requirements

Please make sure to clone the monorepo before you start.

The development environment requires:

  • minikube >= 1.23.0
  • kubectl
  • python3
  • curl
  • base64

Make sure that minikube is endowed with sufficient resources. We suggest at least:

  • 8GB of memory
  • 4 CPUs

The setup script will attempt to provision the minikube instance with these values by default on execution. This can be changed by altering the variables MK_MEMORY and MK_CPUS.

If you're using Windows we suggest to use virtual box. In order to use it, Hyper-V must be disabled Enable/Disable Hyper-V on Windows 10..You may also have to enable virtualisation features in you BIOS.
If you're using Docker for Desktop it overwrites the acutal kubectl version. This version is generally not compatible with minikube. There are two options to correct this:
  • Download the `kubectl.exe` from Install kubectl on Windows. Navigate to the docker directory (e.g. Program Files\Docker\Docker\resources\bin) andreplace the kubectl.exe in this folder with the one you just downloaded.
  • Use the "Edge" version of Docker Desktop. This can be done by installing the edge version of the application from the Docker Desktop site. If you already have Docker Desktop installed, you can switch to the Edge version from the Docker menu. Select Preferences > Command Line and then activate the Enable experimental features toggle. After selecting Apply & Restart, Docker will update versions. More information can be found here.
The OIH Framework requires the ingress addon for kubernetes. This is not supported via Docker Bridge for Mac and Windows on older versions of minikube. Therefore, minikube must be at a minimum version of 1.23.0. For older versions, you can refer to previous releases of the OIH framework(< 21.2.0) for the appropriate setup script. More information can be found on the minikube Github page.

Configuration

Before running the setup script, the location of your NFS server must be updated in ./1-Platform/2.1-sourceCodeVolume.yaml. The server host is the IP address which minikube uses to access the host. In order to verify your server address, you will need to start minikube and then execute the following command: minikube ssh grep host.minikube.internal /etc/hosts | cut -f1

The path is the path to the root of your cloned repository / base path of the framework

nfs:
    server: 192.168.64.1
    path: '/Users/user/projects/openintegrationhub'

Usage

From the $OIH_ROOT/dev-tools/minikube folder, call the setup script

bash ./setup.sh

The script will check for prerequisites, and attempt to build all services. The script automates the steps found in the minikube Local Installation Guide.

Additionally, the following options may be sent in the arguments to setup.sh.

  • -c: Clear Minikube. The minikube cluster will be deleted and rebuilt from scratch.

  • -s: Skip Deployment. Any service names which are provided as arguments to this flag will not be included in the running cluster. They will be temporarily deployed to ensure all dependencies are met, then deleted at the end of startup.

    Example: bash ./setup.sh -s meta-data-repository, snapshots-service

  • -d: Development Mode. Any service names which are provided as arguments to this flag will be deployed from the local source files. Instead of being deployed from the Docker Hub containers, a generic node container will be deployed, and the source directory will be mounted through NFS. Changes to the source files will be watched and reflected in the running containers.

    Example: bash ./setup.sh -d iam, component-orchestrator

  • -i: Use Custom Component Image. This setup automatically deploys a development connector and includes it in sample flows. To change the container which is used for this connector, include an image name here. (Default image: openintegrationhub/dev-connector:latest)

  • -p: Start Proxy. If this flag is set, then kubectl will set up proxy connections to Mongo, RabbitMQ, and Redis for use in debugging backend and messaging systems.