Digital.ai Deploy 23.1.x Release Notes

Digital.ai Deploy 23.1.0 includes the following new features:

• Migrate from Active/Hot-Standby Setup to Active/Active Setup
• Cache-enabled Deploy for better performance
• Tightly-coupled Deploy and Release for a seamless release orchestration and deployment experience
• Enhanced Pendo data collection for better troubleshooting
• Enhanced XL CLI
• Enhanced plugins

And more bug fixes and enhancements.

Support Policy

See Digital.ai Support Policy.

Upgrade Instructions

The Digital.ai Deploy upgrade process you use depends on the version from which you are upgrading, and the version to which you want to go.

For upgrade instructions, see:

• Upgrade Deploy—on JVM
• Upgrade Deploy—on Kubernetes

Migrate from Active/Hot-Standby Setup to Active/Active Setup

Given the success of Active-Active setup with our customers, we have determined that the Deploy Active/Hot-standby mode is no longer the recommended configuration for achieving High Availability due to its inherent limitations. To ensure a more reliable and efficient solution, we strongly recommend migrating to the Active-Active setup.

Important: Plan and execute the migration from Deploy Active/Hot-standby to Active-Active before the designated deprecation date, which is the 1st of May, 2024.

To facilitate the transition, see the implementation details of the Active-Active setup. If you have any further questions or concerns regarding the Active-Active setup implementation, contact our Support team and your Customer Success Manager at Digital.ai.

After the deprecation date, support and updates for the Deploy Active/Hot-standby setup will not be available. Migrating to Active-Active is essential to maintain uninterrupted service and take advantage of the enhanced capabilities.

Note: We would like to take the opportunity to bring to your attention the Product and Support Lifecycle of Digital.ai Deploy. If you're using an unsupported version and need support with upgrading, contact your Customer Success Manager.

Cache-Enabled Deploy for Better Performance

• Deploy 23.1 lets you cache frequently accessed data for better performance and reduced latency.

• Caching is disabled by default, and you must enable it to start caching the data.

• You can enable caching as part of Deploy installation or upgrade.

• Digital.ai recommends Infinispan 14.0.2 for use with Deploy.

• Digital.ai Deploy uses Cache-Aside (Lazy Loading) cache pattern to ensure that data is cached only when necessary and JCache (JSR-107) API as an abstraction over the cache.

  Note: This feature is only available for Deploy on JVMs and Docker-based setups but not for Operator-based sites.

• Comprehensive testing was carried out at Digital.ai to assess the effect of caching on the overall performance of the Digital.ai Deploy's deployment APIs.

• A comparison of the performance test data from sites with and without caching was also carried out.

• While the performance improvement was not that significant during initial deployments—as the cache was being built—we were able to witness significant performance improvements (by about 20-30 percentage as illustrated in the following table) during subsequent update deployments when the cache was fully built and utilized.

  API	Performance Improvement %
  /xldeploy/deployment/prepare/update	35%
  /xldeploy/deployment/prepare/deployeds ​	26%
  /xldeploy/deployment/validate	45%
  Total	33%

  For more information, see

  • Caching in Deploy
  • Single node Docker deployments with Caching
  • Multi-node Docker deployments with Caching

• You also have the following new actuator APIs to manage the cached data:

  • GET /actuator/jcaches

  • GET /actuator/jcaches/{cacheName}?key={key}

  • DELETE /actuator/jcaches/

  • DELETE /actuator/jcaches/{cacheName}

    For more information, see Get and Delete Cached Data using API.

Tightly-coupled Deploy and Release

Digital.ai Deploy and Release 23.1 are more tightly-coupled than ever to bring you a seamless release orchestration and deployment experience.

• The new application onboarding workflows in Release makes it easier to seamlessly onboard deployed applications from Deploy and Argo CD without needing to work with the Deploy UIs or APIs.
• Once you onboard the applications, you can quickly discover which application versions are deployed to which environments across Deploy and Argo CD.​
• Deploy's logs are now live-streamed to and visible in Release making it easier to identify and troubleshoot issues.

See Application Onboarding Overview for details.

Enhanced XL CLI

Here's a list of enhancements to the XL CLI 23.1.0:

• Added support for air-gapped installation of Deploy and Release.
• Added support for custom repositories in the install and upgrade wizards.

