Having completed the preparations, it is now time to install Usage Engine Private Edition.

Main Installation Example

In this main installation example, it is assumed that the following optional resources have been added while preparing for the installation:

ingress-nginx-controller (see Kubernetes Cluster Add-ons - Private Cloud)
cert-manager (see Usage Engine Private Edition Preparations - Private Cloud (4.3))

Configure Persistent Storage

See Persistent Storage (4.3) for persistent storage setup guide.

Configure Database

Note!

This guide does not cover the setup of database instance for the Usage Engine Private Edition. See the documentation of your selected database for installation instructions.

Install Helm Chart

Although the number of helm value combinations to set is virtually endless, some values should more or less always be set.

So let’s start by creating a file called uepe-values.yaml, and in that file, specify a minimal set of values that will serve as a good starting point:

environment: on-premise
global:
  domain: uepe.example.com
  imagePullSecrets:
  - name: ecr-cred
licenseKey: <insert-your-license-key-string-here>
log:
  format: json
platform:
  db:
    type: postgresql
  tls:
    cert:
      public: certManager
    certManager:
      public:
        issuer:
          kind: ClusterIssuer
          name: example-issuer
    enabled: true    
postgres:
  adminUsername: postgres
  host: postgres-postgresql
  port: 5432
persistence:
  enabled: true
  existingClaim: my-pvc

The table below contains information which helps you determine the values to set in your particular installation:

Value	Comment

Value	Comment
`global.domain`	This value should be set to match your domain name.
`global.imagePullSecrets`	This is referencing an image pull secret containing the credentials required in order to pull container images from the Digital Route AWS ECR registry. If you are hosting the container images in your own container registry, depending on how that is configured, another image pull secret is probably needed. See Usage Engine Private Edition Preparations - Private Cloud (4.3) for additional information.
`licenseKey`	The license key that can be found in the `licenseKey` file that you have previously received (see the Pre-requisites - Private Cloud (4.3)section).
`log.format`	If you need to use dedicated log collection and monitoring tools like Fluent-bit, Elasticsearch, Kibana for Usage Engine Private Edition, make sure the log format is configured to `json`.
`platform.tls.*`	These values are set to use the example issuer created at the beginning of this chapter. This should only be seen as an example and the values should be adjusted according to the real world situation.
`platform.db.type`	Set to match the type of database being used (derby, postgresql, oracle or saphana).
`postgres.adminUsername`	Set to match the admin user for the database being used.
`postgres.host`	Set to match the database server host (DNS name or IP address).
`postgres.port`	Set to match the database server port.

Note!

General documentation of the values above is provided in the values.yaml file in the usage-engine-private-editionhelm chart.

Caution!

In this example, the system database is to be automatically created at install time. For this to happen, you need to provide the database administrator credentials which is why the postgres.adminUsername value is set to the default PostgreSQL administrator username. Since setting passwords through helm values is a great security risk, it is assumed that you have previously boostrapped the postgresqlPassword secret key with a value equal to super_SeCrEt_db_pAsSwOrD_457! (see the Usage Engine Private Edition Preparations - Private Cloud (4.3) section for an explanation on how to do this).

Use the following command to install Usage Engine Private Edition:

helm install uepe digitalroute/usage-engine-private-edition --version <version> -f uepe-values.yaml -n uepe

Where <version> is the version of Usage Engine Private Edition to install. For example 4.0.0.

Check that all pods are running and that all pod containers become ready by running the following command:

kubectl get pods -w

After a while when all pods are up and running, you should see something similar to this:

NAME                                                READY   STATUS    RESTARTS   AGE
desktop-online-7c54755c99-hd5zw                     1/1     Running   0          60s
ingress-nginx-controller-7c5cb6456-2gjmj            1/1     Running   0          5h37m
platform-0                                          1/1     Running   0          60s
uepe-operator-controller-manager-86b758f558-2t94r   2/2     Running   0          60s
uepe-operator-controller-manager-86b758f558-c92s7   2/2     Running   0          60s

The Usage Engine Private Edition installation is now complete.

Other Common Installation Configurations

Below are a few common installation configurations for the Usage Engine Private Edition helm chart.

They should be seen as variations to the main installation example outlined above.

Persistent File Storage

Reference Arbitrary PVC

Usage Engine Private Edition can be configured to reference an arbitrary persistent volume claim by setting the following helm values:

persistence:
  enabled: true
  existingClaim: my-pvc

In this example, my-pvc is an arbitrary persistent volume claim that you have created beforehand.