Note!
See Bootstrapping System Certificates and Secrets - Private Cloud(3.3) 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: |
---|---|---|---|
mz-operator-controller-manager | Yes | usage-engine-private-edition | |
mzonline | Yes | Web interface | usage-engine-private-edition |
platform | No | Platform | usage-engine-private-edition |
ui | Yes | Desktop Online | usage-engine-private-edition |
crd | |||
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 We don't have a way to export this inline extension.
If you are running multiple Usage Engine installations on the cluster, please ensure to read through Cluster Multi Tenancy(3.3) instructions.
To install:
Install all pods. Use the License Key from License Key and Helm Chart(3.3).
- 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> --namespace <namespace> Example: $ helm install platform1 usage-engine-private-edition --set-file licenseKey=license_key --namespace user1
Verify the installation.
# Verify pods $ kubectl get pods -n <namespace> #Example NAME READY STATUS RESTARTS AGE mz-operator-controller-manager-646b766d44-2s9sl 2/2 Running 0 28h mz-operator-controller-manager-646b766d44-mmzhs 2/2 Running 0 28h mzonline-76988b9659-qt7lg 1/1 Running 0 28h pcc-ecd-f6c646659-cm66j 1/1 Running 0 28h platform-0 1/1 Running 0 28m ui-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 mz-operator-controller-manager-metrics-service ClusterIP 10.106.247.120 <none> 8443/TCP 7d6h mzonline NodePort 10.102.101.78 <none> 80:30153/TCP 7d6h platform NodePort 10.100.16.83 <none> 9000:30767/TCP,6790:32632/TCP 7d6h ui NodePort 10.101.199.208 <none> 9001:31962/TCP 7d6h # Note that in the case you use TLS, the Web interface, mzonline port will be 443.
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.
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(3.3).
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.