Skip to main content

11 OLIVE Platform Deployment & Operation

Platform Overview​

The OLIVE Platform is a cloud-agnostic Kubernetes application designed to follow Cloud Native Computing Foundation (CNCF) best practices. It can be deployed in a variety of environments, whether on public clouds, or private datacenters.

Development and production deployments​

OLIVE is installed in one of two shapes. As a connectivity engineer you will normally build in a development deployment and your solution will run in a production deployment.

Both can create, edit and run connectivity — the connectivity editor and the Data Orchestrator work the same way in each. What differs is whether there are tenants and users, and therefore whether a caller has to authenticate to OLIVE. Authenticating to the external systems your connectivity calls is a separate matter and is required in both.

Development deployment​

  • One tenant. All resources live in a single namespace, and there is nothing to choose between.
  • No authentication to OLIVE, and no users. There is no login, and no roles: the single user effectively holds every permission, and the public APIs accept anonymous calls. Credentials for the systems your connectivity calls are still needed, exactly as in production.
  • Full connectivity. You can create, edit, execute and test connectivity, which is the point — a connector cannot be developed without running it.
  • Uses the single-no-auth deployment mode.
  • Intended for development, integration testing and proofs of concept. It must never be reachable from an untrusted network and must never hold customer data.

Production deployment​

  • Multiple tenants, with strict data isolation between them.
  • Authentication and authorization for OLIVE. Keycloak provides identity management, and the user, editor and admin roles are enforced — see Roles In OLIVE. Calls to OLIVE's own public APIs need a token too.
  • Full connectivity, with permissions. Creating and editing connectivity works as it does in development, but requires the editor role; importing a bundle requires admin.
  • Uses the multi-shared and multi-tenant deployment modes.

What this means in practice​

AspectDevelopment deploymentProduction deployment
TenantsOneMany, isolated
Users and rolesNone — one implicit user with every permissionuser, editor, admin, enforced
Authentication to OLIVENoneKeycloak (OAuth2 / OIDC)
Authentication to the systems you callAlways required — the target system decidesAlways required — the target system decides
Creating and editing connectivityYesYes, with the editor role
Executing connectivityYesYes
Calling the public APIsAnonymouslyBearer token from an OIDC client
Network policiesUsually enabledExpected on — no route between tenant namespaces
In-cluster encryptionOffMutual TLS via an Istio ambient service mesh
Outbound callsInternal addresses blocked; public destinations unaffectedInternal addresses blocked; public destinations unaffected

Two kinds of authentication, and only one of them changes​

Authenticating to the systems your connectivity calls — OpenAI, ADONIS, a customer's REST API — is required in both deployments, because the target system demands it. Authenticating to OLIVE itself — its public APIs and its user interfaces — is the part that differs: a development deployment accepts anonymous calls, a production deployment requires a token.

That difference is why a solution that works in development almost always needs two changes before it goes into productive use: an oidc auth entry on datapoints that call OLIVE's own APIs, and credentials for whatever triggers the connectivity. Both are described in How to Package a Use Case Solution. Auth entries in general are covered in Authentication and Secrets Management.

Getting Started​

To begin developing connectivity applications:

  1. Determine which deployment you are working against — ask your Tenant Admin whether it is a development or a production deployment
  2. Obtain the base address and, for a production deployment, the client credentials you will need
  3. Set up authentication (production only) — see API Access with OIDC Clients
  4. Start developing — use the OLIVE user interfaces or the public APIs to create and test connectivity

What the deployment enforces around your connectivity​

Regardless of which environment you work in, some platform behaviour is not configurable and affects what you can build:

  • Outbound calls to internal addresses are blocked. The platform rejects calls to private address ranges, Kubernetes-internal service names and cloud metadata addresses before the request leaves. Calls to public internet destinations are not restricted.
  • Internal services are not published on the ingress unless the deployment explicitly asks for it. If you need to reach a service from outside the cluster, that is a request to your OLIVE operator.
  • Tenant boundaries are enforced in four independent ways — the identity token check in every service, the per-tenant secrets role, the per-tenant namespace and storage, and network policies. Nothing you build should depend on reaching another tenant.
  • Jobs, session data and files belong to the user who created them. Knowing an identifier is not enough to reach a resource.
  • Security-relevant actions are logged with a stable event code, your tenant, your user and a traceable request ID.

For the full list of what changed and what it means for connectivity, see Security in Connectivity Engineering.

Deployment & Setup References​

For comprehensive information on deploying and configuring the OLIVE Platform, including hardware requirements, installation procedures, and operational setup, refer to the OLIVE Administrator and Operator handbook.

This covers among other things:

  • Deployment architecture and options (development vs. production)
  • Hardware requirements and platform dependencies
  • Installation, configuration, and post-deployment setup
  • Monitoring, logging, and observability configuration
  • Operational best practices and maintenance

Release Information​

For details on available OLIVE versions and release notes, refer to the OLIVE Administrator and Operator handbook.