Skip to main content

Introduction

One of the approaches we have adopted from the beginning of development of the platform is easy installation and deployment. We believe that you should not spend weeks or even months working on the configuration before starting to use the platform.

Therefore, we have adopted a container-based approach and prepared container images and related documentation. With this you can easily and in a short time deploy the platform and required connectors and services.

How the platform is deployed​

The platform is composed of microservices, and containers are its basic building blocks. It can be deployed in more than one way, and the way you choose determines the rest of the installation — its prerequisites, its procedure and, later, its upgrade path. The choice is therefore the first step, not an implementation detail at the end.

The following diagram shows the main relationships in a Kubernetes deployment. The edge, enabled components, and placement of supporting infrastructure depend on the deployment option and its configuration. Follow the Operator or Helm guide for the resources your deployment creates.

Kubernetes deployment

Logical overview
ClientsAdministrators, API consumers, and automation
HTTPS

Platform namespace

Configured edge

Ingress or Gateway API

The Operator can create an edge, or you can provide your own.

Routes traffic

Entry point

API gateway

Routes requests to platform services.

The API gateway routes requests to Core and the administrator interface.

Application logic

Core

Processes API requests and coordinates platform operations.

Web application

Administrator interface

Provides the browser interface for managing the platform.

Core supporting services

  • Identifies users and validates client certificates.

  • OPA evaluates roles and permissions.

  • Coordinates scheduled platform tasks.

Connectors and connected technologies

Core calls registered connectors. They can run in the cluster or at a reachable external endpoint.

Connectors

Translate platform operations for a specific technology.

Technology-specific calls

Connected technologies

Certificate authorities and other integrations. A connector may use its own database.

Supporting infrastructure

Database and messaging are required; Keycloak is optional. The Operator can manage each dependency independently or use external infrastructure.

Certificate trust

For certificate sign-in, the TLS terminator requests the client certificate and forwards it to Core. Auth validates the chain against trusted CA certificates. A Kubernetes Secret supplies the CA bundle for certificate sign-in and trusted TLS connections.

Arrows show the main request paths. Supporting groups show responsibilities, not every network connection. Edge resources, enabled components, and infrastructure placement depend on configuration.

The virtual appliance runs on a virtual-machine host and includes its own Kubernetes distribution, Helm, and PostgreSQL. It downloads and deploys the platform containers after you apply its configuration.

What you need before you start​

Every option needs somewhere to run. The Kubernetes Operator and the Helm chart both deploy into a Kubernetes cluster you provide; the virtual appliance runs on a virtual-machine host. Sizing depends on which components you enable, so each option's guide carries its own prerequisites and figures.

OptionWhere it runsPrerequisites
Kubernetes OperatorA Kubernetes clusterBefore you begin
Helm chartA Kubernetes clusterPrerequisites
Virtual applianceA virtual-machine hostDeployment using Virtual Appliance

Installation steps​

StepDescriptionReference
1. Choose a deployment optionThe option you choose determines the prerequisites, the installation procedure and the upgrade path.Deployment options
2. Follow that option's guideEach option documents its own prerequisites and installation steps end to end.Kubernetes Operator · Helm · Virtual appliance
3. Create the first Super AdministratorCreate a Super Administrator and configure the platform.Create Super Administrator

Shared infrastructure​

The Helm chart expects an existing database and a trusted CA bundle. The virtual appliance includes PostgreSQL, while the Kubernetes Operator can manage PostgreSQL or connect to an external database. Configure trusted CA certificates for the certificate sign-in and TLS connections your deployment uses.

After installation​

Once the first administrator is created, you can access the Administrator Interface. Use the following URL with the client certificate authentication (first administrator): https://[domain]:[port]/administrator

For certificate sign-in, the TLS terminator in front of the platform must forward the client certificate; see Client Certificate Authentication.

After successfully logging in, you can start administering and using the platform.

Changing administrator web base URL context

You can change the base URL of the administrator web interface. By default, the /administrator is used.