Add a checkpoint to a custom plugin
This topic guides you through the process of adding a checkpoint to a custom plugin in Deploy.
This topic guides you through the process of adding a checkpoint to a custom plugin in Deploy.
This topic describes how to handle a simple case by executing a remote shell command on a server.
This topic explains how to add resources to a Tomcat container in Deploy.
Before You Begin
This topic describes how the Digital.ai Deploy plugin manager operates in environments with restricted internet access.
This topic describes how the Deploy Apache Tomcat plugin is used to manage deployments on a Tomcat server.
This topic describes using a CI tool plugin to interact with Deploy.
This topic describes how to use Deploy with AWS CodePipeline.
This topic outlines the AWS plugin for Deploy, which supports launching, managing, and configuring various AWS services.
This topic describes how to work with the Microsoft Azure cloud computing service.
The Deploy Azure plugin enables Deploy to work with the Microsoft Azure cloud computing service. You can provision Virtual Machines, Containers, and Deploy functionApp and WebApp from Deploy.
Although the content in this topic is relevant for this version of Deploy, we recommend that you use the rules system for customizing deployment plans. For more information, see Getting started with Deploy rules.
When customizing Deploy, it is recommended that you start by extending configuration item (CI) types and writing rules.
The Deploy Chef plugin uses the Chef provisioning tool (chef-solo) to install recipes on hosts.
This topic provides information about the Citrix NetScaler Application Delivery Controller plugin. You can enable Deploy to manage deployments to applications and web servers whose traffic is managed by a NetScaler load-balancing device.
This topic provides information on the Cloud Foundry CLI Integration, which enables Deploy integration with Cloud Foundry servers by utilizing the CF CLI installed on a remote host.
This topic describes the Deploy Cloud Foundry plugin, which supports creating spaces, deploying applications, creating routes, binding services, and using manifest files.
This topic describes how to use the Deploy Command plugin to execute scripts on remote systems without manually logging in to each system, copying required resources, and executing scripts or commands.
The Deploy Generic plugin adds support for mail servers to Deploy. A mail server is a mail.SmtpServer configuration item (CI) defined under the Configuration root node.
This topic covers the Deploy Google Cloud Compute plugin, which supports Deploy Instance Spec, Deploy Template Spec, and DialogFlow Agent Zip Spec deployables.
This topic describes the Generic Model plugin, which includes predefined control task delegates capable of executing scripts on a target host.
This topic covers the customization of Deploy using the Java programming language. By implementing a server plugpoint, you can change certain Deploy server functionality to adapt the product to your needs. And if you want to use Deploy with new middleware, you can implement a custom plugin.
This topic describes the Deploy Database plugin, which supports the deployment of SQL files and folders to a database client.
This topic covers defining and implementing methods on Configuration Items (CIs) in Deploy, specifically for control tasks.
This topic provides information about the Deploy concepts for using Deploy.
Why Deploy Integration with Backstage?
This tutorial will explain the basic case of deploying a file to a target Container and doing something on the target Container with that file.
With Deploy modular architecture you can change and extend components while maintaining a consistent system.
This topic details the features and requirements of the Deploy Terraform Enterprise plugin.
This topic covers the Deploy WebLogic server (WLS) plugin, which allows you to manage deployments and resources on an Oracle WebLogic server. With this plugin, you can deploy multiple versions of the same application at the same time, which is known as a side-by-side deployment or versioning.
Deploy does not allow the creation or discovery of multiple CIs with the same name, and considers them as duplicates. However, Websphere allows the creation of such resources with the same name, as long as they are of different types.
The Kubernetes plugin supports discovery of k8s.Master and k8s.Namespace CIs from a Kubeconfig file. To discover,
This topic describes how the Generic plugin supports discovery in any subtype of generic.Container, generic.NestedContainer, or generic.AbstractDeployed.
This topic explains about Discovery in the IBM WebSphere AS plugin.
This topic describes how to use the JBoss Application Server plugin to discover properties of a running JBoss server after specifying the JBoss server home location and the host on which the JBoss server is running.
This topic explains how to use the Deploy WebLogic (WLS) plugin to discover middleware containers on a server running Oracle WebLogic after specifying the host and domain.
The Deploy Docker plugin allows you to deploy Docker images to create containers and connect networks and volumes to them.
This topic describes how the Database plugin uses the Deploy rules system to provide improved rollback support for SQL scripts.
This topic covers extending the Deploy plugin for Deploy plugin for JBoss Enterprise Application Platform (EAP) 6 and JBoss Application Server (AS)/WildFly 7.1+ using the Deploy plugin API type system and Jython.
This topic covers the Deploy GlassFish plugin is designed to be extended through the Deploy plugin API type system and Jython. The plugin wraps the GlassFish command-line interface (CLI) with a Jython runtime environment, so that extenders can interact with GlassFish and Deploy from the script.
You can extend the IBM WebSphere Application Server (WAS) plugin through Deploy's plugin API type system and using custom, user-defined Python scripts.
You can extend the IBM WebSphere MQ (WMQ) plugin using the Deploy plugin API type system.
This topic explains how to extend the JBoss Application Server plugin using the Deploy plugin API type system and the Generic plugin patterns.
You can extend the Deploy Oracle WebLogic (WLS) plugin using the Deploy plugin API type system and by using custom WebLogic Scripting Tool (WLST) Python scripts.
This topic provides information about the Apache Tomcat plugin for Deploy which is designed to be extended through Deploy's plugin API type system.
This topic describes the Generic model plugin that provides the possibility to extend Deploy with new middleware support without having to write Java code.
This topic describes the Deploy GlassFish plugin, which adds the capability to manage deployments and resources on the GlassFish application server. It can manage application artifacts, datasource and JMS resources via the GlassFish CLI, and can be extended to support more deployment options or management of new artifacts and resources on GlassFish.
The Digital.ai Deploy Google Cloud Compute plugin allows you to deploy the Digital.ai Deploy instance on the Google Cloud platform.
The Digital.ai Deploy Helm plugin can deploy and undeploy Helm charts on a Kubernetes host.
This topic provides information on how to use the Podman plugin.
This topic describes the DataPower plugin for Deploy, which allows you to manage the configuration of an IBM DataPower Gateway appliance. You can provide a configuration file in XML or ZIP format, import it in your DataPower appliance, and persist the configuration for a selected domain.
The IBM WebSphere Application Server (WAS) plugin adds capability for managing deployments and resources on an existing WebSphere application server. It offers support for deploying and undeploying application artifacts, datasources, JMS resources, and other Java EE resources and WAS configurations.
This topic The Deploy WebSphere Liberty profile server (WLP) plugin adds capability for managing deployments and resources on Liberty profile server. It works out of the box for deploying/upgrading/undeploying application artifacts, features, and resources like datasources, libraries and filesets.
The Deploy IBM WebSphere MQ (WMQ) plugin can be used to manage resources on a WebSphere MQ environment. The plugin can deploy and undeploy local queues and alias queues on a queue manager, and can be extended to support the management of other resources in a WebSphere MQ environment.
You can use the Deploy IBM WebSphere Process Server (WPS) plugin to manage deployments and resources on an existing WebSphere Process Server server. The plugin provides supports deploying and undeploying applications (EAR files) and can be extended to support more deployment options or management of new artifacts and resources on WPS.
This topic describes how functionality in the Deploy server can be customized by using plugpoints. Plugpoints are specified and implemented in Java. On startup, Deploy scans its classpath for implementations of its plugpoints in the com.xebialabs or ext.deployit packages and prepares them for use. There is no additional configuration required.
This topic provides information about how Deploy runs on the Java Virtual Machine (JVM) and utilizes 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.
The F5 BIG-IP plugin adds the ability to manage deployments to application servers and web servers with traffic that is managed by a BIG-IP load balancing device.
The Deploy File plugin is used to define resources in a deployment package and manage them on a target host. With Deploy File plugin you can deploy a file.File, file.Folder, or file.Archive configuration item (CI) on an overthere.Host CI.
This topic describes the Deploy JBoss Application Server (AS) plugin that adds the capability to manage deployments and resources on a JBoss Application Server.
This topic describes how to manage deployments and resources using JBoss Domain or jbossdm plugin.
The Deploy JEE plugin provides support for Java EE archives such as EAR files and WAR files, as well as specifications for resources such as JNDI and mail session resources.
This topic covers the Deploy Kubernetes (K8s) plugin, which supports creating and managing Kubernetes resources such as Namespaces, Pods, Deployments, ConfigMaps, Secrets, and more, using various authentication methods.
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 on a Deploy cluster that was created using the Operator-based installer:
The Deploy BizTalk plugin adds the capability to perform BizTalk configuration and deployment tasks.
The Deploy Microsoft Internet Information Services (IIS) plugin adds the capability to perform IIS deployments and configuration tasks.
With the Deploy OpenShift plugin, you can deploy OpenShift and Kubernetes resource types directly from Deploy.
This topic provides information about the Deploy Oracle Service Bus (OSB) plugin, which supports the importing and deleting OSB projects.
This topic provides information about Oracle SOA plugin.
You can use the Deploy Oracle WebLogic server (WLS) plugin to manage deployments and resources on a WebLogic server. It can deploy and undeploy application artifacts, as well as datasources and other JMS resources. You can extend the plugin to support more deployment options or management of new artifacts or resources on WebLogic. For more information
This topic describes how to check the connection between Deploy and a satellite by pinging the satellite. This process tests the entire network and application stack and check your parameters.
The Digital.ai Deploy plugin manager displays the list of plugins on the filesystem or database and their current version. You can delete Digital.ai Deploy plugins with the plugin manager command-line interface (CLI) from the database or filesystem. It is also possible to add and update plugins with the plugin manager CLI.
This section describes some of the common user issues faced when using the Plugin Manager with corresponding response messages.
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.
This topic provides information on how Digital.ai Deploy operates on the Java Virtual Machine (JVM) with two classloaders: one for the server and one for plugins and extensions. Plugins can be packaged in either .xldp or .jar formats, with the XLDP format being a ZIP archive that includes the plugin and all its dependencies.
This topic provides information on the Digital.ai Deploy plugin manager, which displays the list of installed plugins on the filesystem or database along with their current versions. You can manage your Digital.ai Deploy plugins directly from the user interface, including uploading new plugins or updating existing ones.
The Deploy Podman plugin allows you to deploy Podman images to create containers. Additionally, you can connect networks and volumes to these containers.
This topic provides information about Deploy PowerShell plugin to create extensions and plugins that require PowerShell scripts to be executed on the target platform. For example, the Deploy plugins for Windows and Internet Information Services (IIS) are built on top of this plugin.
This topic describes the steps required to use the Deploy Docker plugin. First, you need to create a Docker registry and then configure the necessary settings in Deploy to integrate with the registry.
The Puppet plugin is a Deploy plugin that uses the Puppet provisioning tool to install modules and manifests on hosts.
This topic explains the necessity of restarting a Deploy satellite after synchronizing plugins. The restart ensures that Java classes, scripts, rules, and other resources are properly loaded into the JVM, and it resets the satellite's internal state.
This example describes some classes from a test plugin we use at Digital.ai, the Yak plugin.
This topic demonstrates how to use the Generic plugin in Deploy.
You can use the Deploy Script plugin to enable Deploy to install and provision scripts on hosts.
This topic outlines the step options available for the Generic, PowerShell, and Python plugins.
This topic describes the requirement to synchronize Deploy with satellite servers if you add, remove, or update a Deploy plugin or extension before performing a deployment.
When you define and use configuration items (CIs) with the Generic Model plugin, you may need to use variables in certain CI properties and scripts. For example, you can use this method to include properties from the deployment itself, such as the names or locations of files in the deployment package. Deploy uses the FreeMarker templating engine for this.
This topic provides information on using the Deploy Terraform plugin to apply and destroy Terraform resources.
This topic details the Trigger plugin in Deploy, enabling configuration for email notifications based on specific events such as step failures or successful deployment completions.
This topic provides guidance on troubleshooting the Tomcat plugin in Deploy.
Deploy rules enable you to use XML or Jython to specify the steps that belong in a deployment plan and how the steps are configured. Several Deploy plugins include predefined rules that you can use when writing rules. For more information on rules, see Get started with rules.
This topic provides information on using the Docker plugin. he Docker plugin allows you to manage Docker containers and images, enabling you to integrate Docker operations into your deployment processes.
You can use the Deploy OpenShift plugin to create or destroy OpenShift resources on an OpenShift server.
Deploy uses the FreeMarker templating engine to allow you to access deployment properties such as such as the names or locations of files in the deployment package.
The Deploy Web Server plugin provides the deployment of web content and web server configuration to a web server.
You can use Deploy Windows plugin to perform common Microsoft Windows configuration and deployment tasks.