Contents
Collapse All
Expand All
Introduction
Welcome to Deployment Automation
About This Documentation
Deployment Automation Overview
User Interface Overview
Examples and the Community
Terminology
A Typical Sequence
Installation
Architecture Overview
Clients
Data Tier
Service Tier
Agent Architecture
Agent Communication
Agent Relay Communication
Services
Installing Servers and Agents
Installation Checklist
Installation Considerations for Optimal Performance
System Requirements
Server Minimum Requirements
Server Recommended Configuration
Agent Minimum Requirements
Agent Relay Minimum Requirements
Preparing Your Database
Server Installation
Running the Interactive Installer
Manual Server Installation
Silent Mode Server Installation
(Windows) Server Silent Installation
(Windows) Server Silent Installation Options
(Windows) Server Silent Installation: OptionsFile.txt Examples
(UNIX/Linux) Server Silent Installation
(UNIX/Linux) Server Silent Installation Options
(UNIX/Linux) Server Silent Installation: optionsFile.txt Examples
Uninstalling Servers
Reconfiguring Server Installation Settings
Agent Relay Installation
Interactive Agent Relay Installation
Agent Relay Installation Options
Silent Mode Agent Relay Installation
(Windows) Agent Relay Silent Installation
(Windows) Agent Relay Silent Install Options
(Windows) Agent Relay Silent Install Options Example
(UNIX/Linux) Agent Relay Silent Installation
(UNIX/Linux) Agent Relay Silent Install Options
(UNIX/Linux) Agent Relay Silent Install Options Example
Upgrading Agent Relays
Server and Agent Communication Configuration
Agent-initiated HTTP Communication Using Agent Relays
Server-initiated HTTP Communication Using Agent Relays
Agent Installation
Interactive Agent Installation
Agent Installation Options
Silent Mode Agent Installation
(Windows) Agent Silent Installation
(Windows) Agent Silent Installation Options
(Windows) Agent Silent Installation Options Example
(UNIX/Linux) Agent Silent Installation
(UNIX/Linux) Agent Silent Installation Options
(UNIX/Linux) Agent Silent Installation Options Examples
Uninstalling Agents
About Agent Upgrades
Installing for a High Availability Implementation
Installing the First Server
Installing Additional Servers
High Availability Configurations
Configuring Agents for High Availability (Recommended)
Configuring Agents for High Availability (Alternate)
Disaster Recovery with Hot Standby
Disaster Recovery with Cold Standby
Running Deployment Automation
Starting and Stopping the Server
Starting and Stopping an Agent Relay
Starting and Stopping an Agent
Permission for Users Running Agents
Accessing Deployment Automation
Administration
Administration Overview
Automation Administration
Managing Plugins
Loading Plugins
Upgrading Plugins
Managing External Source Configuration Types
Locks
Managing Locks
Post-Processing Scripts
Defining Statuses
Using Inventory Statuses
Using Version Statuses
Using Snapshot Statuses
Security Administration
Setting up Security
Role Configuration
Default Role Types
Creating and Editing Roles
Server Roles and System Security
Web UI Roles and UI Security
Authorization Realms and Groups
Creating an Internal Storage Authorization Realm
Creating an LDAP Authorization Realm
Limiting LDAP to a Set of Groups
Creating Groups
Authentication Realms and Users
Creating Authentication Realms
Creating Users
Creating LDAP Authentication Realms
LDAP Authentication Configuration
LDAP User Permissions
Importing LDAP Users
Limiting LDAP Users by Group
Creating PKI Certificate Authentication Realms
PKI Certificate Parsing
PKI Certificate Authentication Configuration
Configuring the Server to Support PKI Certificates
Importing CA Certificates
Configuring Internal Revocation Verification
Configuring Polling for Certificate Revocation Lists
Configuring PKI Certification for Agents
Default Permissions
Setting Default Permissions
Adding Users to Groups
Setting Role Membership by Product Area
Tokens
Viewing Online Users
Security Report Overview
Application Security Report
Application Security Fields
Component Security Report
Component Security Fields
Environment Security Report
Environment Security Fields
Resource Security Report
Resource Security Fields
System Administration
Licenses
Adding a License
Adding Agents to a License
Modifying or Deleting a License
Configuring Email Notifications
Configuring Notification Schemes
Creating Notification Templates
Properties for Notification Templates
Examples of Keys in the Properties Map
Basic Velocity Examples
Output Log
Adding System Properties
System Settings
ALF Events
Replication
Exporting Replication Data
Importing Replication Data
Replication Export Details
Replication Import Details
Replication Merge Strategies
Agent Connectivity Status Checks
Configuring the Server-Initiated Agent Status Check
Configuring the Agent-Initiated Agent Status Check
Configuring the User-Initiated Agent Status Check
Secure Socket Layer (SSL) Configuration
Configuring Unauthenticated Mode for HTTP Communication
Configuring Mutual Authentication Mode
Property Settings for Mutual Authentication
Adding an Alias to an Agent
Adding an Alias to an Agent Relay
Mutual Authentication: Server and Agents
Mutual Authentication: Server, Agent Relay, and Agents
Configuring Server Settings
Configuring Component Version Import
Configuring the Auto-select for Export Option
Configuring the Default for Only Changed Versions Option
Configuring Agent Connectivity Settings
Artifact Repository
Artifact Repository Overview
Relocating the Repository
Managing Execution History
Pre-Cleanup
Rules of Execution History Cleanup
Running Execution History Cleanup
Execution History Cleanup Audit
Post-Cleanup
Data Collection and Check for Update
Data Collected
Data Collection FAQ
Upgrade Eligibility Information Collected
Suggestions for Upgrade
Checking for Updates Manually
Troubleshooting
Conflict with WebDAV in IIS
Installation Failure Due to Interruption
Import Failure or Issues After Import
SSO Login Failure After a Tomcat Upgrade
Process Failures or False Successes
Navigation Tips
Management
Management Overview
Managing Components
Components Page Overview
Creating Components
Source Configuration Type Fields
File System (Basic)
File System (Versioned)
AnthillPro
Artifactory
Dimensions
Git
Jenkins
Maven
PVCS
Subversion
TeamCity
TFS
TFS vNext
TFS_SCM
TeamForge
Component Properties
Adding Component Properties
Adding Component Environment Properties
Adding Component Version Properties
Importing/Exporting Components
Exporting Components
Importing Components
Component Versions
Importing Component Versions
Importing Versions Automatically
Importing Versions Manually
Maintaining Versions Externally
Viewing the Version Import Queue
Adding Statuses to Component Versions
Setting Component Version Property Values
Deleting Component Versions
Inactivating Component Versions
Component Version Cleanup
Downloading Version Artifacts
Component History
Component Processes
Creating Component Processes
Component Process Details
Designing Component Processes
Adding Process Steps
Connecting Process Steps
Component Process Step Details
Plugins
Component Process Utility Steps
Using Expression Language in Processes
Using Conditions and Switch Steps in Processes
User Impersonation
User Impersonation on UNIX/Linux
Impersonation on Windows Systems
Adding Component Process Properties
Plugin Post Processes
Running Component Processes
Component Tasks
Creating Component Tasks
Creating Component Templates
Importing/Exporting Component Templates
Exporting Component Templates
Importing Component Templates
Adding Component Template Properties
Using Component Templates
Configuration Templates
Creating Configuration Templates
Deleting and Deactivating Components
Managing Applications
Applications Page Overview
Creating Applications
Application Configuration
Adding Components to Applications
Adding Application Properties
Copying Applications
Importing/Exporting Applications
Exporting Applications
Importing Applications
Application Environments
Adding Environments to Applications
Adding Application Environment Properties
Mapping Application Components to Resources
Setting Component Environment Property Values
Comparing Environments
Application Processes
Creating Application Processes
Designing Application Processes
Application Process Step Details
Finish
Install Component
Uninstall Component
Rollback Component
Run Process for Each Version
Apply Configuration
Application Process Snapshot Steps
Create Snapshot Step
Update Snapshot Step
Add Status to Snapshot Step
Remove Status from Snapshot Step
Application Process Utility Steps
Adding Application Process Properties
Running Application Processes
Application Tasks
Creating Application Tasks
Approvals
Designing Approval Processes
Approving Requests
Snapshots
Creating Snapshots
Viewing Snapshot Environments
Configuring Snapshots
Adding Component Versions to Snapshots
Adding Statuses to Snapshots
Viewing Snapshot Tasks
Comparing Snapshots
Gates
Creating Gates
Managing Environments
Environments Page Overview
Creating Environments
Configuring and Monitoring Environments
Mapping Agents and other Resources to Environments
Adding Environment Properties
Importing/Exporting Environments
Exporting Environments
Importing Environments
Managing Pipelines
Pipelines Page Overview
Creating Pipelines
Configuring Pipelines
Adding Pipelines to Applications
Importing/Exporting Pipelines
Exporting Pipelines
Importing Pipelines
Managing Resources
Resources Page Overview
Resources
Creating Resources
Resource Configuration
Agents
Managing Agents and Agent Pools
Assigning Notification Schemes to Agents
Installing Agents Remotely
Managing Agents Remotely
Upgrading Agents
Dynamically Registering Agents
Agent Pools
Creating Agent Pools
Adding Agents to Agent Pools
Updating Agent Pools
Agent Relays
Managing Agent Relays
Configuring Agent Relays
Detecting Agent Relays
Managing Network Relays
Resource Groups
Creating Resource Groups
Adding Resource Properties
Resource Roles
Creating Resource Roles
Adding Resource Roles to Resources
Adding Resource Role Properties
Managing Deployment Packages
Creating Deployment Packages
Deployment Package Configuration
Deployment Package Processes
Designing Deployment Package Processes
Deployment Package Process Utility Steps
Adding Deployment Package Properties
Running Deployment Package Processes
Deployment Package Inventory
Deployment Package Tasks
Creating Deployment Package Tasks
Managing Global Processes
Creating Global Processes
Designing Global Processes
Global Process Utility Steps
Adding Global Process Properties
Importing/Exporting Global Processes
Exporting Global Processes
Importing Global Processes
Running Global Processes
Properties
Built-in Properties
User-Defined Properties
All Properties Pairs
How Properties Are Resolved
Property Picker
Configuring Within the Application Hierarchy
Deployment
Deployment Overview
Ways of Deploying
Scheduling Deployments
Setting Deployment Blackout Dates
Analyzing Deployments
Viewing Timelines
Viewing Application Deployments
Viewing Deployment History
Viewing an Application Process Request
Viewing a Component Process Request
Deployment Results in E-mail Notifications
Inventory Management
Viewing the Environment Inventory
Advanced Inventory Management
Deployment Report Overview
Deployment Average Duration Report
Deployment Average Duration Fields
Running the Deployment Average Duration Report
Sample Reports: Deployment Average Duration
Deployment Total Duration Report
Deployment Total Duration Fields
Running the Deployment Total Duration Report
Sample Reports: Deployment Total Duration
Deployment Count Report
Deployment Count fields
Running the Deployment Count Report
Report Samples: Deployment Count
Deployment Detail Report
Deployment Detail Fields
Running the Deployment Detail Report
Report Samples: Deployment Detail
Saving and Printing Reports
Saving Report Data
Saving Report Filters
Printing Reports
Walk-through
helloWorld Deployment
Before You Begin
Step 1: Creating a Component
Step 2: Creating a Component Process
Step 3: Designing the Component Process
Step 4: Creating an Environment
Step 5: Mapping an Agent to an Environment
Step 6: Creating an Application
Step 7: Adding the Component to the Application
Step 8: Adding the Environment to the Application
Step 9: Mapping Components to the Environment Resource
Step 10: Adding a Process to the Application
Step 11: Designing the Application Process
Step 12: Running the Application Deployment
Integration
Integrating with SBM
Configuring the REST Grid Widgets
Methods Supporting Composer Mode
Single Sign-On (SSO) Configuration
Configuring Common Tomcat for SSO
Creating an SSO Authentication Realm
Sign On Using SSO
Single Sign Out
Integrating with Dimensions CM
Dimensions CM Integration Example
Dimensions CM Integration Runtime Communication
Dimensions CM Plugin Installation
Configuring Dimensions CM Processes in Deployment Automation
Importing the Dimensions CM Sample Environment
Importing the Sample Dimensions CM Application
Configuring the Dimensions CM Application
Configuring Dimensions CM Component Processes
Integrating with ChangeMan ZMF
ChangeMan ZMF Integration Example
ChangeMan ZMF Integration Runtime Communication
Configuring ALM Connector on the Mainframe
Configuring a ChangeMan ZMF Proxy User ID
Configuring TSO User IDs and Permissions
Configuration in ChangeMan ZMF
Adding Required Startup Parameters
Example ChangeMan ZMF Startup Parameters
Configuring Change Packages in ChangeMan ZMF
Installing the ALM Connector Services
Configuring the Integration Files
Loading the ChangeMan ZMF Plugin
Configuring ChangeMan ZMF Processes in Deployment Automation
Integrating with Nolio
Nolio Integration Example
Nolio Integration Runtime Communication
Nolio Plugin Installation
Configuring Nolio Processes in Deployment Automation
Importing the Sample Nolio Environment
Importing the Sample Nolio Application
Configuring the Nolio Application
Configuring Nolio Component Processes
Creating Custom Plugins
Plugin Creation Overview
The plugin.xml File
The Header: <header> Element
The Plugin Steps: <step-type> Element
Step Properties: <properties> Element
Step Commands: <command> Element
Step Post-Processing: <post-processing> Element
The upgrade.xml file
The info.xml File
Integrating with Source Configuration Tools
Creating Custom Source Configuration Types
Getting Started with Custom Source Configuration Types
The CommonIntegrator Lifecycle
An Implementation of the CommonIntegrator Interface
Using the Annotations for Defining UI Properties
Methods to Use During Version Import
getNextVersionInfo Method
downloadVersionContent Method
Using ComponentInfo to Process Version Information
Using the CommonIntegrator getAlerts Method to Validate Field Values
Logging Messages to the Console
Compiling and Loading Custom Source Configuration Types
Using Custom Source Configuration Types
Command Line Interface Reference
Command Line Client (CLI)
Installing the Command Line Client
Command Format
Running Commands
Commands
addActionToRoleForApplications
addActionToRoleForComponents
addActionToRoleForEnvironments
addActionToRoleForResources
addActionToRoleForUI
addComponentToApplication
addGroupToRoleForApplication
addGroupToRoleForComponent
addGroupToRoleForEnvironment
addGroupToRoleForResource
addGroupToRoleForResourceGroup
addGroupToRoleForUI
addLicense
addNameConditionToGroup
addPropertyConditionToGroup
addResourceToGroup
addRoleToResource
addRoleToResourceWithProperties
addUserToGroup
addUserToRoleForApplication
addUserToRoleForComponent
addUserToRoleForEnvironment
addUserToRoleForResource
addUserToRoleForResourceGroup
addUserToRoleForUI
addVersionFiles
addVersionStatus
createAgentPool
createApplication
createApplicationProcess
createComponent
createComponentProcess
createDynamicResourceGroup
createEnvironment
createGroup
createMapping
createResource
createResourceGroup
createRoleForApplications
createRoleForComponents
createRoleForEnvironments
createRoleForResources
createRoleForUI
createUser
createVersion
deleteAgent
deleteAgentPool
deleteAgentProperty
deleteGroup
deleteResource
deleteResourceGroup
deleteResourceProperty
deleteUser
exportGroup
getAgent
getAgentPool
getAgentPools
getAgentProperty
getAgents
getApplication
getApplicationProcess
getApplicationProcessRequestStatus
getApplicationProperties
getApplicationProperty
getApplications
getComponent
getComponentEnvironmentProperties
getComponentEnvironmentProperty
getComponentProcess
getComponentProperties
getComponentProperty
getComponents
getComponentsInApplication
getEnvironment
getEnvironmentProperties
getEnvironmentProperty
getEnvironmentsInApplication
getGroupsForResource
getMapping
getResource
getResourceGroup
getResourceGroups
getResourceProperties
getResourceProperty
getResources
getResourceSecurity
getResourcesInGroup
getResourcesWithComponentVersion
getRoleForApplications
getRoleForComponents
getRoleForEnvironments
getRoleForResources
getRoleForUI
getRolesForResource
getSystemProperties
getSystemProperty
getUser
importGroup
importVersions
login
logout
removeActionFromRoleForApplications
removeActionFromRoleForComponents
removeActionFromRoleForEnvironments
removeActionFromRoleForResources
removeActionFromRoleForUI
removeAgentFromPool
removeGroupFromRoleForApplication
removeGroupFromRoleForComponent
removeGroupFromRoleForEnvironment
removeGroupFromRoleForResource
removeGroupFromRoleForUI
removeMapping
removeResourceFromGroup
removeRoleForApplications
removeRoleForComponents
removeRoleForEnvironments
removeRoleForResources
removeRoleForUI
removeRoleFromResource
removeUserFromGroup
removeUserFromRoleForApplication
removeUserFromRoleForComponent
removeUserFromRoleForEnvironment
removeUserFromRoleForResource
removeUserFromRoleForUI
removeVersionStatus
repeatApplicationProcessRequest
requestApplicationProcess
restartAgent
setAgentProperty
setApplicationProperty
setComponentEnvironmentProperty
setComponentProperty
setEnvironmentProperty
setResourceProperty
setSystemProperty
shutdownAgent
testAgent
updateUser
upgradeAgent
Glossary