Start Here

Preface

Welcome to the XL Deploy system documentation. This document describes the content of the XL Deploy documentation and helps you find the information you need.

Documentation Contents

The XL Deploy documentation contains all the information needed to install, configure, setup and use XL Deploy. The documentation consists of the following documents:

• Start Here. This is the document you are currently reading.
• Release notes. This document contains the release notes of this and past releases.
• Upgrade Manual. This document describes the procedure to upgrade from a previous version of XL Deploy.
• Reference Manual. This document describes generic deployment concepts and basic information about XL Deploy.
• System Administration Manual. This document describes how to install and maintain XL Deploy.
• Security Manual. This document describes how XL Deploys security system works and how to configure it.
• Graphical User Interface (GUI) Manual. This document describes how to use the XL Deploy GUI.
• Command Line Interface (CLI) Manual. This document describes how to use the XL Deploy CLI.
• Packaging Manual. This document describes how to create packages that can be imported into XL Deploy.
• Customization Manual. This document describes how to customize and extend the out-of-the-box functionality of XL Deploy.
• Rules Manual. This document describes how to use deployment rules.
• Rules Tutorial. Tutorial on how to build a simple plugin with rules.
• Step Reference. This document describes steps available for rules.
• XL Deploy Java API Manual. This document describes how to use Java to customize XL Deploy server functionality.
• Release Dashboard Manual. This document describes how to install, configure and use XL Deploy's Release Dashboard.
• UDM CI Reference. Contains the descriptions of the CIs in the Universal Deployment Model.
• REST API Reference. Contains the description of the REST API.

XL Deploy comes with several standard plugins, whose documentation is also available:

• Command Plugin Manual. This document describes the Command plugin which allows packaging and execution of arbitrary commands.
• Database Plugin Manual. This document describes the Database plugin which is responsible for deploying SQL to databases.
• Deployment Group Orchestrator Plugin Manual. This document describes the Deployment Group Orchestrator plugin which allows fine-grained control over deployment plan orchestration.
• File Plugin Manual. This document describes the File plugin which is responsible for deploying files and folders.
• Generic Model Plugin Manual. This document describes the Generic Model plugin which is a building block to build new plugins.
• JEE Plugin Manual. This document describes the JEE plugin which contains basic JEE CIs.
• PowerShell Plugin Manual. This document describes the PowerShell plugin which is responsible for communicating with PowerShell-based middleware and systems (Windows only).
• Python Plugin Manual. This document describes the Python plugin which is responsible for communicating with Python-based middleware.
• Remoting Plugin Manual. This document describes the Remoting plugin which is responsible for communicating with remote systems.
• Webserver Plugin Manual. This document describes the Webserver plugin which is responsible for deploying static content to webservers.
• Trigger Plugin Manual. Describes the Trigger Plugin, that allows you hook actions on state changes in tasks or steps. You can use it to send emails when a step fails, for example.

Using the Documentation

Every document is written as a standalone document and can be read separately. References to other documents are included when relevant. Depending on your role, some documents are more relevant than others. The following list contains a suggested reading order for specific roles:

• System Administrator: Reference Manual, System Administration Manual, Command Line Interface (CLI) Manual, Customization Manual.
• Deployer: Reference Manual, Graphical User Interface (GUI) Manual, Command Line Interface (CLI) Manual.
• Senior Deployer: Reference Manual, Graphical User Interface (GUI) Manual, Command Line Interface (CLI) Manual, Customization Manual.
• Developer: Reference Manual, Packaging Manual, Graphical User Interface (GUI) Manual.
• Manager: Reference Manual, Graphical User Interface (GUI) Manual, Release Dashboard Manual.

Online Documentation

There is also an online version of the documentation at our documentation site (http://docs.xebialabs.com). The documentation site contains the latest and most up-to-date copy of the documentation.

Contacting XebiaLabs Technical Support

To contact XebiaLabs technical support, use our support desk (http://support.xebialabs.com).

For urgent problems, the XebiaLabs support team can also be reached by phone:

• Europe: +31 85 8883951
• US: (866) 656-4408 (standard US business hours and workdays only)

Quickstart

If you're impatient to get started using XL Deploy, here is a quick rundown of steps you'll need to take and where to find the relevant information:

• Install XL Deploy: see System Administration Manual, section Installation Procedure.
• Setup your environment: see System Administration Manual, section Setting up XL Deploy.
• Import the PetClinic sample application: see Graphical User Interface (GUI) Manual, section Importing Packages or Command Line Interface (CLI) Manual, section Performing a Simple Deployment.
• Deploy the PetClinic sample application: see Graphical User Interface (GUI) Manual, section Initial deployment or Command Line Interface (CLI) Manual, section Performing a Simple Deployment.