This guide explains how to configure the Integration Designer service using environment variables.
Environment variable | Description | Default value |
---|---|---|
LOGGING_LEVEL_APP | Application logging level | INFO |
Variable | Default Value | Description |
---|---|---|
APPLICATION_FILESTORAGE_TYPE | s3 | 🆕 Storage type |
APPLICATION_FILESTORAGE_PARTITIONSTRATEGY | NONE | 🆕 Partition strategy |
APPLICATION_FILESTORAGE_DELETIONSTRATEGY | delete | 🆕 Deletion strategy |
APPLICATION_FILESTORAGE_S3_ENABLED | true | 🆕 S3 enabled |
APPLICATION_FILESTORAGE_S3_SERVERURL | http://minio:9000 | 🆕 S3 server URL |
APPLICATION_FILESTORAGE_S3_ENCRYPTIONENABLED | false | 🆕 S3 encryption enabled |
APPLICATION_FILESTORAGE_S3_ACCESSKEY | minio | 🆕 S3 access key |
APPLICATION_FILESTORAGE_S3_SECRETKEY | minio123 | 🆕 S3 secret key |
APPLICATION_FILESTORAGE_S3_BUCKETPREFIX | workflows-bucket | 🆕 S3 bucket prefix |
Variable | Default Value | Description |
---|---|---|
SPRING_CACHE_TYPE | redis | 🆕 Cache type |
SPRING_CACHE_REDIS_KEYPREFIX | flowx:core:cache:integration-designer: | 🆕 Cache key prefix |
SPRING_CACHE_REDIS_TIMETOLIVE | 5000000 | 🆕 Cache time to live |
SPRING_REDIS_HOST | redis-master | 🆕 Redis host |
SPRING_REDIS_PORT | 6379 | 🆕 Redis port |
SPRING_REDIS_PASSWORD | defaultpassword | 🆕 Redis password |
SPRING_REDIS_TTL | 5000000 | 🆕 Redis time to live |
SPRING_DATA_REDIS_HOST | spring.redis.host | 🆕 Redis host |
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 | Default 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 | Default 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 |
env
, but there is a built-in allowlist with the regex pattern FLOWX_CONFIGPARAM_.*
. This means only configuration parameters that match this naming pattern can be read at runtime, whether they are environment variables or secret variables.
Environment variable | Description | Default value |
---|---|---|
FLOWX_CONFIGPARAMS_VARS_PROVIDER | Provider type for environment variables | env |
FLOWX_CONFIGPARAMS_VARS_ALLOWLISTREGEX | Regular expression to match allowed environment variable names | FLOWX_CONFIGPARAM_.* |
FLOWX_CONFIGPARAMS_SECRETS_PROVIDER | Provider type for secrets | env |
FLOWX_CONFIGPARAMS_SECRETS_ALLOWLISTREGEX | Regular expression to match allowed secret names | FLOWX_CONFIGPARAM_.* |
FLOWX_CONFIGPARAMS_PROVIDERS_K8SSECRETS_SECRETSLIST_1
, FLOWX_CONFIGPARAMS_PROVIDERS_K8SCONFIGMAPS_CONFIGMAPSLIST_1
). Values are overridden based on the order in which the maps are defined.The default provider is env
, but there is a built-in allowlist with the regex pattern FLOWX_CONFIGPARAM_.*
. This means only configuration parameters that match this naming pattern can be read at runtime, whether they are environment variables or secret variables.Environment variable | Description | Values |
---|---|---|
FLOWX_CONFIGPARAMS_VARS_PROVIDER | Provider type for environment variables | k8s-configmaps |
FLOWX_CONFIGPARAMS_SECRETS_PROVIDER | Provider type for secrets | k8s-secrets |
k8s-configmaps
or k8s-secrets
, the default values are the following:
Environment variable | Description | Values |
---|---|---|
FLOWX_CONFIGPARAMS_PROVIDERS_K8SCONFIGMAPS_CONFIGMAPSLIST_0_ | Name of the ConfigMap to use for environment variables | flowx-configparams |
FLOWX_CONFIGPARAMS_PROVIDERS_K8SSECRETS_SECRETSLIST_0_ | Name of the Secret to use for secrets | flowx-configparams |
Environment variable | Description | Default 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 | Default value |
---|---|---|
FLOWX_LIB_CASCLIENT_SPICEDB_HOST | Spicedb host | spicedb |
FLOWX_LIB_CASCLIENT_SPICEDB_PORT | Spicedb port | 50051 |
FLOWX_LIB_CASCLIENT_SPICEDB_TOKEN | Spicedb db token | REPLACEME |
Environment variable | Description | Default 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 | Default 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.