Skip to main content

Kubernetes

info

This guide has been tested on minikube.

Step 1 - Prerequisites​

  1. A local cluster. There are multiple options to run a local cluster:

    1. docker-for-desktop
    2. kind
    3. microk8s
    4. minikube
warning

A local cluster is only required when you want to test the Kubernetes deployment on a local environment. If you are planning to deploy on a live Kubernetes infrastructure, skip this first step and check the necessary additional configuration of Volumes, Networking, or General configuration.

  1. kubectl, with a correct kubeconfig. Check your installation with kubectl version.
  2. helm cli. Check your installation with helm version.

Step 2 - Installation​

  1. Add the repo:
    helm repo add exivity https://charts.exivity.com
info

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages.

  1. Verify the repo is added: 
    helm search repo exivity
  2. Create a namespace: 
    kubectl create ns exivity-quickstart
  3. Install the helm-chart: 
    helm install -n exivity-quickstart exivity-quickstart exivity/exivity --set licence=”you-very-long-licencekey”
Licence key

Reach out to us for a demo licence key.

tip

If you want to add dummy data to your deployment for testing purposes, you can add the following parameter to your command above:

--set service.dummyData.enabled=true
note

Take a look at the values.yaml file in case you want to customise certain components.

Step 3 - Verifying Installation​

  1. Follow the official Kubernetes instructions to make sure ingress is working; for example on minikube this can be done with:

    minikube addons enable ingress

  2. Get the IP for your minikube instance by running:

    minikube ip

  3. Add a DNS record to your hosts file by appending the following to the file, replacing the IP with the result from the minikube ip command:

    0.0.0.0    exivity
Linux

On Linux, the hosts file is located at: /etc/hosts

Windows

On Windows, the hosts file is located at: C:\Windows\System32\drivers\etc\hosts

info

You might need admin rights to edit this file.

  1. Browse to exivity
  2. Log in using these credentials 
    username: admin
    password: exivity
info

If you are using MacOS, the steps above will not work, therefore, follow these instructions:

  1. Run minikube ssh to ping the minikube IP and the domain name you mapped to that IP in /etc/hosts
  2. Map the domain names to 127.0.0.1 in /etc/hosts (instead of the ingress assigned IP) and use ingress components to control the domain-name -> service mappings
  3. Run sudo minikube tunnel to create tunneling for any existing or new ingress components. This combined with the ingress rules will mimic the host header style connecting to any domain resolving to the local host.

Removing Installation​

To uninstall the chart:

helm delete <chart-name>

To delete the PVCs (Persistent Volume Claims) associated with the release:

kubectl delete pvc -l app.kubernetes.io/instance=exivity