Skip to main content
Version: Deploy 24.3

Deploy configuration files

This topic describes the Deploy configuration files that can be found in the XL_DEPLOY_SERVER_HOME/centralConfigurationdirectory.

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 the centralConfiguration 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 nameDescription
deploy-artifact-resolver.yamlConfiguration to move xl.artifact.resolver (Maven Artifact Resolver) from HOCON format to artifact-resolver.yaml(yaml format)
deploy-caches.yamlConfiguration settings for Deploy caching
deploy-client.yamlConfiguration settings to customize the Deploy GUI
deploy-cluster.yamlConfiguration settings for hot-standby and active-active set up
deploy-command-whitelist.yamlConfiguration used to blacklist or whitelist commands used in the command plugin
deploy-jmx.yamlContains JMX agent configuration settings to start Deploy
deploy-metrics.yamlConfiguration settings for Deploy metrics
deploy-oidc.yamlConfiguration settings for keycloak authentication
deploy-plugins.yamlConfiguration settings for Deploy features
deploy-repository.yamlConfiguraton settings for database configuration
deploy-reporting.yamlConfiguration settings for reporting features
deploy-satellite.yamlConfiguration settings to configure Deploy satellite
deploy-secret-complexity.yamlConfigure password strength requirements using example secret-complexity tag
deploy-server.yamlConfiguration settings related to SSL configuration with trusted certificates
deploy-task.yamlConfiguration settings related to the Deploy task engine
deploy-websockets.yamlContains 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 DetailsDeploy 10.1 and Earlier ReleasesDeploy 10.2 and Later Releases
Name of the Configuration Filedeployit.conf
  • deploy-client.yaml
  • deploy-server.yaml
Location of the Configuration FileXL_DEPLOY_SERVER_HOME/confXL_DEPLOY_SERVER_HOME/centralConfiguration
Properties in the Configuration File
client.automatically.map.all.deployables
client.automatically.map.all.deployables.on.initial
client.automatically.map.all.deployables.on.update
client.session.remember.enabled
importable.packages.path
maintenance.forbidden_paths
secure.cookie.enabled
http.upload.buffer
upgrade.batch.size
server.resolve.application.dependencies
client.server_poll.delay
server.mapping.override.deployed.fields.on.update
deploy-client.yaml:
deploy.client.automatically-map-all-deployables
deploy.client.automatically-map-all-deployables-on-initial
deploy.client.automatically-map-all-deployables-on-update
deploy.client.session-remember-enabled
deploy.client.importable-package-directory
deploy.client.maintenance.forbidden-paths
deploy.client.secure-cookie-enabled
deploy.client.upload-file-buffer-size
deploy.client.upgrade-batch-size
client.server_poll.delay
server.mapping.override.deployed.fields.on.update
deploy-server.yaml:
server.resolve.application.dependencies

Note: The unused properties, client.server_poll.delay and server.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.