Getting Started - telekom/Open-Telekom-Integration-Platform GitHub Wiki

Getting Started

This page describes in a general manner how to get started with the Open Telekom Integration Platform. For more detailed information, please refer to the guides provided in the wiki.

Prerequisites

Kubernetes

The Open Telekom Integration Platform is designed to be deployed on Kubernetes. Currently, it is tested with Kubernetes version 1.31.

Additional required Kubernetes features:

  • Kubernetes Ingress Controller (preferably NGINX Ingress Controller)
  • Kubernetes DNS (preferably CoreDNS.)
    Depending on your Kubernetes installation it's sometimes already installed <- please check looking into your cluster!)
  • Persistent Volumes (NFS or block storage like gp2)
  • TLS certificate management (e.g. cert-manager)

Databases

The Open Telekom Integration Platform requires the following databases:

  • PostgreSQL (version 14+) for the API Management component
  • PostgreSQL (version 14+) for the Identity Management component

Note: The Open Telekom Integration Platform is tested with AWS RDS Aurora PostgreSQL (version 16). Other versions might work, but are not tested.

Preparing the images

Follow the instructions in the respective repositories of the products you want to deploy. The image repositories end with -image. Make sure to make the images available to your Kubernetes cluster.

Preparing the Helm charts

The Open Telekom Integration Platform's products are preferably deployed using Helm charts. The Helm charts are available in the respective repositories of the products you want to deploy. The chart repositories end with -chart. Make sure to update the values in the Helm charts according to your environment. Pay special attention to the ingresses, domain names, database connections and the images.

It is also possible to use ArgoCD to deploy the Helm charts. Make sure to create the respective application definitions in ArgoCD.

Apply the Helm charts

You may apply the Helm charts (using ArgoCD, CICD pipelines or manually) in any order you like. However, the following order is recommended due to the fact that many products rely on the identity provider and API management:

  1. Identity Provider
  2. API Management
  3. Event-Driven Integration / Pubsub
  4. File Transfer