Skip to content

Components

Talisman is made of the Talisman Server, Talisman Studio, the dev images, and the Apache Camel Runtime, which your integrations run on. This page says what each one does and where it runs. Architecture shows how they connect.

Component What it does Where it runs
Talisman Server Control Plane in every environment, Studio Web in dev One Server per environment
Studio Web Designers in the browser The dev Talisman Server
Studio for VS Code Designers in VS Code The developer's machine
Dev images Developer mode, builds, AI assistant Your Docker or Kubernetes
Apache Camel Runtime Runs your integrations Your Docker or Kubernetes

Talisman Server

The Talisman Server is one image, talismancloud/talisman-server. You run one Server in each environment, and its role follows that environment, set with TALISMAN_ENVIRONMENT:

  • dev: Control Plane and Studio Web. The dev Server also builds your projects (Server Build).
  • Any other environment (test, prod): Control Plane only.

The Control Plane deploys, operates and observes the integrations of its environment. See Multi-Environment, Deployer Engine and Observability.

The Server stores its data in PostgreSQL. To install it, see Kubernetes or Docker.

Talisman Studio

Talisman Studio is Studio Web or Studio for VS Code, whichever the developer prefers. Both have the Talisman designers and work on the same projects in your Git repository. The Studio overview compares them and helps you pick.

Studio Web

Studio Web runs in the browser. The dev Talisman Server serves it, so developers install nothing.

Developers work on the main branch. Developer mode runs their project in the dev environment.

Studio for VS Code

Studio for VS Code is the extension "Talisman Studio" (talisman-platform.talisman-studio) on the VS Code Marketplace. See Studio for VS Code for local installation, extension details, and workstation usage.

Developers work on Git branches and merge to main through pull requests. Developer mode runs their project on their own Docker or Kubernetes.

Dev images

Talisman starts these images to run, build and assist with your projects. They are not part of your integrations.

Image Used for
talismancloud/talisman-devmode Developer mode: runs a project while you design it. It also runs the Server Build on the dev Server.
talismancloud/talisman-builder CI/CD Build: the Talisman pipeline templates build the image with it.
talismancloud/talisman-ai The AI assistant of Studio for VS Code, one container per project.

To pull talisman-devmode from your own registry, set KARAVAN_DEVMODE_IMAGE (Environment Variables).

Apache Camel Runtime

Each integration runs in its own container on the Apache Camel Runtime: upstream Apache Camel on Apache Camel Main, with no Talisman code inside. Integrations keep running without the Talisman Server.

By deployment option

The deployment option you choose decides which components you run:

Studio Web on Server VS Code with Server Build VS Code with CI/CD
Studio Studio Web Studio for VS Code Studio for VS Code
Developer mode Dev environment Developer's machine Developer's machine
Build Server Build on the dev Server Server Build on the dev Server CI/CD Build in your pipeline
Control Plane Every environment Every environment Every environment