Run one service from your IDE

Experimental

The local build and runtime are experimental. The tsm runtime commands are available only in the experimental CLI build, and their behaviour and configuration may still change.

You will run one service (here tsm-ordering) in your IDE. Its gateway runs locally as a JVM and all other services are used from the shared dev environment. No local database or seed is needed.

Before you start you need a registered workspace, the dev context from Install and connect, JDK 21 and Maven settings with access to the private repository.

caution

Your local service works with the shared data, jobs and message consumers of dev. It does not stop or replace the ordering deployment running there.

1. Prepare the profile

Save this as .tsm/runtime-profiles.yaml in the workspace and replace the uppercase placeholders:

schemaVersion: 1
sources:
  tsm-platform-parent: sources/tsm-platform-parent
  tsm-platform-aggregator: sources/tsm-platform-aggregator
  tsm-infra: sources/tsm-infra
  tsm-config: sources/tsm-config
  tsm-customer: sources/tsm-customer
  tsm-inventory: sources/tsm-inventory
  tsm-ordering: sources/tsm-ordering
  tsm-process-engine: sources/tsm-process-engine
  tsm-ticket: sources/tsm-ticket
  tsm-wfm: sources/tsm-wfm
  tsm-billing: sources/tsm-billing
  tsm-catalog: sources/tsm-catalog
toolchains:
  javaHome: /ABSOLUTE/PATH/TO/JDK21
  mavenSettings: /ABSOLUTE/PATH/TO/settings.xml
services:
  tsm-gateway: {}
  tsm-user-management: {}
  tsm-form: {}
  tsm-management-service: {}
  tsm-ordering: {}
build:
  from: sources
runtime-profiles:
  ordering:
    mode: mixed
    remote-effects: shared
    gateway:
      development-profile: datalite-devel
    services:
      tsm-ordering:
        run: external
        heapMiB: 1024

gateway.development-profile must match the database, Kafka, configuration and discovery of the dev deployment; it cannot be derived from the URL. Ask the environment owner if unsure.

2. Check what would run

tsm --workspace demo --context dev runtime plan ordering

The plan shows a local gateway JVM and ordering as an external (IDE) component; no local database, seed or Flyway.

3. Start and connect the IDE

Stop any running instance of this workspace first, then:

tsm --workspace demo runtime down
tsm --workspace demo --context dev runtime up ordering
tsm --workspace demo runtime ide tsm-ordering --json
tsm --workspace demo runtime status

runtime ide prints the Java executable and launch arguments for your IDE run configuration; run it after up. tsm does not start or stop the IDE process: stop ordering in the IDE before runtime down.

While the instance runs, tsm --workspace demo app … goes through the local gateway, so requests reach your IDE service. Adding --context dev sends the request to the remote environment and bypasses your local service.