1. No category

CA LISA Release Automation
Plugin for TeamCity
Release1.0
This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to
as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without
the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed
by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing
your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and
CA.
Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may
print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your
employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced
copy.
The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable
license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility
to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF
ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY
LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION,
LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY
ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
The use of any software product referenced in the Documentation is governed by the applicable license agreement and such
license agreement is not modified in any way by the terms of this notice.
The manufacturer of this Documentation is CA.
Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions
set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as
applicable, or their successors.
Copyright © 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to
their respective companies.
Contact CA Technologies
Co n ta c t CA S u p p o rt
For your convenience, CA Technologies provides one site where you can access the
information that you need for your Home Office, Small Business, and Enterprise CA
Technologies products. At http://ca.com/support, you can access the following
resources:

Online and telephone contact information for technical assistance and customer
services

Information about user communities and forums

Product and documentation downloads

CA Support policies and guidelines

Other helpful resources appropriate for your product
Providing Feedback About Product Documentation
If you have comments or questions about CA Technologies product documentation, you
can send a message to [email protected].
To provide feedback about CA Technologies product documentation, complete our short
customer survey which is available on the CA Support website at http://ca.com/docs.
Contents
Chapter 1: About CA LISA Release Automation Plugin for
TeamCity
5
Overview........................................................................................................................................ 5
Workflow........................................................................................................................................ 5
Related Documentation .................................................................................................................... 7
Chapter 2: Install CA LISA Release Automation Plugin
9
To Install........................................................................................................................................ 9
To Uninstall .................................................................................................................................... 9
Chapter 3: Configure for Continuous Integration
11
About the Run LISA RA Template Step Definition................................................................................ 11
Create Build Step to Run LISA RA Template....................................................................................... 12
Chapter 4: Run and Monitor a Build Job
14
View TeamCity Build Log ................................................................................................................ 14
View LISA RA Deployment Process ................................................................................................... 14
Process Execution Pane ............................................................................................................. 15
View a Process Run .................................................................................................................. 15
View Process Details ................................................................................................................. 15
View Process Events ................................................................................................................. 16
Index
17
Contents 4
Chapter 1: About CA LISA Release
Automation Plugin for TeamCity
This section contains the following topics:
Overview (see page 5)
Workflow (see page 5)
Related Documentation (see page 7)
Overview
The CA LISA Release Automation Plugin allows TeamCity users to execute multiple
Release Operations Center templates before after a build step. The template can be
designed for any type of activity, such as, deployment, maintenance, notification.
Integrating CA LISA Release Automation with TeamCity CI enables agile deployment
and sanity checking with every build. Continuous deployments are realized allowing
development teams to easily deploy multiple times a day.
Workflow
With the CA LISA Release Automation Plugin for TeamCity, users can implement a CI
solution in the following steps:
1.
In Automation Studio:
a.
Create a generic process, or processes, to execute pre or post-build actions for
a new TeamCity build job.
b.
Publish the processes and assign an environment to each process.
For information about creating and publishing processes, see the Automation
Studio User Guide.
2.
In Release Operations Center:
a.
Create a deployment template to execute the new Automation Studio
processes.
b.
Assign servers, create parameters, define artifacts, and so on to complete the
template.
For information about creating templates, see the Release Operations Center User
Guide.
3.
In TeamCity:
Chapter 1: About CA LISA Release Automation Plugin for TeamCity 5
Workflow
6
Plugin for TeamCity
a.
Create a project as usual. Optionally, define parameters for Release Operations
Center values, such as application, and release name.
b.
Configure a TeamCity build job to run the matching Release Operations Center
template as a step before or after a regular build step. In the Runner type list,
select Run LISA RA Template.
c.
Complete the configuration for a LISA RA step. See Create Build Step to Run
LISA RA Template. (see page 12)
d.
Run the TeamCity job as usual.
e.
Monitor the progress of the build. See View TeamCity Build Log (see page 14).
f.
Monitor LISA RA step details. See View LISA RA Deployment Process (see page
14).
Related Documentation
Related Documentation
The CA LISA Release Automation documentation also includes the following:

Actions Reference Guide - CA LISA Release Automation installed action templates
and categories.

Applications Support Matrix for Actions - Supported applications for CA LISA
Release Automation actions.

Application Interface Guide - Using CA LISA Release Automation APIs for Command
Line Interface (CLI), REST and SOAP.

Custom Actions SDK - Implementing a custom actions library.

Introduction to CA LISA Release Automation - Getting started with CA LISA Release
Automation.

