Skip to main content

Installation

To get started quickly, we recommend to run VILLAS in a small Kubernetes cluster.

important

There are dedicated installation instructions for VILLASnode in case you only want to use the simulation gateway instead of the full framework.

For beginners, we recommend to start looking at VILLASnode first.

You can run the full set of VILLASframework components pre-configured in a Kubernetes cluster using the Helm chart.

Requirements

Minikube

For small tests and beginners we recommend a local Minikube setup.

  1. Install Minikube
  2. Install Helm
  3. Start Minikube:
minikube start
  1. Enable the Ingress controller in your minikube cluster:
minikube addons enable ingress

Helm Chart

To deloy the Helm chart you must first add the FEIN e.V. chart repository:

helm repo add fein https://packages.fein-aachen.org/helm/charts/
helm repo update

Create a minimal chart configuration file named values.yaml with the following contents: Please have a look at the charts default values for more details about the available configuration options.

info

In this guide we assume the host running Minikube is accessible via the local IP address 192.168.1.100.

Please make sure to update the ingress.host setting with a resolvable hostname of the machine running Minikube or update the nip.io name it with the real IP address as shown below.

values.yaml
web:
auth:
admin:
mail: admin@example.com
username: admin

# please to change to a secure password
password: VillasTest1234

ingress:
port: 8080
host: villas.192-168-1-100.nip.io

broker:
auth:
username: admin
password: vieQuoo2sieDahHee8ohM5aThaibiPei
erlangCookie: iKpbgHPsHAj8x58kzFWVT23xahSQ03Vw

Once the configuration file has been prepared, start the installation with the following command:

helm install -f values.yaml villas fein/villas

Access the application

  1. Keep the following command in a terminal running in a background terminal:
minikube kubectl -- -n ingress-nginx port-forward svc/ingress-nginx-controller 8080:80 --address='0.0.0.0'

Once the installation has completed, you can visit the VILLASweb interface at the following address: http://villas.192-168-1-100.nip.io:8080/ Please use the username / password from above (admin / VillasTest1234) to login.