- Docs Home
- Getting started
- XL Release
- Overview
- Installation
- Get started with XL Release
- Manage your installation
- Model your releases
- Release your software
- Release overview
- 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
- Work with running releases
- Work with plugins
- Using reports
- 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
- Release manuals
- XL Deploy
- Overview
- Installation
- 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
- 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
- Set up applications and environments
- Prepare your application for XL Deploy
- Create a deployment package
- Define application dependencies
- Configure an environment
- Using placeholders and dictionaries
- 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
- 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 provisioning
- Introduction to the release dashboard
- Work with 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
- 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
- Container platform plugins
- Tools
- Community plugins
- Using control tasks
- Using the explorer
- Using XL Deploy reports
- Customize XL Deploy
- Release manuals
- 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
- API and CI references
- Plugins
- XL Release plugins
- XL Deploy plugins
- Standard plugins
- 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
- Container platform plugins
- Tools
- Community plugins
- Videos
- Community
- Fix Trackers
- Archive
Valid since:
XL Deploy 6.0.0
Provisioning through XL Deploy
XL Deploy’s provisioning feature allows you to provide fully automated, on-demand access to your public, private, or hybrid cloud-based environments. With provisioning, you can:
- Create an environment in a single action by provisioning infrastructure, installing middleware, and configuring infrastructure and middleware components
- Track and audit environments that are created through XL Deploy
- Deprovision environments created through XL Deploy
- Extend XL Deploy to create environments using technologies not supported by default
Note: A version of this topic is available for XL Deploy 5.5.x.
Provisioning packages
A provisioning package is a collection of:
- Provisionables that contain settings that are needed to provision the environment
- Provisioners that execute actions in the environment after it is set up
- Templates that create configuration items (CIs) in XL Deploy during the provisioning process
For example, a provisioning package could contain:
- A provisionable that creates an Amazon Web Services EC2 instance (
aws.ec2.InstanceSpec
) - A Puppet provisioner that installs Apache HTTP Server on the instance (
puppet.provisioner.Manifest
) - Templates that create an SSH host CI (
template.overthere.SshHost
), a Tomcat server CI (template.tomcat.Server
), and a Tomcat virtual host CI (template.tomcat.VirtualHost
)
The process of provisioning a cloud-based environment through XL Deploy is very similar to the process of deploying an application. You start by creating an application (udm.Application
) that defines the environment that you want to provision. You then create provisioning packages (udm.ProvisioningPackage
) that represent specific versions of the environment definition.
Providers
You can also define providers, which are cloud technologies such as Amazon Web Services EC2 (aws.ec2.Cloud
). A provider CI contains required connection information, such as an access key ID and a secret access key. You define provider CIs under Infrastructure in the XL Deploy Repository. After you define a provider, you add it to an environment (udm.Environment
).
Provisioneds
After you have created packages and added providers to an environment, you start provisioning the same way you would start a deployment. When you map a provisioning package to an environment, XL Deploy creates provisioneds based on the provisionables in the package. These are the actual properties, manifests, scripts, and so on that XL Deploy will use to provision the environment.
Supported provisioning technologies
Support for provisioning technologies is provided through plugins. To see the provisioning plugins that are available, refer to the version of XL Deploy that you are using (for example, XL Deploy 5.5.x).
Get started with provisioning
To get started with XL Deploy provisioning:
- Upgrade to XL Deploy 5.5.0 or later.
- Create a provisioning package.
- Create a provider and add it to an environment.
- Provision the environment.
- Deploy to the environment.
- Deprovision the environment.
Limitations and known issues
- It may take one minute or longer to generate a provisioning plan preview if the plan includes many provisioneds.
- When creating an
aws.ec2.InstanceSpec
CI, you can only enter an AWS security group that already exists. To use a new security group, you must first create it manually in AWS. - In reports:
- Provisioning and unprovisioning actions appear on the Deployments tab
- Provisioning environments are listed on the Deployed Applications tab