Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

The preparations described below are required to install Usage Engine using Helm chart and Docker image.

Fetching and Configuring Helm Chart

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

  • Helm chart: mediationzone for platform

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

  1. Add the helm repository

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


  2. Check if the chart is available:

    Code Block
    $ 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 Helm chart.

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


  4. Confirm that the Helm chart is defined for aws by viewing the file: mediationzone / values.yaml

    Code Block
    $ cat mediationzone/values.yaml | grep environment:
    
    # Only on-premise and aws supported for now
    environment: aws


  5. Verify that the AWS credentials are correct. Restore them in case it is needed.

    Code Block
    $ aws sts get-caller-identity
    
    Restore them in case it is needed:
    $ aws configure
    
    aws_access_key_id = <access key id>
    aws_secret_access_key = <secret access key>
    output = json
    region = <region where you have your EKS cluster>
    


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

    Info
    titleAccess 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:

    - mzonline.ecd.nodeHostSelectionEnabled
    - mzOperator.rbacAuthProxy.enabled

Note
titlePersistent Storage required for a possible downgrade

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

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



...