Installation and Administration Guide - Installing and administering CA LISA
Release Automation.

Release Notes - Details of new features, enhancements, resolved issues, and how
to upgrade to latest version of CA LISA Release Automation.

Security Description - Information on CA LISA Release Automation security and
certificates.

System Upgrade Guide - Upgrading to the latest version of CA LISA Release
Automation.

Automation Studio User Guide - Using Automation Studio to develop and execute
automated release processes.

Delivery Dashboard User Guide - Using Delivery Dashboard.

Release Operations Center | User Guide - Using Release Operations Center.

Automation Studio Plugin for Hudson/Jenkins Continuous Integration (CI) Server Installing and running the Automation Studio Plugin for Hudson/Jenkins CI servers.

Release Operations Center Plugin for Hudson/Jenkins Continuous Integration (CI)
Server - Installing and running the Release Operations Center Plugin for
Hudson/Jenkins CI servers.

Plugin for Microsoft Team Foundation Server (TFS) - Installing and running the CA
LISA Release Automation Plugin for Microsoft TFS.

Plugin for ServiceNow - Installing and running the CA LISA Release Automation
Plugin for Service Now.
®
Chapter 1: About CA LISA Release Automation Plugin for TeamCity 7
Chapter 2: Install CA LISA Release
Automation Plugin
Contact CA support for the latest version of the CA LISA Release Automation plugin for
TeamCity.
Upgrades to the plugin are handled the same as for installations.
This section contains the following topics:
To Install (see page 9)
To Uninstall (see page 9)
To Install
Fo llo w th e s e s te p s :
1.
Request the plugin zip file from CA support.
2.
Copy the zip file to the TeamCity JetBrains\plugins folder.
3.
Stop TeamCity service.
4.
Start TeamCity service.
The plugin is automatically installed.
To Uninstall
Fo llo w th e s e s te p s :
1.
Stop the TeamCity service.
2.
Delete the plugin.
3.
Restart the service.
Plugin is uninstalled.
Chapter 2: Install CA LISA Release Automation Plugin 9
Chapter 3: Configure for Continuous
Integration
The CA LISA Release Automation plugin provides the option to select running a CA LISA
Release Automation template when adding a TeamCity build step.
Note the following when planning to configure with a build step to run a LISA RA
template:

The Run LISA RA Template process can be run before or after a TeamCity build step.

Multiple Run LISA RA Template build steps can be configured in the TeamCity job.
This section contains the following topics:
About the Run LISA RA Template Step Definition (see page 11)
Create Build Step to Run LISA RA Template (see page 12)
About the Run LISA RA Template Step Definition
During build step creation, many of the input boxes have a parameters icon ( ) icon to
the right of the box. When you click the icon, a parameter list opens.
To locate a parameter in the list, use one of the following methods:
1.
Enter the percent sign (%) to open a parameter search.
2.
Select from the parameter list.
3.
Enter the name of the parameter directly to start autocomplete.
The mandatory data items are:

Host Name

Port

User Name

Password

Application Name

Template Name

Environment Name

Release Name

Release Type
In the definition of a Run LISA RA Template step you may use the TeamCity-generated
parameter build in the format: ${build}.
Chapter 3: Configure for Continuous Integration 11
Create Build Step to Run LISA RA Template
Create Build Step to Run LISA RA Template
Fo llo w th e s e s te p s :
1.
In TeamCity, select Administration.
2.
Select Create build configuration.
3.
Enter a name for the build configuration.
4.
Click VCS settings.
5.
Click Add build step. The New Build Step configuration section opens.
6.
In the Runner type list, select Run LISA RA Template.
Note: If Run LISA RA Template is not in the Runner type list, the Plugin
installation failed.
7.
In the Step Name box, enter a name for the step.
8.
In the Execution step list, select the step execution policy.
9.
Use the following guidelines when filling out the Run Nolio Template options
section:
–
12
Plugin for TeamCity
All boxes labeled with a red asterisk ( ) are required.
Create Build Step to Run LISA RA Template
–
For boxes with an additional information icon ( ), click the icon for ToolTip
information.
–
TeamCity-defined parameters are indicated by enclosing the parameter name
with percent signs (%), for example, %buildname%.
–
Select TeamCity-defined parameters from the parameter list option box. To
select a parameter:
–

Click the
icon at the end of the option box to open the parameter list, or

