Installation (3.0)


See before starting the installation.

General Information

After the installation you will get a number of pods and a crd, function and purpose are explained in the table:




Installed with Helm chart:






Web interface








Web Desktop interface




Custom Resource Definition


 The crd is installed with helm install below. For detailed information on how helm handle Custom Resource Definitions see:

Installing Usage Engine

To install:

  1. Validate the Helm Chart Contents

    To ensure there are no errors in the Helm chart content, you can run the following:

    $ helm lint usage-engine-private-edition

    You can also run the helm template chart to see the yaml files with modified values:

    $ helm template usage-engine-private-edition
  2. Install  all pods. Use the License Key and set image pull secret, see Preparations.
    -  Use a suitable unique name for <release_platform> in the command below.

    $ helm install <release_platform>  usage-engine-private-edition --set-file licenseKey=<licensekey_file> --set "global.imagePullSecrets[0].name=<secret name>" --namespace <namespace> Example: $ helm install platform1 usage-engine-private-edition --set-file licenseKey=license_key --set "global.imagePullSecrets[0].name=ecr-cred" --namespace user1

There is also a usage-engine-private-edition-ecd helm chart available to install if you do not want to create the ECDs in the web interface.

  1. Verify the installation.


    ImagePullBackOff errors

    In case you see ImagePullBackOff errors when listing the pods, either you have not created  a pull secret or the pull secret is miss-configured.

User Interfaces

Below are some basic examples of how to define the user interfaces below, see Desktop for more information. 

Web Desktop

To connect to the Web Desktop, go to http://<cluster node>:<NodePort>/auth. Define your cluster node and the NodePort number substitute for 9999, in the output example in of the kubectl get services above it is 31400. 

Desktop via Launcher

To deploy Desktop Launcher, you need to take the following steps:

  1. Prerequisite: Download and install java 11 on the PC that you will use the Desktop on. Both JRE and JDK work.

  2. Download the Usage Engine Desktop Launcher from: http://<cluster node>:<NodePort>/launch/desktop. Enter your cluster node and the NodePort number substitute for 9000, in the output example of "kubectl get services" above it is 31600.

  1. To install the Desktop Launcher, for Windows, download the exe file and double-click to install it. Alternatively download the OS independent  jar file and use java -jar to install it.

  1. Add an instance in the Desktop Launcher. Use the NodePort number substitute for 9000, in the output example in of "kubectl get services" above it is 31600.

  2. The Platform RCP port is by default 6790, this needs to be changed. Click settings on the Desktop instance and update the pico.rcp.platform.port to the NodePort number substitute for 6790, in the output example of "kubectl get services" above it is 31700.

Web Interface

To connect to the Web Interface, go to http://<cluster node>:<NodePort>, entering your cluster node and the NodePort. Use the NodePort number substitute for 80 (http) or 443 (https), in the output example of "kubectl get services" above it is 31200.

Installation Configuration

The Installation guide is now complete. To get a system ready for production or testing purposes, you will need to define Configurations and ECDs using two methods available to you. These methods are described below: