Orchesto on local Kubernetes in Docker Desktop

This guide describes how you can install Orchesto on your local machine running on Kubernetes in Docker Desktop.

Overview

Orchesto can be installed on your computer with Kubernetes on Docker Desktop. This is a great solution if you want to get started with Orchesto for non-production purposes without setting up a complex infrastructure on-prem or launching a cluster on your favourite cloud provider.

We are going to install Docker Desktop, enable Kubernetes and deploy Orchesto with a Helm chart.

Note: For the purpose of this document, Kubernetes on Docker Desktop can be replaced with another locally running Kubernetes distribution of choice - e.g., K3d or Minikube.

Step 1 - Get your trial Orchesto License

Activate a free of charge trial license for the product of you choice at https://portal.orchesto.io/user/login

A license key & product key is required during the installation of Orchesto. They can be downloaded as a simple JSON or copied & pasted to be used during installation.

Step 2 - Install and start Docker Desktop

Docker Desktop is available on Microsoft Windows and MacOS. Instructions for installing it for your operating systems are available here: download docker-desktop

Once installed, please launch Docker Desktop.

Step 3 - Enable Kubernetes

Now that you have docker-desktop running you can go ahead and enable Kubernetes.

Click on your Docker Desktop icon in your Systray and open settings.

Click on the Kubernetes panel in the left section and enable Kubernetes. This might take a couple of minutes depending on your system.

When Kubernetes is enabled, please go ahead and verify that the command kubectl is available. Open your terminal or Powershell and type:

$ kubectl get nodes
NAME             STATUS   ROLES    AGE   VERSION
docker-desktop   Ready    master   5m   v1.18.8

Step 4 - Install Helm

We ship our Kubernetes manifests with Helm.

There are several ways of installing Helm.

Download binary release

Binary releases of Helm are available from the official Helm repo release page

MacOS

On MacOS you can use the package manager brew and run:

$ brew install helm

More information on brew can be found on their website

Windows 10

Install with the choco package manager. More information on how to install choco is available on their website

$ choco install kubernetes-helm

Once Helm is installed you can verify that the command helm is available by running:

helm version
version.BuildInfo{Version:"v3.4.1", GitCommit:"c4e74854886b2efe3321e185578e6db9be0a6e29", GitTreeState:"clean", GoVersion:"go1.14.11"}

The output should look approximately as per the above.

Step 5 - Install Orchesto with our Helm chart

Preparation is now completed and you should have the following:

  1. A licenses key and a product key
  2. Docker Desktop installed and running
  3. Kubernetes enabled in docker desktop
  4. helm available on your commandline

Download our helm chart and unzip.

Open a terminal in the folder you unziped.

Add the ingress-nginx repo:

$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx

Install cert-manager in your cluster:

kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.0.4/cert-manager.yaml

Update helm chart dependencies:

$ helm dependency update

Install the helm chart:

$ helm install orchesto . --set license=<license key> --set product=<product key>

Step 6 - Initializing Orchesto

Once the deployment is done we can go ahead and initialize Orchesto.

Linux/MacOS

$  curl -k -X PUT -H "Content-Type: application/json" -d '{"token":"secret"}' https://localhost/orchesto/api/v1/admin/init

Windows 10, PowerShell 6+

Note that you need Powershell 6 or later!

$body = @{
    token= "token"
}
$body = $body | ConvertTo-Json

$url = "https://localhost/orchesto/api/v1/admin/init"

$response = Invoke-WebRequest -SkipCertificateCheck -Uri $url -Method "PUT" -WebSession $cookie -Body $body

echo $response

Orchesto will now display your Root Access credentials. Note that they are only displayed once and cannot be restored! Please store them in one or multiple safe places!

Step 7 - Configuring Orchesto

For detailed instructions how to login and configure Orchesto, please follow the manual for the Product of your choice:

Orchesto Cloud Encrypt