Versions Compared

Key

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

This installation guide will tell describes how you how to perform a reference installation of Usage Engine Private Edition. It is aimed at providing aims to provide you with a good starting point. It is not aimed at providing , ot to provide you with a fully-fledged production-grade Kubernetes cluster.

You will end up with When finished you will have a Usage Engine Private Edition installation that is ready for you to start implementing your business logic, in the form of workflow configurations, and eventually creating your first EC Deployment.

...

Info

The diagram only shows the main components that this installation guide covers. For a full description of the Usage Engine Private Edition architecture, please refer to:
see https://infozone.atlassian.net/wiki/x/IpJkBg.

...

Here follows information about the purpose of the main components in the diagram:

Component

Purpose

external-dns

Makes Kubernetes resources (services, ingresses) discoverable via public DNS servers by automatically configuring the Route 53 DNS management service.
For additional information, please refer to:
https://github.com/kubernetes-sigs/external-dns

aws-load-balancer-controller

Provisions application load balancer to satisfy ingress resources.

Provisions network load balancer to satisfy service resources.

For additional information, please refer to:
https://github.com/kubernetes-sigs/aws-load-balancer-controller

ingress-alb

An ingress that gets created as part of installing Usage Engine Private Edition.

efs-csi-controller

This is optional and only required if your business logic implementation (workflow configuration) requires persistent file storage.

Its purpose is to dynamically provision a persistent volume (pv) whenever a persistent volume claim (pvc) is created. The pv is provisioned based on the storage class (sc) that the pvc references.

For additional information, please refer to:https://github.com/kubernetes-sigs/aws-efs-csi-driver

mz-bundled-pvc

A pvc that gets created when installing Usage Engine Private Edition.

It only gets created under the condition that persistence is enabled in the Usage Engine Private Edition helm chart.

This is optional and only required if your business logic implementation (workflow configuration) requires persistent file storage.

platform

desktop-online

uepe-operator

These components are all pat of the Usage Engine Private Edtion Edition helm chart.

For detailed information about these components, please refer to:
see https://infozone.atlassian.net/wiki/x/IpJkBg.

oci-native-ingress-controller

Provisions application load balancer to satisfy ingress resources.

For additional information, please refer to:

https://github.com/oracle/oci-native-ingress-controller

ingress-nginx-controller

This is an Ingress controller using NGINX as a reverse proxy and load balancer.

This is optional and only required if you plan on creating EC Deployment(s) that use ingress.

For addtional information, please refer to: see
https://github.com/kubernetes/ingress-nginx

cert-manager

To automate Automates management of TLS certificates.

Although optional, it is the recommended solution to provide apply TLS to Usage Engine Private Edition.

For additional information, please refer to:
https://github.com/cert-manager/cert-manager

...