Basic Install
This topic describes how to perform a basic installation of Deploy - either a simple setup with the default configuration, or a manual setup in which you can choose specific options. If you are installing Deploy in a production-ready environment that includes options like a separate, clustered database server, load balancing for your Deploy servers, an active/hot-standby cluster configuration for your Deploy servers, and other security, monitoring, and performance considerations, see Production install.
Central Configuration as a Standalone Service
* When you install Digital.ai Deploy, the Central Configuration feature is implemented by default on the application server (Master) as an embedded service.
Central Configuration Overview
As we move towards Kubernetes-based containerized Deploy solution, the Digital.ai Deploy shared configuration files are moved to a centralized location from where they are managed by the Central Configuration Management server. The idea of Central Configuration is to have one central place—in this case, the Digital.ai Deploy's Master server—where you can store, distribute, and manage configuration data for master/worker pods in your cluster. Digitial.ai Central Configuration is the process of maintaining and managing the configuration from a centralized location in the file system. With a centralized management, you can configure workers and masters easily and more efficiently. For example, if you have a Master-Master and Master-Worker setup with two masters and two workers, before Central Configuration you had to individually modify the configuration on all four instances. With the Central Configuration, the configurations are automatically reflected in all the instances.
Configure Active/Hot-Standby Mode
To support high availability (HA), you can configure Deploy in clustered active/hot-standby mode. In this mode, only one Deploy node is active at one time, while the hot standby node is ready to become active if needed.
Deploy CLI Installation
You can install the Deploy command-line interface (CLI) on any remote computer and connect to the Deploy server.
HTTP CSRF Protection
Cross site request forgery or CSRF) is a class of attack that forces an end user to execute unwanted actions on an application when the user is authenticated. The Digital.ai Deploy frontend uses endpoints protected with CSRF .
Install and Configure a Satellite Server
Requirements for a satellite server
Install Deploy Satellite as a Service
You can install and run Deploy Satellite as a service on your Unix or Microsoft Windows machine. The satellite service wrapper requires Java Development Kit 8 or higher to be installed on the target Unix or Windows machine.
Install or Remove a Plugin
Deploy runs on the Java Virtual Machine (JVM) and has two classloaders: one for the server itself, and one for the plugins and extensions. A plugin can have an .xldp or a .jar extension. The XLDP format is a ZIP archive that bundles a plugin with all of its dependencies.
Installation Prerequisites
Here are the software and hardware requirements to install and run Digital.ai Deploy. Your setup might have to be better than the stated minimum requirements depending on your site's size and usage pattern. Contact Digital.ai support for assistance.
Licensing the Deploy Product
In Deploy there are two main types of licenses: a 30 day Trial Edition license, and an Enterprise Edition. If you have an Enterprise Edition of Deploy, you can download your license file from the Deploy/Release Software Distribution site. This site requires enterprise customer login. If you have a Trial Edition of Deploy, you will receive a license key by email when you register to download a trial.
Permission Microservice (BETA)
* The Digital.ai Deploy's Permission service—by default—runs (embedded) on the Digital.ai Deploy server.
Plugins Classloader
Digital.ai Deploy runs on the Java Virtual Machine (JVM) and has two classloaders: one for the server itself, and one for the plugins and extensions. A plugin can have an .xldp or a .jar extension. The XLDP format is a ZIP archive that bundles a plugin with all of its dependencies.
Production Environment Installation
This topic is a step-by-step guide on how to set up Deploy in a production-ready environment. It describes how to configure the product, environment, and server resources to get the most out of the product. This topic is structured in three sections:
Set Up an Active-Active Cluster
This topic describes how to set up an active-active cluster for Deploy with multiple master and multiple external workers.
Start Deploy
To start the Deploy server, open a command prompt or terminal, go to the XLDEPLOYSERVER_HOME/bin directory, and execute the appropriate command:
Trial Install
This topic describes how to install a trial version of Deploy.
Unattended Installation
You can perform an unattended install of the Deploy server, for example, using Puppet.
Upgrade Deploy - JVM
This topic describes the prerequisites, considerations and process for upgrading Deploy from version 10.1 or later to the current version.
Upgrade Satellite Servers
When you upgrade to a new version of Deploy, you must also upgrade your satellite servers to the corresponding version of the satellite distribution ZIP.