Skip to main content
Update environment variable configurations for all existing FlowX.AI services to support version 5.1.0 compatibility.

Audit core

Elasticsearch configuration migrates from SPRING_ELASTICSEARCH_* to FLOWX_ELASTICSEARCH_* namespace with enhanced index management.

Variables to remove & replace

New variables to add

Simple migration with containerization support and namespace alignment.

Variables to update

Variables to replace

Document plugin

New configuration option for test documents bucket customization.

New variables to add

This variable allows you to override the default -test-documents bucket suffix. You can configure a custom bucket name or use the same bucket as the main storage if needed.

Kafka configuration

Complete Kafka migration including consumer group standardization to kebab-case, comprehensive topic restructuring with new versioned naming patterns, and enhanced messaging features across all FlowX.AI services.
Do not modify default consumer group names. We strongly recommend against changing the default consumer group names as this operation can lead to misconfigurations. The application is designed to work and scale with the consumer groups as they are defined by default.

Consumer group migrations

Admin (3 groups):Application Manager (15 groups):CMS Core (1 group):Document Plugin (1 group):Integration Designer (3 groups):Notification Plugin (1 group):Process Engine (11 groups):

Kafka topic migrations

All Kafka topics migrate to versioned naming pattern ai.flowx.{env}.{service}.{operation}.v1 for improved organization and future compatibility.
Application resource topics:Sync topics:Resource update propagation:Build resource topics:

New Kafka features

Resource Update Propagation

Consumer Group: app-resource-update-propagation-group
Threads: 3
Topic: ai.flowx.{env}.application-version.resource.update.propagation.v1
Purpose: Real-time resource change propagation

Build Runtime Data

Consumer Group: build-runtime-data-group
Threads: 2
Topic: ai.flowx.{env}.build.runtime-data.v1
Purpose: Build process data management

Business Rule Sync

Topic: ai.flowx.{env}.application-version.sync.business-rule.in.v1
Purpose: Enhanced business rule synchronization
Consumer Group: business-rule-sync-group

Process Sync Enhanced

Topic: ai.flowx.{env}.application-version.sync.process.in.v1
Purpose: Improved process synchronization
Consumer Group: process-sync-group

Reusable Template Sync

Topic: ai.flowx.{env}.application-version.sync.reusable-template.in.v1
Purpose: Template synchronization
Consumer Group: reusable-template-sync-group

Correction After App Operation

Multiple Topics: Process, business rule, and template correction
Purpose: Post-deployment resource correction
Consumer Group: processCorrectionAfterAppOperationGroup

Configure environment variables

Automatic Configuration: Most deployments can rely on the built-in naming patterns without explicit environment variable overrides. Only override when custom naming is required.

Additional Application Manager variables

Integration Designer

Storage configuration

Added support for S3 storage for files in Integration Designer.

Redis

Added caching when running a workflow.

FlowX Engine

The ADVANCING controller has been redesigned with separate picking and processing operations for improved performance and resource management.

Variables to remove & replace

New variables to add

Variables to update

How the new advancing controller works:
  • Picking threads (ADVANCING_PICKINGTHREADS): Controls how many worker threads read events from the database. This handles only the picking/reading operations.
  • Processing buffer (ADVANCING_PROCESSINGBUFFERSIZE): Acts as a queue between picking and processing. When the buffer is full, no new events are read. When there’s available space, that amount of events will be read.
  • Processing threads (ADVANCING_PROCESSINGTHREADS): Controls how many threads process the advancing events in parallel. Events are processed instantly if processing threads are available. If all processing threads are busy, events accumulate in the buffer until it reaches capacity.
  • Blocking behavior (ADVANCING_BLOCKPICKINGIFNOWORKERAVAILABLE): When enabled, prevents picking operations if no worker threads are available, ensuring better resource management.

Elasticsearch indexing configuration

Elasticsearch indexing environment variables have been updated with new naming conventions for better consistency with FlowX naming standards.

Variables to remove & replace

For complete Elasticsearch indexing setup including Kafka Connect configuration and time-based partitioning, see the Configuring Elasticsearch indexing guide.

Java runtime configuration

FlowX.AI containers and services must rely exclusively on Java-standard environment variables for runtime tuning.
Environment-specific memory configurations must now be defined using JDK_JAVA_OPTIONS. Avoid relying on JAVA_OPTS, JAVA_TOOL_OPTIONS or legacy Docker-level overrides β€” these are no longer processed explicitly.

Config profiles

Config profiles are deprecated since 4.7.6 version.
Remove legacy CONFIG_PROFILE usage. Delete any CONFIG_PROFILE environment variable definitions from deployments. This variable is no longer referenced by FlowX.AI services.

Development environment exception

For development environments only, CONFIG_PROFILE migrates to the standard Spring configuration profile variable.

SpiceDB integration

FlowX.AI 5.1 introduces SpiceDB integration for enhanced authorization capabilities across all core services.

Services affected

The following services require new SpiceDB configuration variables:
  • Admin
  • Application Manager
  • Audit Core
  • CMS Core
  • Document Plugin
  • Integration Designer
  • Notification Plugin
  • Process Engine
  • Runtime Manager
  • Task Management Plugin

New variables to add

For every CAS configuration, add the following variables:

Data sync updates

Data Sync additional variables

For every Data-Sync configuration, add the following variables:

Kafka topic naming

Global configuration change

This change standardizes topic naming across environments by defaulting to an empty environment identifier.

CORS and ingress updates

All services with Kubernetes ingress configurations now require the Fx-Workspace-Id header for workspace identification in multi-tenant environments.

Standard ingress pattern

FlowX.AI v5.1 introduces a standardized ingress configuration pattern for all services. The key change is adding the Fx-Workspace-Id header to the CORS configuration. Required annotation update:

Services requiring updates

All FlowX.AI services that expose ingress endpoints require this update:

Complete Ingress Configuration Guide

View the complete ingress configuration pattern including:
  • Standard template for all services
  • Service-specific paths and rewrite rules
  • Annotation explanations
  • Troubleshooting guide
  • Environment-specific customization
Exception: Events Gateway does not require the Fx-Workspace-Id header because it handles Server-Sent Events (SSE) with different security requirements. See the Events Gateway exception section for details.
Last modified on July 16, 2026