Enter a percent sign (%) in the option box to open an autocomplete combo
box.
A system-generated build number is available as the ${build} parameter.
10. In the Host Name box, enter the LISA Release Automation Center server name or
IP address.
11. In the Port box, enter the LISA Release Automation Center
8080. For SSL the default is 8443.
server port. Default is
12. Select the Use SSL check box to use SSL during connections to CA LISA Release
Automation.
13. In the User Name box, enter the CA LISA Release Automation authorized user
under whose name the template is to run. Verify that the user is authorized to run
the template in the defined application and environment.
14. In the Password box, enter the password for the User Name.
15. In the Application Name list, select the name of the application defined in the
template.
16. In the Template Name box, select the name of the template to run.
17. In the Environment Name box, select the name of the environment assigned to
the template.
18. In the Release Name box, enter a release name for the template execution.
Note: It is recommended that you include the TeamCity-generated parameter
${build} in the Release Name in order to create unique names.
19. In the Release Type box, enter the type of release: Minor, Major, or Emergency.
20. In the Version box, enter an optional release version.
21. To enter an optional description for the release, click Description (
opens. Enter a description.
). A box
22. If properties are defined for the template, in the Properties box, enter getter
property:value pairs to use during template execution in the format
"key1":"value","key2":"value2". Enclose the property and its associated value
separately in double quotation marks. Use a colon (:) to separate each
property:value pair. Use a comma (,) to separate multiple property:value pairs.
Each property name should be exactly as it appears in the Release Operations
Center GUI.
23. To validate template steps, select the Do Step Validation check box.
–
By default, all steps that execute processes not assigned to the release
environment are removed from the template automatically.
–
If the check box is cleared and one or more steps do not match the release
environment, the step fails.
Chapter 3: Configure for Continuous Integration 13
View TeamCity Build Log
Chapter 4: Run and Monitor a Build Job
Initiate and monitor the TeamCity project as usual.
This section contains the following topics:
View TeamCity Build Log (see page 14)
View LISA RA Deployment Process (see page 14)
View TeamCity Build Log
Fo llo w th e s e s te p s :
1.
In TeamCity, select the project.
2.
Click the Build Log tab
3.
Select Tree view. The project log lists the release created from the target template
and the initialization of parameters.
View LISA RA Deployment Process
In Automation Studio you can follow the progress of the deployment process using a
variety of UI options.
For information about viewing and controlling process jobs, see "Process Execution
Pane" in Automation Studio User Guide.
14
Plugin for TeamCity
View LISA RA Deployment Process
Process Execution Pane
In the Automation Studio UI, select the Environments panel and select the
deployment process which matches the CI build. The process execution pane appears.
View a Process Run
The Process View displays the execution of the process currently being run. It does so
using the same process diagram that was designed for a given environment in
Automation Studio.
However, the graphic depiction of the process is dynamic, thereby enabling you to
visually trace the run's progress.
View Process Details
The Detailed View displays the current status, overall progress, and current step
being executed both by server type, and each of the individual instances of each type,
involved in the process run.
Process run status
Displays
Instance
The name of the server type or the name of the server.
Status
Current status of the server.
Progress
Current progress.
Current Step
Current running action on this server.
Chapter 4: Run and Monitor a Build Job 15
View LISA RA Deployment Process
When a process starts, one of the standard preparation steps not contained in the
designed process is copying files from the central server to the target agents. The
progress of copying files to the agents is shown in the Detailed View tab with the
following information:

In the Status column, 'File Distribution' appears.

In the Progress column the percentage of the total files copied appears.

In the Current Step column, the number of bytes copied and the total number of
bytes to be copied appears.
View Process Events
The Events View displays a table of notifications related to the execution of a process.
Fo llo w th e s e s te p s :
Click the Events View tab to display the information shown in the following table.
Process status
Displays
Event
Any one or more of the event filters.
Source
Server name and IP.
Step
Name of the action.
Start
Start time.
End
End time.
Comments
Results or comments on the current event.
16
Plugin for TeamCity
Index
View Process Details • 15
View Process Events • 16
View TeamCity Build Log • 6, 14
A
About CA LISA Release Automation Plugin for
TeamCity • 5
W
Workflow • 5
About the Run LISA RA Template Step Definition •
11
C
Configure for Continuous Integration • 11
Contact CA Technologies • 3
Create Build Step to Run LISA RA Template • 6, 12
I
Install CA LISA Release Automation Plugin • 9
O
Overview • 5
P
Process Execution Pane • 15
R
Related Documentation • 7
Run and Monitor a Build Job • 14
T
To Install • 9
To Uninstall • 9
V
View a Process Run • 15
View LISA RA Deployment Process • 6, 14
Index 17