Preparations - Private Cloud(4.0)

Owned by Jenni Wallin
Last updated: Mar 19, 2024
2 min read

The preparations described below are required to install Usage Engine using Helm charts and Docker images. Read through the steps below and follow each step before installing.

Fetching and Configuring Helm Charts

You will download the Helm chart with the instructions below:

  • Helm chart: usage-engine-private-edition

When you are required to enter the <chart version>, refer to Release Information for the Helm Chart version required

The Helm chart configuration installs a large portion of the product, apart from the ECD instance. 

  1. Add the helm repository

    $ helm repo add usage-engine-private-edition 'https://digitalroute-public.github.io/usage-engine-private-edition' $ helm repo update

  2. Check if the charts are available:

    $ helm search repo -l usage-engine-private-edition/usage-engine-private-edition --version <chart version> Example: $ helm search repo -l usage-engine-private-edition/usage-engine-private-edition --version 2.0.0 #The output: NAME CHART VERSION APP VERSION DESCRIPTION usage-engine-private-edition/usage-engine-private-edition     2.0.0     The Usage Engine Private Edition helm chart                  

  3. Create a directory dedicated for the installation and download the platform Helm chart.

    $ mkdir <your directory> $ cd <your directory> $ helm fetch usage-engine-private-edition/usage-engine-private-edition --version <chart version> --untar

  4. Make sure the Helm chart is defined for on-premise (Private cloud) by viewing the file: usage-engine-private-edition / values.yaml

  5. If required, modify the Helm chart for the needed level of Access Control for Kubernetes Resources

    Usage Engine relies on Role Based Access Control (RBAC) when specifying the level of access needed for the kubernetes resources involved in any given Usage Engine installation. 

    Essentially, to make sure that the service account used has the right level of access in order for Usage Engine to function properly.
    Some features do require cluster wide access to certain resources (typically resources that are not namespaced). This is realized by the use of ClusterRoles. If ClusterRoles are not permitted in the given kubernetes cluster for one reason or another, those features will have to be switched off.

    The following helm values can be used to switch off features relying on ClusterRoles, see the Helm chart for further details:

    - desktopOnline.ecd.nodeHostSelectionEnabled
    - mzOperator.rbacAuthProxy.enabled

Ensure that there is no firewall rule that restricts access to the exposed ports to the cluster. See Installation - Private Cloud(3.3) for more information concerning ports.

In the case a Downgrade is needed later, you must define Persistent Storage.

For information about Persistent Storage, see Persistent Storage (3.3).

Ensure that there is no firewall rule that restricts access to the exposed ports to the cluster. See Installation - Private Cloud(4.0) for more information concerning ports.

In the case a Downgrade is needed later, you must define Persistent Storage.

For information about Persistent Storage, see Persistent Storage (4.0).