Installation (4.0)

Owned by Jenni Wallin
Last updated: Feb 16, 2024 by Manuel Pereira
12 min read

Note!

See Bootstrapping System Certificates and Secrets before starting the installation.

Installation of Global variable macro (Development) 

  1. Create a namespace in which you want to install Global variable macro (Development).

    $ kubectl create ns <namespace>

    When planning for multiple Global variable macro (Development) installations in one EKS cluster, the following property must be set to enable for the installations to be successful. Insert the option below to the helm install command shown in step 3.

    --set aws.namespace.enabled=true

    Once enabled, the name given to your namespace will act as an identifier for the domain name and postgres.db name that will be installed.

    The domain name will have the namespace added into it, resulting in a name that looks like http://desktop-online-namespace.uepe-eks.example.com.

    The namespace will also be applied as a suffix to the postgres.db value like so <postgres.db><namespace>.

  2. The following placeholder values are getting from the terraform command output.

Place Holder

Value from terraform output

<cluster_name>

Follow as per the value configured in uepe-eks.yaml

Default is uepe-eks

<region>

Follow as per the value configured in uepe-eks.yaml

Default is eu-west-1

<certificate_arn>

certificate_arn

<db_endpoint>

db_endpoint without the “:port” part

<db_user>

db_user

<admin_password>

Follow as per the value configured in terraform.tfvars

db_password

<eks_domain_zone_name>

eks_domain_zone_name

If you are running multiple Usage Engine installations on the cluster, please ensure to read through Cluster Multi Tenancy(4.0) instructions.

  1. Install Platform, use the License Key file from License Key and Helm Chart(4.0). This is an example of a minimal installation.

-  Use a suitable unique name for <release_platform> in the command below.

- Service name of ingress nginx should be <release_name>-ingress-nginx-controller in the command below.

$ helm install <release_platform> ./usage-engine-private-edition --wait --timeout=5m \ --set environment=aws \ --set aws.cluster_name=<cluster_name> \ --set aws.region=<region> \ --set global.domain=<cluster_name>.<eks_domain_zone_name> \ --set aws.acm_certificate="<certificate_arn>" \ --set aws.ingress.serviceName="<service name of ingress nginx>" \ --set persistence.enabled=true \ --set platform.tls.enabled=true \ --set mzonline.ssl.enabled=false \ --set postgres.db=mz \ --set platform.db.type=postgresql \ --set postgres.adminUsername=<db_user> \ --set postgres.adminPassword="<admin_password>" \ --set postgres.host="<db_endpoint>" \ --set-file licenseKey=<licenseKey_file> \ --set debug.script.enabled=true \ --namespace <namespace>

  1. Verify the installation.

Accessing the Environment

The following is a basic example on how to define the User Interfaces. For a more comprehensive guide, see Starting and Managing Desktop Client. 

Desktop Launcher

To deploy the Desktop Launcher, perform the following steps:

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

  2. Download the  Desktop Launcher from https://platform.<cluster node>:<mz.webserver.port>/launch/desktop. The port is by default 9000.
    Example: https://platform.uepe-eks.tafdr.net:9000/launch/desktop/

  3. 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.
    Example command: $ java -jar standard standard-mzx-launcher-1.1.4.jar

  4. When you add an instance in the Desktop Launcher, set the Port to 9000. Host should begin with "platform." before the <domain>.
    Example:

    pe-4-aws-desktop-launcher.png

Connect to the Desktop Online

Example - Desktop Online URL

Example. Enter the URL in a web browser:

# Define connection type “desktop-online.” before the <domain>, as indicated below:

https://desktop-online.uepe-eks.tafdr.net/

Define Configurations on the Installation

The Installation guide is now complete. To get a system ready for production or testing purposes, you will need to define Configurations and ECs, there are three different types as described below: