Skip to content

Next Steps

With Dirigible running and a first endpoint published, the deep-dive sections are organised by what you do next.

Read first

  • Concepts - start with the synchronizer model. Dirigible does not deploy projects; it reconciles files in the registry into runtime state on every change. Everything else - jobs, BPMN, data sources, controllers - hangs off that.

Build with code

  • Develop - the decorator model in TypeScript (@aerokit/sdk/*) and Java (org.eclipse.dirigible.engine.java.annotations.*). REST controllers, entities, repositories, scheduled jobs, listeners, components.
  • Artefacts - full catalogue of file extensions the platform recognises (.job, .bpmn, .camel, .listener, .odata, .datasource, .table, .csvim, ...) and how each is reconciled.
  • SDKs - Java SDK landing. The API reference covers the TypeScript / JavaScript surface (@aerokit/sdk/*).

Common first projects

Pick the closest one to what you want to build:

  • REST API - extend the first application with a repository and entity. See TypeScript SDK - http and db.
  • Scheduled job - drop a .job artefact or use the @Scheduled decorator. See Process.
  • BPMN process - model in the BPM perspective, deploy a .bpmn, drive it via the Flowable REST surface. See BPM.
  • Message listener - declare a .listener artefact (or @Listener in TS / Java) to consume from the embedded ActiveMQ broker. See Listeners.
  • Data integration - import CSV with a .csvim artefact, query through a .datasource, expose via @Controller. See Data.
  • OData service - define a .odata artefact for V2-compatible service exposure. See Services.

Operating

  • Setup - environment variables, authentication providers, multi-tenancy, external databases, Kubernetes specifics.
  • Observability - Spring Boot Admin at /spring-admin/, actuator health probes at /actuator/health/*, the Operations perspective for runtime introspection.

Reference

  • Reference - configuration, HTTP surface, conventions.
  • API - @aerokit/sdk/* modules.
  • SDK - Java SDK packages.

Stay in touch

Released under the EPL-2.0 License.