Get started with the XL Deploy user interface

The XL Deploy graphical user interface (GUI) is an HTML5-based UI that enables you to automate and standardize complex deployments in cloud, container, and legacy environments.

This topic provides a brief introduction to some of the key features you will use in XL Deploy.

Customize the initial view

You have two choices for your initial view when you access the XL Deploy GUI:

  • Default view
  • Deployment Workspace view

Here is the default view when you log in to XL Deploy:

Default view

From this view, clicking Start a deployment opens the deployment workspace that shows your applications on the left pane, and your environments on the right pane.

Deployment workspace view

The deployment workspace supports drag and drop for selecting your applications and environments and starting a deployment. For details, see Use the deployment workspace.

If you want to change the initial view to feature the deployment workspace, edit the xl-deploy.conf file to include a gui section and specify the landing-page value as deploymentWorkspace:

xl {
   gui {
       landing-page=“deploymentWorkspace”
xl {
   gui {
       landing-page=“deploymentWorkspace”
       toastr {
           error {
               timeout-ms=0
           }
           info {
               timeout-ms=10000
           }
           success {
               timeout-ms=10000
           }
           warning {
               timeout-ms=10000
           }
       }
           error {
               timeout-ms=500
           }
           info {
               timeout-ms=500
           }
           success {
               timeout-ms=500
           }
           warning {
               timeout-ms=500
           }
       }
   } .. }

For details about the configuration properties defined in the xl-deploy.conf file, see XL Deploy configuration files.

The basics

Here are some of the common actions you can perform using the GUI:

Examples

This section describes some of the common activities you can perform using the GUI.

Deploy an application from Applications tree

To deploy an application:

  1. Click Explorer in the top bar and expand Applications.

  2. Locate and expand the application that you want to deploy or provision.

  3. Click Context menu next to the desired deployment or provisioning package and select Deploy. The list of available environments appears in a new tab.

  4. Select the environment where you want to deploy or provision the package and then click Continue.

    Select environment

  5. You can optionally change the mapping of deployables to containers using the buttons in the center. To edit the properties of a deployed, double-click it. To edit the deployment properties, click Deployment Properties.

    Mapping screen

  6. To start the deployment immediately, click Deploy. If you want to skip steps or insert pauses, click the arrow next to Deploy and select Modify plan. If you want to schedule the deployment to execute at a future time, click the arrow and select Schedule.

    Execution screen

For more detailed information, see Deploy an application.

Update a deployed application

To update a deployed application, you can do one of the following:

  • Locate the deployment or provisioning package under Applications, click Context menu, and select Deploy.
  • Locate and expand the environment under Environments, click Context menu next to the deployed application, and select Update deployment.

For more detailed information, see Update a deployed application.

Undeploy an application

To undeploy a deployed application, locate and expand the environment under Environments, click Context menu next to the deployed application, and select Undeploy.

For more detailed information, see Undeploy an application.

Roll back a deployment

To roll back a deployment or undeployment task, click Rollback. As with deployment, you can roll back immediately, review the plan before executing it, or schedule the rollback for a later time.

Schedule a task

To schedule an initial deployment, update deployment, undeployment, or rollback task, select Schedule on the task. Select the desired date and time and then click Schedule.

For more detailed information, see Schedule or reschedule a task.

Monitor active tasks

To monitor active tasks, click Explorer in the top bar and expand Monitoring. You can view active deployment tasks or active control tasks. Click Refresh to see the latest information about active tasks.

Deployment tasks in Monitoring

For more detailed information see Using the Monitoring view.

View a deployment report

To view a deployment report, select Reports in the top bar and then Deployments in the tab section below it.

Note: This feature requires the report#view permission.

Click Refresh to see the latest report information.

Deployment report

For more detailed information see Using XL Deploy reports

Manage roles and permissions

To establish and manage your access control scheme, click User management in the top bar.

Note: This feature requires the security#edit global permission.

For more detailed information, see roles and global permissions.

Manage roles

To manage roles, click User management in the top bar and then click Roles.

Manage roles

Assign global permissions

To assign global permissions to roles, click User management in the top bar and then click Global Permissions.

Assign global permissions

Assign local permissions

To assign to roles, click Explorer in the top bar, click Context menu on a root node or directory, and then select Edit permissions.

Assign local permissions