General Information

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

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

3. Verify the installation.

   # Verify pods $ kubectl get pods -n <namespace> #Example NAME READY STATUS RESTARTS AGE mz-operator-controller-manager-c7f6766c4-8z9wd 2/2 Running 0 154m mz-operator-controller-manager-c7f6766c4-bl84f 2/2 Running 0 154m mzonline-5984c4b844-nbpbr 1/1 Running 0 154m platform-0 1/1 Running 0 154m wd-569bf5f746-s7pgd 1/1 Running 0 154m # Verify service contexts to connect $ kubectl get services -n <namespace> #Example NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE mz-operator-controller-manager-metrics-service ClusterIP 10.102.178.52 <none> 8443/TCP 154m mzonline NodePort 10.100.195.106 <none> 80:31200/TCP (443:31300/TCP) 154m platform NodePort 10.111.174.222 <none> 9000:31600/TCP,6790:31700/TCP 154m wd NodePort 10.101.51.191 <none> 9999:31400/TCP 154m # Note that in the case you use TLS, the Web interface, mzonline port will be 443.

    

   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.

   $ kubectl get pods -n <namespace> #Example NAME READY STATUS RESTARTS AGE mz-operator-controller-manager-6d48d9f7f6-7llrh 1/2 ImagePullBackOff 0 2m45s mz-operator-controller-manager-6d48d9f7f6-cgp9j 1/2 ImagePullBackOff 0 2m45s mzonline-5f974767b7-gpxnf 0/1 ImagePullBackOff 0 2m45s platform-0 0/1 Init:ImagePullBackOff 0 2m45s wd-874c66c-5k8rf 0/1 ImagePullBackOff 0 2m45s

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.

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.

4. 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.
   

5. 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.
   
   

   Open

   

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.