Known Issues

Some of the install wizard prompts are repeated (along with the user-entered value) when you run the install wizard via the xl kube install command on Windows.

Version Upgrades—Supported Databases

Deploy 23.1 supports the following databases.

Database	Versions Supported
PostgreSQL	14.6 and 15.0
MySQL	5.7 and 8.0
Oracle	19c
Microsoft SQL Server	2017 and 2019
DB2	11.1 and 11.5

Plugins and Integrations

Here's what's new and changed with plugins and integrations.

AWS Plugin

• dded ability to deploy an AWS Lambda function from a container image.

  

• hen you update a file from S3 bucket, the FileName error occurs. This issue is now fixed.

• dded options to

  • create volumes at the time of instance creation
  • enable encryption on volumes

• dded new fields for metadata information that can enabled during instance creation.

Azure Plugin

• Implemented AI.Deploy Azure plugin ACI with Azure Container Instances in the private registry (ACR). Two new fields, the Registry Username and Registry password are added.

• dded ability to deploy an Azure functionApp from a container image.

• ixed the file permission error caused while creating new ResourceGroups on Azure clusters.

• dded a check to ensure that rollback only deletes resource groups created using the arm template.

• RequestDisallowedByPolicy error is thrown when the Deploy Azure plugin is unable to communicate with Azure. This occurs because the policy at the client is set to allow only TLS 1.2. This issue is now fixed.

HashiCorp Vault Plugin

• nabled non-root token to be used for authentication with HashiCorp Vault.

Helm Plugin

• mplemented support for adding multiple repositories to Helm charts without downloading locally. Added the "Add Repository" checkbox to indicate if the repository must be added.
• dded a check for Namespace Field in Helm to fix installation issues.

JBoss Domain Plugin

• ixed an issue with the JBoss Domain plugin failing at the "Enable Data source" step.

OpenShift Plugin

• ndeploying a project deletes the project but the task continues to run in a loop, trying to complete the deletion. This issue is now fixed.

Terraform Plugin

• ixed an issue with the Terraform plugin deleting the .avsc file (Kafka schema) content during deployment.

Tomcat Plugin

• ixed an issue with the start, status, and stop control actions not working as expected with the Tomcat server on a remote host.

WebLogic Server Plugin

• ixed an issue with the rollback of Weblogic Side-by-Side application failing with ItemAlreadyExistsException exception.

WebSphere Application Server Plugin

• ixed an issue with the Create WAS Cluster feature not working.
• ixed an issue with the rsplit attribute missing in the string object.

Bug Fixes and Field Incidents—23.1.16

• D-34534 - Fixed an issue with the Json patch dictionary CI in the Environment section that caused an error while manually executing a query during deployment.

Bug Fixes and Field Incidents—23.1.15

None

Bug Fixes and Field Incidents—23.1.14

• D-25092 - Fixed an issue where users were unable to edit placeholders upon clicking on a deployed application.
• D-33442 - Fixed an issue of excessive API requests and continuous polling in the Deploy web interface when viewing tasks.

Bug Fixes and Field Incidents—23.1.13

None

Bug Fixes and Field Incidents—23.1.12

• S-104674 - Fixed CVE-2024-22243 vulnerability.

Bug Fixes and Field Incidents—23.1.11

• D-32611 - Fixed an error that occurred when setting permissions manually within a folder, the new permissions were not saved.
• D-32379 - Fixed an issue that blocked a successful check connection when the infrastructure CI path includes special characters.
• S-104302 - You can now install Deploy as non-root user in operator based installation.

Bug Fixes and Field Incidents—23.1.10

• D-26046 - Fixed an issue where the application could not be deleted as rollback failed to update Infra-CI with the correct version.
• D-26297 - Fixed an issue that blocked non-admin users to view active monitored tasks after upgrading to v23.1.4.
• D-31833 - Fixed an issue that prevented the active connections in the connection pool from returing on time. The connections in the pool were getting returned only on a restart.
• D-32039 - If the helm binary is not available in the system, the Deploy remote runner installation fails. Fixed this issue by adding a question to check if the the helm binary is already available or not.

Bug Fixes and Field Incidents—23.1.9

