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):
If you are upgrading from v4.0 version, check the following migration guide:
To ensure a smooth transition to the 4.1 release, it’s essential to utilize the following clear cache endpoint and body:
POST {{baseUrlAdmin}}/api/internal/cache/clear
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.
For more details:
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:
Where Redis is used (FlowX CMS, FlowX Admin, Documents plugin, events, Notifications plugin, FlowX Engine, Task Management plugin):
SPRING_DATA_HOST
SPRING_DATA_PORT
SPRING_DATA_PASSWORD
SPRING_DATA_REDIS_HOST
SPRING_DATA_REDIS_PORT
SPRING_DATA_REDIS_PASSWORD
For all services managing metrics, especially exporting metrics to Prometheus:
MANAGEMENT_METRICS_EXPORT_PROMETHEUS_ENABLED
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED
: This variable enables or disables Prometheus metrics export dynamically based on the environment.More details, here
For all services except the advancing-controller.
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
SECURITY_OAUTH2_BASE_SERVER_URL
SECURITY_OAUTH2_REALM
SECURITY_OAUTH2_CLIENT_CLIENT_ID
SECURITY_OUATH2_CLIENT_CLIENT_SECRET
This outlines the Elasticsearch configuration for the following microservices: FlowX Admin, FlowX Engine, Data Search, and Audit Core.
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.
SPRING_ELASTICSEARCH_REST_PROTOCOL
: Default value is https
; should be overridden if connection to Elasticsearch needs to be done over http
.Example:
For the License core microservice you need to configure two different data sources: one for the engine database and one for the license database.
ENGINE_DATASOURCE_URL
ENGINE_DATASOURCE_JDBC_URL
ENGINE_DATASOURCE_USERNAME
ENGINE_DATASOURCE_PASSWORD
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 compatibilitySPRING_DATASOURCE_URL
SPRING_DATASOURCE_JDBC_URL
SPRING_DATASOURCE_USERNAME
SPRING_DATASOURCE_PASSWORD
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.ELASTICSEARCH_PROTOCOL
: Possible values are https
/ http
; default value is https
- should be overridden if connection to Elasticsearch needs to be done over http
.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:
Additional configuration needed! For more information about Open Telemetry deployment/configuration, check the following section:
For more information about microservices Open Telemetry default properties, check the following section:
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):
If you are upgrading from v4.0 version, check the following migration guide:
To ensure a smooth transition to the 4.1 release, it’s essential to utilize the following clear cache endpoint and body:
POST {{baseUrlAdmin}}/api/internal/cache/clear
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.
For more details:
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:
Where Redis is used (FlowX CMS, FlowX Admin, Documents plugin, events, Notifications plugin, FlowX Engine, Task Management plugin):
SPRING_DATA_HOST
SPRING_DATA_PORT
SPRING_DATA_PASSWORD
SPRING_DATA_REDIS_HOST
SPRING_DATA_REDIS_PORT
SPRING_DATA_REDIS_PASSWORD
For all services managing metrics, especially exporting metrics to Prometheus:
MANAGEMENT_METRICS_EXPORT_PROMETHEUS_ENABLED
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED
: This variable enables or disables Prometheus metrics export dynamically based on the environment.More details, here
For all services except the advancing-controller.
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
SECURITY_OAUTH2_BASE_SERVER_URL
SECURITY_OAUTH2_REALM
SECURITY_OAUTH2_CLIENT_CLIENT_ID
SECURITY_OUATH2_CLIENT_CLIENT_SECRET
This outlines the Elasticsearch configuration for the following microservices: FlowX Admin, FlowX Engine, Data Search, and Audit Core.
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.
SPRING_ELASTICSEARCH_REST_PROTOCOL
: Default value is https
; should be overridden if connection to Elasticsearch needs to be done over http
.Example:
For the License core microservice you need to configure two different data sources: one for the engine database and one for the license database.
ENGINE_DATASOURCE_URL
ENGINE_DATASOURCE_JDBC_URL
ENGINE_DATASOURCE_USERNAME
ENGINE_DATASOURCE_PASSWORD
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 compatibilitySPRING_DATASOURCE_URL
SPRING_DATASOURCE_JDBC_URL
SPRING_DATASOURCE_USERNAME
SPRING_DATASOURCE_PASSWORD
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.ELASTICSEARCH_PROTOCOL
: Possible values are https
/ http
; default value is https
- should be overridden if connection to Elasticsearch needs to be done over http
.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:
Additional configuration needed! For more information about Open Telemetry deployment/configuration, check the following section:
For more information about microservices Open Telemetry default properties, check the following section: