This XebiaLabs documentation site supports XL Release and XL Deploy versions 8.6 and earlier. If you are running a newer version or would like to see the features offered by our latest software releases, click here.
  • Blog
  • Support
  • Contact
  • Docs Home
  • Getting started
  • XL Release
    • Overview
    • Installation
      • Requirements
      • Licensing
      • Standard install
      • Production setup
      • Install as a service or daemon
      • Install plugins
    • Get started with XL Release
    • Manage your installation
      • Logging
      • Start XL Release
      • Shut down XL Release
      • Back up XL Release
      • Upgrade XL Release
      • Upgrade to XL Release 7.5
      • Configure the JCR repository and archive database
      • Configure the SQL repository and archive database
      • Configure cluster mode
      • Manage security
        • Configure roles
        • Configure release teams and permissions
        • Configure LDAP security
        • Configure Atlassian Crowd security
        • Change or reset the admin password
        • Update the digital certificate
        • Configure XL Release to trust an XL Deploy server with a self-signed certificate
        • Configure SSL options for HttpRequest
    • Model your releases
      • Work with phases and tasks
      • The task life cycle
      • Task types
        • Types of tasks in XL Release
        • Manual task type
        • Create Release Task type
        • Deploy task type
        • Gate task type
        • Notification task type
        • Parallel group
        • External script task type
        • Sequential group
        • User Input task type
        • Jenkins task type
        • JIRA task types
        • Remote Script task types
        • Webhook task type
      • Using variables
        • Variables in XL Release
        • Create release variables
        • Configure folder variables
        • How to get a value from a map variable
        • Using a configuration object to share global variables
        • Variable usage example
        • Using variables to revise a JIRA issue list
    • Release your software
      • Release overview
        • Release life cycle
        • Release views
        • Using the release overview
        • Using risk awareness
        • Using the release flow editor
        • Using the release table view
        • Using the release planner
        • Overview of release dashboard tiles
        • Release activity logs
      • Create and start releases
        • Configure release properties
        • Schedule releases
        • Start a release from an archived release
        • Start a release from a template
        • Start a release from another release
        • Create a release from a Git repository
        • Add a phase to a release or template
        • Add a task to a phase in a release or template
        • Import a release template
      • Trigger releases
        • Trigger based on a Git commit
        • Trigger based on a Subversion commit
        • Trigger based on a Nexus update
        • Trigger based on a schedule
    • Work with running releases
      • Using release dashboards
      • Using the release summary
      • Using the calendar view
    • Work with plugins
      • Ansible
      • Docker Compose
      • Kubernetes
      • Remoting
      • Community plugins
    • Using reports
      • Reports in XL Release
      • Release automation report
      • Release value stream report
      • XL Release dashboard report
      • Dashboard templates
      • Create a code compliance and security dashboard
    • Customize XL Release
      • API and scripting overview
      • Create custom task types
      • Create custom configuration types
      • Create custom trigger types
      • Extend the XL Release GUI
      • Declare custom REST endpoints
      • Create custom tiles
      • Create custom task types
      • Create custom configuration types
      • Using scheduling in scripts to connect to long running jobs
      • Implement a custom failure handler
      • Listen to XL Release events
    • Configuration settings
      • General settings
      • Global variables
      • Notification settings
      • Profile settings
      • SMTP server
      • Task access
    • Release manuals
      • XL Release 8.6.x
      • XL Release 8.5.x
      • XL Release 8.0.x
      • XL Release 7.5.x
      • Archived versions
  • XL Deploy
    • Overview
    • Installation
      • Requirements
      • Licensing
      • Standard install
      • Production setup
      • Install as a service or daemon
      • Install the XL Deploy CLI
    • Get started with XL Deploy
    • Manage your installation
      • Logging
      • Start XL Deploy
      • Shut down XL Deploy
      • Back up XL Deploy
      • Upgrade XL Deploy
      • The XL Deploy repository
      • Configure the repository
      • Configure XL Deploy to fetch artifacts from a Maven repository
      • Manage security
        • Users, roles, and permissions
        • Configure LDAP security
        • Configure Atlassian Crowd security
        • Change or reset the admin password
      • Manage system settings
        • XL Deploy configuration files
        • Configure failover for XL Deploy
        • High availability with master-worker setup
        • Add, start, and use workers
        • Configure active/hot-standby mode
        • Configure the task execution engine
        • Troubleshoot the Jackrabbit JCR repository
        • Configure XL Deploy client settings
        • Enable XL Deploy maintenance mode
        • Update the XL Deploy digital certificate
        • The XL Deploy work directory
        • Reclaim disk space on an XL Deploy server
        • Hide internal XL Deploy server errors
        • Automatically purge packages according to a user-defined policy
        • Automatically purge the task archive according to a user-defined policy
        • Specify file encoding on the XL Deploy server
        • Automatically archive tasks according to a user-defined policy
        • Best practices for maintaining XebiaLabs tools
    • Connect to your infrastructure
      • Connect XL Deploy to your infrastructure
      • Choose a host and connection type
      • Set up an SSH connection
      • Using CIFS, SMB, WinRM, and Telnet
      • Troubleshoot an SSH connection
      • Troubleshoot a CIFS connection
      • Troubleshoot a Telnet connection
      • Troubleshoot a WinRM connection
      • Discover middleware
    • Set up applications and environments
      • Prepare your application for XL Deploy
      • Create a deployment package
      • Define application dependencies
      • Configure an environment
        • Create an environment
        • Environment as code using Deployfile
      • Using placeholders and dictionaries
        • Using placeholders and dictionaries
        • Using placeholders in deployments
        • Create a dictionary
        • How password properties and encrypted dictionary entries combine to secure sensitive data in XL Deploy
        • Resolving properties during application updates
        • Disable placeholder scanning
      • Working with deployment packages
        • Preparing your application for XL Deploy
        • Understanding deployables and deployeds
        • XL Deploy manifest format
        • Deprecated XL Deploy manifest format
        • Using the XL Deploy Manifest Editor
        • Understanding archives and folders in XL Deploy
        • Add an externally stored artifact to a package
        • Extend the external artifact storage feature
        • Add a package to XL Deploy
        • Export a deployment package
        • XL Deploy for developers
        • Tips and tricks for deployment packages
    • Deploy an application
      • Deployment overview
      • Understanding the XL Deploy planning phase
      • Steps and step lists in XL Deploy
      • Understanding tasks in XL Deploy
      • Deploy an application
      • Use tags to configure deployments
      • Preview the deployment plan
      • Use orchestration
        • Types of orchestrators in XL Deploy
        • Combining multiple orchestrators
        • Examples of orchestrators in XL Deploy
      • Working with deployments
        • Stopping, aborting, or canceling a deployment
        • Schedule a deployment
        • Update a deployed application
        • Staging artifacts in XL Deploy
        • Monitor and reassign deployment tasks
        • Make previously deployed property values available in a PowerShell script
        • Undeploy an application or deprovision an environment
        • Perform canary deployments
        • Perform dark launch deployments
        • Perform hot deployments
        • Deploying an externally stored artifact using the XL Deploy CLI
        • Schedule or reschedule a task
        • Using the deployment pipeline view
      • Deploy to remote datacenters
        • Get started with satellites
        • Configure XL Deploy to communicate with satellites
        • Configure secure communication between XL Deploy and satellites
        • Install and configure a satellite server
        • Troubleshoot satellites
    • Get started with provisioning
      • Provisioning through XL Deploy
      • Create a provider
      • Create a provisioning package
      • Use provisioning outputs in templates
      • Using placeholders in provisioning
      • Using orchestrators with provisioning
      • Provision an environment
      • Provisioning example
    • Introduction to the release dashboard
    • Work with the CLI
      • Get started with the CLI
      • Objects in the CLI
      • Types in the CLI
      • Work with configuration items
      • Discover middleware
      • Execute tasks
      • Set up users, roles, and permissions
      • Troubleshoot the CLI
    • Work with plugins
      • Create an XL Deploy plugin
      • Base plugins and the deployed object
      • Implement custom XL Deploy plugpoints
      • Add a checkpoint to a custom plugin
      • Step options for the Generic, PowerShell, and Python plugins
      • Sample Java-based XL Deploy plugin
      • XL Deploy plugin tutorial
      • Standard plugins
        • Command
        • Database
        • File
        • Generic Model
        • JEE
        • PowerShell
        • Python
        • Remoting
        • Webserver
        • Trigger
      • Middleware plugins
        • Apache Tomcat
        • BizTalk
        • F5 BIG-IP
        • GlassFish
        • IBM WebSphere Application Server
        • IBM WebSphere Process Server
        • IBM WebSphere Liberty Profile Server
        • IBM WebSphere MQ
        • JBoss Application Server 5 and 6
        • JBoss Application Server 7 and up
        • Microsoft Internet Information Services
        • Microsoft Windows
        • NetScaler
        • Oracle Service Bus
        • Oracle Service-Oriented Architecture
        • Oracle WebLogic Application Server
      • Provisioning plugins
        • Amazon Web Services
        • Microsoft Azure
        • Terraform
        • Cloud Foundry
      • Container platform plugins
        • OpenShift
        • Kubernetes
      • Tools
        • XL Deploy plugin for Maven
        • XL Deploy plugin for Jenkins
        • XL Deploy plugin for Bamboo
        • Puppet
        • Chef plugin for XL Deploy
        • Docker plugin for XL Deploy
        • XL Deploy plugin for Team Foundation Server
        • XL Deploy plugin for Visual Studio Team Services / Team Foundation Server
      • Community plugins
    • Using control tasks
    • Using the explorer
    • Using XL Deploy reports
    • Customize XL Deploy
      • API and customization overview
      • Customize CI types
      • Customization using rules
        • Get started with rules
        • Define a rule
        • Writing XML rules
        • Writing script rules
        • Use a predefined step in a rule
        • Using step macros
        • Create a custom step for rules
        • Best practices for rules
        • Rules tutorial
      • Customization using Java
        • Create a plugin
        • Implement a custom plugpoint
        • Plugin tutorial
      • Create custom control tasks
      • Extend the user interface
    • Release manuals
      • XL Deploy 8.6.x
      • XL Deploy 8.5.x
      • XL Deploy 8.0.x
      • XL Deploy 7.5.x
      • Archived versions
  • DevOps as Code
    • Get started with DevOps as Code
    • Install the XL CLI
    • XL CLI command reference
    • Work with the YAML format
    • YAML snippets reference
    • Manage values in DevOps as Code
    • Track progress using XL CLI output
    • Manage risk profiles
    • Manage XL Deploy permissions in YAML
    • Manage XL Release permissions in YAML
    • Manage XL Release folder permissions in YAML
    • Tutorial: Managing an XL Release template as code
  • Blueprints
    • Get started with blueprints
    • XebiaLabs public blueprints
    • Blueprint YAML format
    • Manage blueprint repositories
    • Tutorial: Deploying an app to AWS using a blueprint
  • API and CI references
    • XL Release references
      • Release manual
      • XL Release REST API
      • XL Release Jython API
      • XL Release DSL API
    • XL Deploy references
      • XL Deploy REST API
      • XL Deploy Jython API
      • XL Deploy Javadoc
      • UDM CI reference
      • Satellite CI reference
  • Plugins
    • XL Release plugins
      • Ansible
      • Blackduck
      • Checkmarx
      • Docker Compose
      • Fortify On Demand
      • Fortify SSC
      • Kubernetes
      • OpenShift
      • Relationships
      • Remoting
      • Sonarqube
      • ServiceNow
      • VSTS/TFS
      • Community plugins
      • Jira
      • Octopus Deploy
    • XL Deploy plugins
      • Standard plugins
        • Command
        • Database
        • File
        • Generic Model
        • JEE
        • PowerShell
        • Python
        • Remoting
        • Webserver
        • Trigger
      • Middleware plugins
        • Apache Tomcat
        • BizTalk
        • F5 BIG-IP
        • GlassFish
        • IBM WebSphere Application Server
        • IBM WebSphere Process Server
        • IBM WebSphere Liberty Profile Server
        • IBM WebSphere MQ
        • JBoss Application Server 5 and 6
        • JBoss Application Server 7 and up
        • Microsoft Internet Information Services
        • Microsoft Windows
        • NetScaler
        • Oracle Service Bus
        • Oracle Service-Oriented Architecture
        • Oracle WebLogic Application Server
      • Provisioning plugins
        • Amazon Web Services
        • Microsoft Azure
      • Container platform plugins
        • OpenShift
        • Kubernetes
      • Tools
        • XL Deploy plugin for Maven
        • XL Deploy plugin for Jenkins
        • XL Deploy plugin for Bamboo
        • Puppet plugin for XL Deploy
        • Chef plugin for XL Deploy
        • Docker plugin for XL Deploy
        • XL Deploy plugin for Team Foundation Server
        • XL Deploy plugin for Visual Studio Team Services / Team Foundation Server
      • Community plugins
  • Videos
  • Community
  • Fix Trackers
    • XL Release Fix Tracker
    • XL Deploy Fix Tracker
  • Archive

