Migrating from previous versions to v4.1
If you are upgrading from a v3.4.x version, first check the following migration guide (to capture all the changes introduced in v4.0):
Migrating from v3.4.x to v4.0
If you are upgrading from v4.0 version, check the following migration guide:
Migrating from v4.0 to v4.1
Revised cache key organization
To ensure a smooth transition to the 4.1 release, it’s essential to utilize the following clear cache endpoint and body:
Endpoint
POST {{baseUrlAdmin}}/api/internal/cache/clear
Body:
Clear cache endpoint
Misconfigurations
To enable and to compute warnings for already existing processes from previous versions, use the following endpoint to retrieve and compute all warnings:
Please note that it may take some time for all misconfigurations in older processes to become available on the platform after calling this endpoint.
FlowX.AI Admin
For more details:
Enable misconfigurations
Spring Boot upgrade
The following configuration changes are required after upgrading your Spring Boot application to version 3.2.x. Below is a detailed explanation of each section in the context of this upgrade:
Note that this setup is backwards compatible, it does not affect the configuration from v3.4.x. The configuration files will still work until v4.5 release.
The old environment variables (v3.4.x) will be removed in the v.4.5 FlowX.AI release.
Configuration properties updates:
Redis configuration
Where Redis is used (FlowX CMS, FlowX Admin, Documents plugin, events, Notifications plugin, FlowX Engine, Task Management plugin):
Old configuration
SPRING_DATA_HOST
SPRING_DATA_PORT
SPRING_DATA_PASSWORD
New configuration
SPRING_DATA_REDIS_HOST
SPRING_DATA_REDIS_PORT
SPRING_DATA_REDIS_PASSWORD
Management configuration
For all services managing metrics, especially exporting metrics to Prometheus:
Old configuration
MANAGEMENT_METRICS_EXPORT_PROMETHEUS_ENABLED
New configuration
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED
: This variable enables or disables Prometheus metrics export dynamically based on the environment.
More details, here
Authentication
For all services except the advancing-controller.
New configuration
Currently not required to be set as they take values from old configs.
SPRING_SECURITY_OAUTH2_RESOURCE_SERVER_OPAQUE_TOKEN_INTROSPECTION_URI
SPRING_SECURITY_OAUTH2_RESOURCE_SERVER_OPAQUE_TOKEN_CLIENT_ID
SPRING_SECURITY_OAUTH2_RESOURCE_SERVER_OPAQUE_TOKEN_CLIENT_SECRET
Existing configuration
SECURITY_OAUTH2_BASE_SERVER_URL
SECURITY_OAUTH2_REALM
SECURITY_OAUTH2_CLIENT_CLIENT_ID
SECURITY_OUATH2_CLIENT_CLIENT_SECRET
Elasticsearch configuration
This outlines the Elasticsearch configuration for the following microservices: FlowX Admin, FlowX Engine, Data Search, and Audit Core.
Existing configuration
SPRING_ELASTICSEARCH_REST_URIS
: This environment variable is used by the microservices listed above. This variable needs to be set to the appropriate value for each environment.
Example:
If you do not upgrade to the new configuration, make sure that in the actual configuration you will remove the protocol/schema, it is no longer needed: for example, instead of http://localhost:9200
you will have localhost:9200
as value.
New configuration
SPRING_ELASTICSEARCH_REST_PROTOCOL
: Default value ishttps
; should be overridden if connection to Elasticsearch needs to be done overhttp
.
Example:
License core configuration
For the License core microservice you need to configure two different data sources: one for the engine database and one for the license database.
Old Engine database source
ENGINE_DATASOURCE_URL
ENGINE_DATASOURCE_JDBC_URL
ENGINE_DATASOURCE_USERNAME
ENGINE_DATASOURCE_PASSWORD
New Engine database source
SPRING_DATASOURCE_ENGINE_URL: ${spring.datasource.jdbc-url}
: Pointing to old config for backwards compatibility.SPRING_DATASOURCE_ENGINE_JDBC_URL: ${spring.datasource.jdbc-url}
: Pointing to old config for backwards compatibilitySPRING_DATASOURCE_ENGINE_USERNAME: ${spring.datasource.username}
: Pointing to old config for backwards compatibilitySPRING_DATASOURCE_ENGINE_PASSWORD: ${spring.datasource.password}
: Pointing to old config for backwards compatibility
Old License database source
SPRING_DATASOURCE_URL
SPRING_DATASOURCE_JDBC_URL
SPRING_DATASOURCE_USERNAME
SPRING_DATASOURCE_PASSWORD
New License database source
SPRING_DATASOURCE_LICENSE_URL: ${spring.datasource.jdbc-url}
: Pointing to old config for backwards compatibility.SPRING_DATASOURCE_LICENSE_JDBC_URL: ${spring.datasource.jdbc-url}
: Pointing to old config for backwards compatibility.SPRING_DATASOURCE_LICENSE_USERNAME: ${engine.datasource.username:postgres}
: Pointing to old config for backwards compatibility.SPRING_DATASOURCE_LICENSE_PASSWORD: ${engine.datasource.password:wrongpwd}
: Pointing to old config for backwards compatibility.
Customer management plugin
New configuration
ELASTICSEARCH_PROTOCOL
: Possible values arehttps
/http
; default value ishttps
- should be overridden if connection to Elasticsearch needs to be done overhttp
.
Open Telemetry
The FlowX.AI platform uses a mix of both auto instrumentation with Java agent and manual instrumentation using the Open Telemetry API.
Enabling Open Telemetry is optional.
For more information about how to leverage Open Telemetry with FlowX, check the following section:
Open Telemetry scenarios
Additional configuration needed! For more information about Open Telemetry deployment/configuration, check the following section:
Open Telemetry configuration
For more information about microservices Open Telemetry default properties, check the following section:
Open Telemetry default properties
Was this page helpful?