This guide explains how to configure the Integration Designer service using environment variables.
Component | Purpose |
---|---|
Kubernetes | Container orchestration |
PostgreSQL | Advancing data source |
MongoDB | Integration configurations |
Kafka | Event-driven communication |
OAuth2 Server | Authentication (Keycloak recommended) |
Environment variable | Description | Example value |
---|---|---|
CONFIG_PROFILE | Spring configuration profiles | k8stemplate_v2,kafka-auth |
LOGGING_LEVEL_APP | Application logging level | INFO |
Environment variable | Description | Default value |
---|---|---|
FLOWX_WEBCLIENT_BUFFERSIZE | Buffer size (in bytes) for FlowX WebClient | 1048576 (1MB) |
FLOWX_WEBCLIENT_BUFFERSIZE=10485760
. This ensures smooth handling of large API responses, particularly for legacy APIs without pagination support.Environment variable | Description | Example value |
---|---|---|
ADVANCING_DATASOURCE_URL | PostgreSQL JDBC URL | jdbc:postgresql://postgresql:5432/advancing |
ADVANCING_DATASOURCE_USERNAME | Database username | flowx |
ADVANCING_DATASOURCE_PASSWORD | Database password | securePassword |
ADVANCING_DATASOURCE_DRIVER_CLASS_NAME | JDBC driver | org.postgresql.Driver |
integration-designer
): Stores data specific to Integration Designer, such as integration configurations, metadata, and other operational data.app-runtime
): Shared across multiple services, this database manages runtime data essential for integration and data flow execution.Environment variable | Description | Example value |
---|---|---|
SPRING_DATA_MONGODB_URI | Integration Designer MongoDB URI | mongodb://mongodb-0.mongodb-headless:27017/integration-designer |
MONGODB_USERNAME | MongoDB username | integration-designer |
MONGODB_PASSWORD | MongoDB password | secureMongoPass |
SPRING_DATA_MONGODB_STORAGE | Storage type (Azure environments only) | mongodb (or cosmosdb ) |
SPRING_DATA_MONGODB_RUNTIME_URI | Runtime MongoDB URI | mongodb://mongodb-0.mongodb-headless:27017/${MONGODB_RUNTIME_DATABASE} |
MONGODB_RUNTIME_DATABASE | Runtime MongoDB database | app-runtime |
MONGODB_RUNTIME_USERNAME | Runtime MongoDB username | app-runtime |
MONGODB_RUNTIME_PASSWORD | Runtime MongoDB password | secureRuntimePass |
Environment variable | Description | Example value |
---|---|---|
SPRING_KAFKA_BOOTSTRAPSERVERS | Kafka broker addresses | localhost:9092 |
SPRING_KAFKA_SECURITY_PROTOCOL | Security protocol | PLAINTEXT or SASL_PLAINTEXT |
FLOWX_WORKFLOW_CREATETOPICS | Auto-create topics | false (default) |
Environment variable | Description | Default value |
---|---|---|
KAFKA_MESSAGE_MAX_BYTES | Maximum message size | 52428800 (50MB) |
Environment variable | Description | Default value |
---|---|---|
KAFKA_CONSUMER_GROUPID_STARTWORKFLOWS | Start workflows consumer group | start-workflows-group |
KAFKA_CONSUMER_GROUPID_RESELEMUSAGEVALIDATION | Resource usage validation consumer group | integration-designer-res-elem-usage-validation-group |
KAFKA_CONSUMER_THREADS_STARTWORKFLOWS | Start workflows consumer threads | 3 |
KAFKA_CONSUMER_THREADS_RESELEMUSAGEVALIDATION | Resource usage validation consumer threads | 3 |
KAFKA_AUTHEXCEPTIONRETRYINTERVAL | Retry interval after authorization errors | 10 (seconds) |
Environment variable | Description | Default value |
---|---|---|
KAFKA_TOPIC_NAMING_PACKAGE | Base package for topics | ai.flowx. |
KAFKA_TOPIC_NAMING_ENVIRONMENT | Environment identifier | dev. |
KAFKA_TOPIC_NAMING_VERSION | Topic version | .v1 |
KAFKA_TOPIC_NAMING_SEPARATOR | Topic name separator | . |
KAFKA_TOPIC_NAMING_SEPARATOR2 | Alternative separator | - |
KAFKA_TOPIC_NAMING_ENGINERECEIVEPATTERN | Engine receive pattern | engine.receive. |
KAFKA_TOPIC_NAMING_INTEGRATIONRECEIVEPATTERN | Integration receive pattern | integration.receive. |
ai.flowx.dev.
is the prefix (package + environment)eventsgateway
is the servicereceive
is the actionworkflowinstances
is the detail.v1
is the suffix (version)Environment variable | Description | Default Pattern |
---|---|---|
KAFKA_TOPIC_AUDIT_OUT | Topic for sending audit logs | ai.flowx.dev.core.trigger.save.audit.v1 |
Environment variable | Description | Default Pattern |
---|---|---|
KAFKA_TOPIC_EVENTSGATEWAY_OUT_MESSAGE | Topic for workflow instances communication | ai.flowx.dev.eventsgateway.receive.workflowinstances.v1 |
Environment variable | Description | Default Pattern |
---|---|---|
KAFKA_TOPIC_ENGINEPATTERN | Pattern for Engine communication | ai.flowx.dev.engine.receive. |
KAFKA_TOPIC_INTEGRATIONPATTERN | Pattern for Integration communication | ai.flowx.dev.integration.receive.* |
Environment variable | Description | Default Pattern |
---|---|---|
KAFKA_TOPIC_APPLICATION_IN_RESELEMUSAGEVALIDATION | Topic for resource usage validation requests | ai.flowx.dev.application-version.resources-usages.sub-res-validation.request-integration.v1 |
KAFKA_TOPIC_RESOURCESUSAGES_REFRESH | Topic for resource usage refresh commands | ai.flowx.dev.application-version.resources-usages.refresh.v1 |
Environment variable | Description | Example value |
---|---|---|
KAFKA_OAUTH_CLIENT_ID | OAuth client ID | kafka |
KAFKA_OAUTH_CLIENT_SECRET | OAuth client secret | kafka-secret |
KAFKA_OAUTH_TOKEN_ENDPOINT_URI | OAuth token endpoint | kafka.auth.localhost |
ai.flowx.dev.engine.receive.*
ai.flowx.dev.integration.receive.*
max.message.bytes
value: 10485760
(10 MB)
ai.flowx.dev.eventsgateway.receive.workflowinstances.v1
max.message.bytes
10485760
Environment variable | Description | Example value |
---|---|---|
SECURITY_OAUTH2_BASE_SERVER_URL | Base URL for OAuth2 authorization server | https://keycloak.example.com/auth |
SECURITY_OAUTH2_REALM | Realm for OAuth2 authentication | flowx |
SECURITY_OAUTH2_CLIENT_CLIENT_ID | Client ID for Integration Designer OAuth2 client | integration-designer |
SECURITY_OAUTH2_CLIENT_CLIENT_SECRET | Client Secret for Integration Designer OAuth2 client | client-secret |
SECURITY_OAUTH2_SERVICE_ACCOUNT_ADMIN_CLIENT_ID | Client ID for admin service account | admin-client |
SECURITY_OAUTH2_SERVICE_ACCOUNT_ADMIN_CLIENT_SECRET | Client Secret for admin service account | admin-secret |
Environment variable | Description | Example value |
---|---|---|
LOGGING_LEVEL_ROOT | Root Spring Boot logs level | INFO |
LOGGING_LEVEL_APP | Application-level logs level | INFO |
Environment variable | Description | Default value |
---|---|---|
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED | Enable Prometheus metrics export | false |
get
, list
, watch
) to ConfigMaps, Secrets, and Pods, which is essential for retrieving application settings and credentials required by Integration Designer.