Deploy configuration files
This topic describes the Deploy configuration files that can be found in the XL_DEPLOY_SERVER_HOME/centralConfiguration
directory.
Central Configuration Directory
The XL_DEPLOY_SERVER_HOME/centralConfiguration
directory contains Digital.ai Deploy shared central configuration files. This directory is a centralized repository for all the application configuration files, which are defined and stored in one place to avoid copying of the files to the workers.
For more information on Central Configuration feature, see Central Configuration Overview.
Note: When you try to set up Deploy in cluster mode, and if you encounter any occurrences of the term
akka
within the following files located in thecentralConfiguration
folder, the set up will fail.
XL_DEPLOY_SERVER_HOME/centralConfiguration/deploy-cluster.yaml
XL_DEPLOY_SERVER_HOME/centralConfiguration/deploy-jmx.yaml
XL_DEPLOY_SERVER_HOME/centralConfiguration/deploy-server.yaml
XL_DEPLOY_SERVER_HOME/centralConfiguration/deploy-task.yaml
To fix this issue, replace those instances with the corresponding configuration settings associated with Pekko. This involves modifying any relevant packages, class names, jar names, URLs, and so on to align with the configuration specifications specific to the Pekko framework.
For more detailed instructions on migrating from Akka to Pekko, see the Migration Guide.
List of configuration files in the XL_DEPLOY_SERVER_HOME/centralConfiguration Directory
Configuration file name | Description |
---|---|
deploy-artifact-resolver.yaml | Configuration to move xl.artifact.resolver (Maven Artifact Resolver) from HOCON format to artifact-resolver.yaml (yaml format) |
deploy-client.yaml | Configuration settings to customize the Deploy GUI |
deploy-cluster.yaml | Configuration settings for hot-standby and active-active set up |
deploy-command-whitelist.yaml | Configuration used to blacklist or whitelist commands used in the command plugin |
deploy-jmx.yaml | Contains JMX agent configuration settings to start Deploy |
deploy-metrics.yaml | Configuration settings for Deploy metrics |
deploy-oidc.yaml | Configuration settings for keycloak authentication |
deploy-plugins.yaml | Configuration settings for Deploy features |
deploy-repository.yaml | Configuraton settings for database configuration |
deploy-satellite.yaml | Configuration settings to configure Deploy satellite |
deploy-secret-complexity.yaml | Configure password strength requirements using example secret-complexity tag |
deploy-server.yaml | Configuration settings related to SSL configuration with trusted certificates |
deploy-task.yaml | Configuration settings related to the Deploy task engine |
deploy-websockets.yaml | Contains the ThreadPoolTaskExecutor and the WebSocketPolicy details for message broker |
Note: From Deploy 10.3 and later, the deploy.server.hostname
and deploy.server.port
properties from the deploy-server.yaml
file are moved to deployit.conf
file and renamed as server.hostname
and server.port
respectively.
Redistribution of deployit.conf
configuration properties
The properties in the deployit.conf
file are moved to the centralConfiguration
directory, renamed, and are distributed between deploy-client.yaml
and deploy-server.yaml
.
Types of Details | Deploy 10.1 and Earlier Releases | Deploy 10.2 and Later Releases |
---|---|---|
Name of the Configuration File | deployit.conf |
|
Location of the Configuration File | XL_DEPLOY_SERVER_HOME/conf | XL_DEPLOY_SERVER_HOME/centralConfiguration |
Properties in the Configuration File |
| deploy-client.yaml: deploy-server.yaml:
|
Note: The unused properties,
client.server_poll.delay
andserver.mapping.override.deployed.fields.on.update
, which are not used in Digital.ai Deploy are not moved to the new configuration files.
For more information about the configuration properties in the redistributed configuration files, see Deploy Properties.