Collapse All | Expand All

XebiaLabs documentation
  1. XL Release
  2. XL Release how-to

XL Release how-to

  • Archiving and data export
    • Configure the archive database
    • Create an export hook
    • Create a JDBC export hook
    • Downloading and anonymizing archived releases
  • Authentication
    • Configure LDAP security for XL Release
    • Configure Integrated Windows Authentication for XL Release
    • Configure Atlassian Crowd security for XL Release
  • Blueprints
    • Tutorial for deploying an application to AWS using a blueprint
  • Bundled plugins
    • Using the XL Release Docker Compose plugin
    • Extend the XL Release Plugin for XL Deploy using python SDK
    • Using the XL Release Fortify SSC plugin
    • Using XL Release JIRA tasks
    • Using the XL Release Kubernetes plugin
    • Using XL Release Remote Script tasks
    • Using the XL Release Remoting plugin
    • Using the XL Release Black Duck plugin
    • Using the XL Release plugin for Jenkins
    • Using the XL Release VSTS/TFS plugin
    • Using the XL Release Ansible plugin
    • Migrating from the community XL Deploy plugin for XL Release to the officially supported plugin
    • Using XL Deploy plugin for XL Release
  • Calendar
    • Set blackout period
  • Calling XL Deploy from XL Release
    • Configure XL Release to trust an XL Deploy server's certificate
    • Create an XL Deploy task
    • Perform Blue/Green deployments
    • Perform Canary Release deployments
    • Perform deployment rollback
    • Load test data during a release
    • Configure XL Deploy servers
  • Connectivity
    • Configure certificate trust, hostname verification, and other SSL options for HttpRequest
  • Dashboards
    • Install the Octopus Deploy plugin
    • Create a code compliance and security dashboard
    • Configure custom dashboards
    • Add a Total number of deployments tile to a dashboard
    • Add a markdown tile to a dashboard
    • Add a Deployment success rate tile to a dashboard
    • Add a Deployment distribution tile to a dashboard
    • Add a Deployment activity tile to a dashboard
    • Add a Current applications tile to a dashboard
  • DevOps as Code
    • Install the XL Command Line Interface
    • Manage XL Release risk profiles in YAML
    • Manage values in DevOps as Code
    • Manage XL Release environments and applications in YAML
    • Manage XL Release folder permissions in YAML
    • Manage XL Release permissions in YAML
    • Track progress using XL CLI output
    • Tutorial for managing an XL Release template as code
    • Work with the YAML format
  • DevOps as Code and Blueprints
    • Create and manage your own blueprints
  • Docker
    • Running the XebiaLabs Docker containers with Docker Compose
    • Use the XL Release Docker images
  • Environments
    • Schedule environments
  • Events
    • Listen to XL Release events
  • Extending XL Release
    • Extend the XL Release user interface
    • Declare custom REST endpoints
    • Create custom tiles
    • Create custom task types
    • Create custom configuration types
    • Using scheduling in scripts to connect to long running jobs
  • Folders
    • Manage templates and releases using folders
    • Migrating templates to folders
  • Getting started
    • Get started with XL Release
  • Installation
    • Install XL Release
    • Install XL Release as a service
    • Start XL Release
    • Upgrade XL Release
    • Upgrade to XL Release 7.5.x or later
    • Install or remove XL Release plugins
    • How to set up XL Release in production
    • Speed up the XL Release 4.6.x upgrade
  • Jira
    • Configure the Jira XL Release plugin
  • Pipeline
    • Using the pipeline view
  • Public API
    • Create a new release via the REST API
    • Using the XL Release API in scripts
    • How to find identifiers for use in the REST API
  • Releasefile
    • Using the Releasefile view
  • Releases
    • Create a release template
    • Configure release properties
    • Configure release teams and permissions
    • Using the release flow editor
    • Add a phase to a release or template
    • Add a task to a phase in a release or template
    • Using the release table view
    • Using the release planner
    • Using the release summary (XL Release 4.8.x and earlier)
    • Scheduling releases
    • Import a release template
    • Start a release from an archived release
    • Start a release from a template
    • Start a release from another release
    • Using the release dashboard
    • Restart a phase in an active release
    • Using the release overview
    • Using Dynatrace with XL Release
    • Using release groups
    • Using OpsGenie with XL Release
    • Create a release from a Git repository
    • Using the Release Relationships View
    • Using template version control
  • Remoting
    • Choose a host type and connection type
    • Using CIFS, SMB, WinRM, and Telnet
    • Using SSH
    • Troubleshoot an SSH connection
    • Troubleshoot a CIFS connection
    • Troubleshoot a Telnet connection
    • Troubleshoot a WinRM connection
  • Risk Awareness