Installation - Private Cloud (4.0)

Owned by Jenni Wallin
Last updated: Mar 19, 2024
5 min read

Note!

See Bootstrapping System Certificates and Secrets - Private Cloud(4.0) 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:

uepe-operator-controller-manager

Yes

 

usage-engine-private-edition

platform

No

Platform

usage-engine-private-edition

desktop-online

Yes

Desktop Online

usage-engine-private-edition

crd

 

 

 

ecdeployments.mz.digitalroute.com

N/A

Custom Resource Definition

usage-engine-private-edition

 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 Global variable macro (Development)

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

To install:

  1. Install  all pods. Use the License Key from License Key and Helm Chart(4.0)and set image pull secret (To create 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

  2. Verify the installation.

    # Verify pods $ kubectl get pods -n <namespace> #Example NAME READY STATUS RESTARTS AGE uepe-operator-controller-manager-646b766d44-2s9sl 2/2 Running 0 28h uepe-operator-controller-manager-646b766d44-mmzhs 2/2 Running 0 28h platform-0 1/1 Running 0 28m desktop-online-7d777b9644-vtsp9 1/1 Running 0 28h # Verify service contexts to connect $ kubectl get services -n <namespace> #Example NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE uepe-operator-controller-manager-metrics-service ClusterIP 10.106.247.120 <none> 8443/TCP 7d6h platform NodePort 10.100.16.83 <none> 9000:30767/TCP,6790:32632/TCP 7d6h desktop-online NodePort 10.101.199.208 <none> 9001:31962/TCP 7d6h

     

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

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(4.0).

 

Â