• D-27083 - Fixed an issue with the import functionality that was blocking the import of a DAR (DAR file of an application), which included a reference to another CI.
• D-27237 - Fixed an issue where upgrading Deploy from version 9.7.4 to 22.3.6 resulted in an error when attempting to import a new DAR file for an application.
• D-27061 - Fixed an issue with the help command in xl kube upgrade --help to display the correct upgrade instructions.

Bug Fixes and Field Incidents—23.1.8

• D-26985 - After installing Deploy 23.1.7 with HAProxy ingress in a GKE cluster, the operator-controller-manager pod displays an error and restricts the creation of other pods. This issue is now fixed.

Bug Fixes and Field Incidents—23.1.7

• D-26151 - Fixed an issue with xld-deployment-package-status queue consumer, which was growing infinitely with no signs that Deploy is processing the items.

Bug Fixes and Field Incidents—23.1.6

• S-92975 - Added support for remote satellite connection to Deploy running on Kubernetes via the following methods:
  • NodePort dedicated service to the Akka port.
  • LoadBalanced service to the Akka port.
  • Headless service with an external DNS to the Akka port.
• S-93742 - Fixed CVE-2021-35515 vulnerability.
• S-93816 - Fixed CVE-2022-45868 vulnerability.
• D-24625 - Fixed an issue with starting Deploy after upgrading from version 22.2.x to 22.3.x.
• D-25271 - Fixed an issue with the HashiCorp Vault plugin that did not allow you to save multiple lookup values in the "Authentication AppRole" section.
• D-25557 - Fixed an issue that caused Satellite functionality to fail when using a NodePort type of service on Kubernetes.
• D-25760 - Modified the xld_ci_properties table id column type from integer to bigint to accommodate large number of records.
• D-25558 - Fixed an issue with deploying provisioning packages when CI names contain contextual placeholders.
• S-93426 - Fixed the host header injection JavaScript vulnerability in Digital.ai Deploy.
• D-23577 - Fixed archive mappings in the deploy-artifact-resolver.yaml file that caused issues with placeholder replacement.

Bug Fixes and Field Incidents—23.1.5

This version was skipped and 23.1.6 was released in its place.

Bug Fixes and Field Incidents—23.1.4

• D-25096 - Fixed an issue with the Deployment screen that caused multiple errors upon clicking the Finish button.
• D-25368 - Fixed the /actuator/jcaches caching API to only display information relevant to CI caches that are enabled.
• S-93329 - Fixed CVE-2023-20883 vulnerability.
• S-92929 - Fixed an issue with Abort and Stop operations not working on hung tasks.

Bug Fixes and Field Incidents—23.1.3

This version was skipped and 23.1.4 was released in its place.

Bug Fixes and Field Incidents—23.1.2

This version was skipped and 23.1.4 was released in its place.

Known Issues—23.1.1

• Trying to run the plugin manager after upgrading to Deploy 23.1.1 causes the Application failed to start error.

Workaround:

• SERVER_LOCATION: Directory where Deploy is installed.
• PLUGINS_DIRECTORY: This is SERVER_LOCATION/plugins/xld-official for official Digital.ai plugins and SERVER_LOCATION/plugins/__local__ for locally developed plugins.

After you have successfully upgraded to Deploy 23.1.1 and restarted the server, follow these steps:

1. Shut down Deploy server.
2. Make changes in the PLUGINS_DIRECTORY.
   • To add plugins, add the .xldp plugin files for the plugins to the PLUGINS_DIRECTORY location.
   • To delete plugins, delete the .xldp plugin files from the PLUGINS_DIRECTORY location.
   • To update plugins, add the newer version of .xldp plugin files for the plugins to the PLUGINS_DIRECTORY location and delete the older versions.
   • Ensure that all necessary plugin files with correct versions are present in the PLUGINS_DIRECTORY location.
     Note: You may add, delete, and update plugins as a single operation and restart the server once or perform the tasks separately and restart the server after each operation.
3. Restart Deploy server by running run.sh or run.cmd script with the -plugin-source='filesystem' argument.
   For instance, ./bin/run.sh -plugin-source='filesystem' from the SERVER_LOCATION directory.
   Notes:
   • Restarting the server with the -plugin-source='filesystem' argument is only required when you add, delete, or update a plugin. Normal restarts do not require this argument.
   • If you are using Deploy as a service, restart the Deploy service after making changes to the plugins.

