Add Stitch support to plugins
Custom or community plugins that want to support the transform of artifacts using Stitch rules, must call the Stitch Engine transformer.
Custom or community plugins that want to support the transform of artifacts using Stitch rules, must call the Stitch Engine transformer.
Learn how to manage application images in air-gapped environments. Following are the five different options you can use to ensure your application images are available in air-gapped environments.
Here are some examples how to backup the content of the Deploy installation on K8s cluster.
* Deploy 23.1 and later lets you cache frequently accessed data for better performance and reduced latency.
This section describes how to install Central Configuration service as a separate service when you install or upgrade the Digital.ai Deploy solution.
This topic describes the transition to a Kubernetes-based containerized Deploy solution, where Digital.ai Deploy shared configuration files are moved to a centralized location managed by the Central Configuration Management server.
During our performance testing activity, we used the 'Cache hit %' metric to understand how caching improves performance. This metric indicates the percentage of overall data requests that were successfully retrieved from the cache.
Note: Any failure during the caching setup will be captured in the logs but will not stop the application from starting.
Note: Active-Hot-standby mode is not supported for caching setup.
This topic illustrates how to configure SSL/TLS with Digital.ai Deploy. A self-signed certificate is used for illustrative purposes in this procedure. However, you may want to replace it with your own trusted certificate for production environments, which you can do by creating a new Secret object in Kubernetes that contains your certificate and then configuring the ingress controller to use it.
From 23.3 version, there are changes how is working answer to the question:
Prerequisites
This topic explains how to enable file logging in the Kubernetes cluster for Deploy application.
Implementing custom input/output formats
You can retrieve and delete cached data using the following actuator API endpoints:
Stitch is a collection of tools available out-of-the-box with Deploy. Stitch extends Deploy’s capability and enables the field experts in your organization to define and build scaled customizations and variants of reusable deployment patterns that your cloud-native teams can effortlessly consume for their cloud and container deployments.
This page defines the terms you will encounter in Deploy.
You can install Deploy on an air-gapped environment disconnected from the public internet. This topic provides information about installing and upgrading Deploy in such environments using a Minikube cluster and a custom image registry. For other Kubernetes platforms, steps are similar to the ones listed here for Minikube as long as the custom image registry contains all the required images.
Note: Here is a basic setup for the AWS EKS cluster, use it as a guideline to create K8s cluster to have minimal K8s environment for Digital.ai Deploy or Release installation.
Note: Here is a basic setup for the Azure K8S cluster, use it as a guideline to create K8s cluster to have minimal K8s environment for Digital.ai Deploy or Release installation.
Note: Here is a basic setup for the GKE cluster, use it as a guideline to create K8s cluster to have minimal K8s environment for Digital.ai Deploy or Release installation.
Note: Here is a basic setup for the AWS Openshift cluster,
Important: Use these instructions to install Digital.ai Deploy or Release on a minikube multi-node cluster for testing or illustration purposes. Do not use these instructions to set up a production environment.
* Here's a list of questions that you would have to answer to install Digital.ai Deploy using the xl kube install command.
Learn how to install and use this product on your Red Hat platform.
Stitch is a new capability of digital.ai Deploy that provides a declarative way to customize configuration files for deployments of bespoke applications and commercial of the shelf components (COTS). It is designed for the world of cloud and containers, and builds on top of Deploy concepts of UDM model, types, rules engine and plugins.
Introduction
This tutorial will teach you how to use Stitch capability of Digital.ai Deploy, when deploying to a Kubernetes cluster. For more information about Stitch, please see Introduction to Stitch.
The Lock plugin is a Deploy plugin that adds capabilities for preventing simultaneous deployments.
Here's what it takes to manage Digital.ai Deploy plugins, if Deploy master is not working, on a Deploy cluster that was created using the Operator-based installer:
PostgreSQL cannot be automatically upgraded during an operator-to-operator or Helm-to-operator upgrade due to incompatible data formats between different PostgreSQL server versions. In such cases, a manual upgrade is necessary. The process involves first backing up the PostgreSQL data, then upgrading to the new PostgreSQL version, and finally restoring the data in the upgraded version.
RabbitMQ during operator2operator upgrade or helm2operator upgrade to version 23.3 of operator will not upgrade automatically to the latest RabbitMQ server version.
This topic illustrates how to set up the persistent volumes on the Deploy containers.
Here is the list of parameters for the Digital.ai Deploy Custom Resource (CR).
You use the XL CLI's xl kube command to install or upgrade Digital.ai Deploy or Release, or Release Runner. For more information, see XL Kube Command Reference.
From 23.3 plugin management is possible with XL CLI utility. For more information, see Plugin Manager CLI.
In order for Deploy to apply any Stitch transformation, the plugin needs to have a support for Stitch since it controls the content in it.
Follow these instructions if you have chosen Keycloak for OIDC authentication.
When user wants to generate additional documents based on the content of the deployment plugin uses preprocessing or postprocessing stitch transformation. Preprocessing should be used if generated documents should go through regular stitch transformations and postprocessing should be used when no additional transformation is expected.
This topic illustrates how to use the diagnostic mode in Deploy.
Stitch sources are created under the Configuration tab of the CI Explorer. Using configuration or folder permissions, you can show/hide Stitch sources. As a Stitch source is also a CI, it has the same logic for permissions as all other CI’s.
Configuring OIDC is one of the steps in installing or upgrading Digital.ai Deploy using the Operator-based installer.
Configuring OIDC is one of the steps in installing or upgrading Digital.ai Deploy or Release using the Operator-based installer.
This topic illustrates on how to set up the custom context root on the Deploy.
This topic illustrates on how to set up JVM arguments for application containers.
This topic illustrates on how to set up a truststore to store trusted certificates that are used to verify the identities of parties in a secure communication.
This topic describes how to add additional JARs to the Deploy classpath, specifically focusing on installing the Oracle JDBC driver. There are three main options available:
This article provides information on how to create an Artemis cluster (JMS 2.0) and integrate it with Deploy.
This topic outlines the procedure to setup Active Messaging Queue (MQ) Artemis in highly available configuration with UDP protocol. It also describes how Digital.ai Deploy can be connected to Artemis nodes.
In this article, you will learn how to set up a custom image registry to install or upgrade Release. A custom image registry can either be public (not password protected) or private (password protected).
Stitch macros are reusable building blocks which group the common processors used inside of Stitch rules.
Some of the Stitch features, like preview or dry run, can be run through either Jython or XL CLI.
When you use the Preview option of the deployment plan, you can also see the Stitch preview for it, by using the toggle button to switch between two views. After clicking on the Stitch preview toggle, you can also browse and view Stitch invocation details.
A Stitch processor is a part of a Stitch rule that is responsible for modifying the application's resource configuration files during the deployment planning phase. Processors are defined in a Stitch YAML file in the processor array.
The Stitch Workbench is a part of Deploy's web-based user interface that provides an overview of all customizations known to Stitch.
If you need to do some customization in the CR file or in the operator deployment, check the following sections.
You must use the custom resource definition file (CR file) in case you want to change the Digital.ai Deploy's license on sites installed using the Operator-based installer.
* Here's a list of questions that you would have to answer to upgrade Digital.ai Deploy using the xl kube upgrade command.
Patch upgrades from 23.3
If you plan to use an existing database—one that is not created by default by the Operator-based installer—you must configure the relevant database parameters in the daideploy_cr.yaml file.
If you plan to use an existing database—one that is not created by default by the Operator-based installer—you must configure the relevant database parameters in the daideploy_cr.yaml file.
If you plan to use an existing message queue — one that is not created by default by the Operator-based installer — you must configure the relevant MQ parameters in the daideploy_cr.yaml file.
This topic illustrates how to use an external database instead of the one that is provided with the operator itself.
If you plan to use an external message queue, instead of the RabbitMQ provided with the operator—you must configure the relevant parameters in the external-mq-patch.yaml file.
This topic illustrates how to replace the CR values that are in clear-text format in the CR with the secret references.
The Deploy support accelerator gathers data that helps the Digital.ai Support Team to troubleshoot issues.