Preparations - OpenShift (4.2)

Deprecation

The usage-engine-private-edition-ec helm chart is deprecated from 10.4 and will be removed in the upcoming 10.6 release, migrate to an EC deployment.

The preparations described below are required to install Usage Engine using Helm charts and Docker images.

Fetching and Configuring Helm Chart

You will be provided to download a Helm chart with the instructions below:

  • Helm chart: usage-engine-private-edition for platform

When you are required to enter the <chart version>, refer to /wiki/spaces/DRXXE/pages/6194875 for the Helm Chart version required

  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 mz10/usage-engine-private-edition --version <chart version>
     
    Example: 
    $ help search repo -l mz10/usage-engine-private-edition \
    —version 10.6.0-release-20210930154327-270ad83673d 
    
    #The output:
    NAME                        CHART VERSION                       APP VERSION DESCRIPTION                    
     
    mz10/usage-engine-private-edition    10.6.0-release-20210930154327-270ad83673d    usage-engine-private-edition                  
    mz10/usage-engine-private-edition-ec 10.6.0-release-20210930154327-270ad83673d    usage-engine-private-edition Execution Context 
  3. If required, modify the Helm chart for the needed level of Access Control for Kubernetes Resources

    Access Control for Kubernetes Resources

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

    Essentially, to make sure that the service account used has the right level of access in order for  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
    - operator.rbacAuthProxy.enabled

Note!

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