Bug Fixes and Field Incidents—23.1.1

• D-23332 - Fixed the issue with saving two lookup values—role ID and secret ID—in secrets.hashicorp.vault.Server.
• D-24130 - Fixed the incoming request has too many parameters error when non-admin users tried to access Deploy reports.
• D-25223 - Fixed an issue that caused deployments to fail when customers used credentials stored in overthere.SshJumpStation instead of the username and password combination.

Known Issues—23.1.0

• • Trying to run the plugin manager after upgrading to Deploy 23.1.0 causes the Application failed to start error.

Workaround:

• SERVER_LOCATION: Directory where Deploy is installed.
• PLUGINS_DIRECTORY: This is SERVER_LOCATION/plugins/xld-official for official Digital.ai plugins and SERVER_LOCATION/plugins/__local__ for locally developed plugins.

After you have successfully upgraded to Deploy 23.1.0 and restarted the server, follow these steps:

1. Shut down Deploy server.
2. Make changes in the PLUGINS_DIRECTORY.
   • To add plugins, add the .xldp plugin files for the plugins to the PLUGINS_DIRECTORY location.
   • To delete plugins, delete the .xldp plugin files from the PLUGINS_DIRECTORY location.
   • To update plugins, add the newer version of .xldp plugin files for the plugins to the PLUGINS_DIRECTORY location and delete the older versions.
   • Ensure that all necessary plugin files with correct versions are present in the PLUGINS_DIRECTORY location.
     Note: You may add, delete, and update plugins as a single operation and restart the server once or perform the tasks separately and restart the server after each operation.
3. Restart Deploy server by running run.sh or run.cmd script with the -plugin-source='filesystem' argument.
   For instance, ./bin/run.sh -plugin-source='filesystem' from the SERVER_LOCATION directory.
   Notes:
   • Restarting the server with the -plugin-source='filesystem' argument is only required when you add, delete, or update a plugin. Normal restarts do not require this argument.
   • If you are using Deploy as a service, restart the Deploy service after making changes to the plugins.

Bug Fixes and Field Incidents—23.1.0

• Fixed an issue with external workers failing to start when initialized from a new directory.
• Fixed an issue with displaying icons on the top-right corner of the UI when the instance name is longer than 150 characters.
• Fixed an issue with long login screen messages without spaces being displayed in a single line and going out of boundary.
• For mandatory steps, instead of displaying an exception on clicking the Skip button, the button is simply not displayed in the UI.
• Fixed an issue that exposed the user's session ID to unauthenticated users.
• Fixed an issue that caused the password to be stored in the Heapdump.
• Fixed an issue with user privileges that allowed users to modify other user accounts.
• Fixed an issue that allowed a user to update all other account details in their tenant.
• Mandated authentication for accessing /xldeploy/metadata/** and /ws API endpoints.
• Fixed the com.xebialabs.deployit.engine.tasker.TaskNotFoundException: could not be found in the archive exception when running a control task in Active-Active cluster setups.
• pgraded XL CLI libraries and updated Golang to version 1.1.9. Made improvements to blueprints and questions.
• ixed an issue with loading plugin manager in Deploy operator server.
• ixed the "keytool can not be found" error with xl kube check during operator installation.
• ixed Deploy operator to enforce password complexity requirements.
• ixed an issue with using backspace in multiline fields in the installer inputs.
• dded support for custom repositories in the XL CLI install and upgrade wizards to support using images from public and private image registries.
• ixed operator installation failure due to storage class defaulting to an incorrect value when no value is selected.
• ixed Kubernetes setup to prevent new lines from being added when selecting cloud provider using arrow keys.
• dded support for Deploy components to be pulled from private registry.
• ixed the default Deploy operator image tag displayed during installation.
• dded documentation for troubleshooting volume permission issues for EFS storage on AWS.
• ixed segmentation fault with XL CLI 22.3.x for Mac OS.
• ixed the "No plugins found" issue in the Deploy Plugins page when installed using XL CLI installer.
• ixed an issue with selecting Nginx as the supported ingress type during xl kube installation.
• ack-ported helmtoOperator/OperatorToOperator upgrader support for OIDC to all supported versions.
• ixed the Deploy login issue through Keycloak login page when OIDC was enabled.