Versions Compared

Key

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

Note!

See Bootstrapping System Certificates and Secrets - Private Cloud(34.30) before starting the installation.

General Information

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

pod

unique-id

Purpose

Installed with Helm chart:

mzuepe-operator-controller-manager

Yes

usage-engine-private-edition

mzonline

YesWeb interface

usage-engine-private-edition

platform

No

Platform

usage-engine-private-edition

uidesktop-online

Yes

Desktop Online

usage-engine-private-edition

crd

ecdeployments.mz.digitalroute.com

N/A

Custom Resource Definition

usage-engine-private-edition

Note

 The crd ecdeployments.mz.digitalroute.com is installed with helm install below. For detailed information on how helm handle Custom Resource Definitions see:

https://helm.sh/docs/chart_best_practices/custom_resource_definitions/

Installing
We don't have a way to export this inline extension.

Note

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

To install:

  1. Install  all pods. Use the License Key from License Key and Helm Chart(3.3)4.0)and set image pull secret (To create secret see Preparations)..
    -  Use a suitable unique name for <release_platform> in the command below.

    Code Block
    $ 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
  2. Verify the installation.

    Code Block
    # Verify pods
    
    $ kubectl get pods -n <namespace>
    
    #Example
    NAME                                                READY   STATUS    RESTARTS   AGE
    mzuepe-operator-controller-manager-646b766d44-2s9sl   2/2     Running                 0          28h
    mzuepe-operator-controller-manager-646b766d44-mmzhs   2/2     Running                 0          28h
    mzonline-76988b9659-qt7lgplatform-0                                          1/1     Running                 0          28h28m
    pccdesktop-ecdonline-f6c6466597d777b9644-cm66jvtsp9                           1/1     Running                 0          28h
    platform-0            
    
    # Verify service contexts to connect
    
    $ kubectl get services -n <namespace>
    
    #Example
    NAME                            1/1     Running              TYPE   0     CLUSTER-IP     28m uiEXTERNAL-7d777b9644-vtsp9IP   PORT(S)                         AGE
    uepe-operator-controller-manager-metrics-service  1/1 ClusterIP   10.106.247.120 Running  <none>        8443/TCP       0          28h  # Verify service contexts to connect7d6h
    platform $ kubectl get services -n <namespace>  #Example NAME                                  NodePort    10.100.16.83     <none>    TYPE    9000:30767/TCP,6790:32632/TCP   7d6h
    CLUSTERdesktop-IPonline      EXTERNAL-IP   PORT(S)                         AGE mz-operator-controller-manager-metrics-service  NodePort ClusterIP   10.106101.247199.120208   <none>        84439001:31962/TCP                  7d6h
    

Note

Note!

The output for the ports when you run kubectl get services -n <namespace> are the ports that you must enter instead of ports 443, 9000, 6790, 80 and 9999 when you connect to the Desktop and/or Web Interface.

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.

Code Block
$ kubectl get pods -n <namespace>
#Example
NAME                
7d6h
 
mzonline
                             READY   STATUS         
NodePort
    
10.102.101.78
    
<none>
 RESTARTS   AGE
mz-operator-controller-manager-6d48d9f7f6-7llrh   
80:30153
1/
TCP
2     ImagePullBackOff        0       
7d6h
 
platform
  2m45s
mz-operator-controller-manager-6d48d9f7f6-cgp9j   1/2     ImagePullBackOff        0          2m45s
mzonline-5f974767b7-gpxnf           
NodePort
    
10.100.16.83
     
<none>
     0/1   
9000:30767/TCP,6790:32632/TCP
  ImagePullBackOff 
7d6h
 
ui
      0          2m45s
platform-0                              
NodePort
    
10.101.199.208
   
<none>
   0/1     
9001:31962/TCP
Init:ImagePullBackOff   0          2m45s
wd-874c66c-5k8rf                
7d6h
  
#
 
Note
 
that
 
in
 
the
 
case
 
you
 
use
 
TLS,
 
the
 
Web
 
interface,
 
mzonline
 
port
 
will
 
be 443.
Note

Note!

The output for the ports when you run kubectl get services -n <namespace> are the ports that you must enter instead of ports 443, 9000, 6790, 80 and 9999 when you connect to the Desktop and/or Web Interface.
 0/1     ImagePullBackOff        0          2m45s

User Interfaces

For information on how to connect to the different interfaces, see User Interfaces (3.3) for more information on how to use the different interfaces.

Installation Configuration

The Installation guide is now complete. To get a system ready for production or testing purposes, you will need to define Configurations and ECDs using two methods available to you. These methods are described below:

  • Deploy real-time configurations through UI EC Deployment Web Interface(3.3).
    Follow the step-by-step configuration options to configure the instance using the user interface. There are many examples available in the documentation.

  • Deploy solutions through CI/CD pipelines
    Use the Continuous Integration and Deployment (CI/CD) pipeline to automate building, testing, and deployment of use- and test cases.
    For more information, see: Continuous Integration and Deployment(34.30).

Note

Note!

If you are using Diameter refer to Diameter Handling in Kubernetes(3.3) to know how Diameter is handled when deployed in a Kubernetes cluster.

...