Unformatted text preview: OpenDeploy Administration
Release 16.3 TM OpenText TeamSite
OpenDeploy Administration Guide
Rev.: October 2017
This documentation has been created for software version 16.3.
It is also valid for subsequent software versions as long as no new document version is
shipped with the product or is published at .
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
For more information, visit
Copyright © 2017 Open Text. All Rights Reserved.
Trademarks owned by Open Text.
No Warranties and Limitation of Liability
Every effort has been made to ensure the accuracy of the features and techniques presented
in this publication. However, Open Text Corporation and its affiliates accept no responsibility
and offer no warranty whether expressed or implied, for the accuracy of this publication. Table of Contents
Chapter 1 Introduction to OpenDeploy 17 Conventions in the Administration Guide 17 Overview of OpenDeploy 17 The OpenDeploy Environment 18 Base Server 19 Receiver 19 Administration Server 19 Reporting Server 19 ContentServices Foundation Access Service 20 TeamSite 20 How OpenDeploy Works 20 Source-Target Relationship 20 Deployment Configurations 21 File Location Definitions 22 File Deployment Criteria 22 Comparison-Based Deployment Eligibility 22 File List-Based Deployment Criteria 23 Graphical User Interface 23 Deployment Types 24 Directory Comparison 25 File List 25 TeamSite Comparison 26 Payload Adapter-Based Deployment 27 Query-Based Adapters 27 Content Delivery Methods 28 Deployment to a Single Target 28 3 Deployment to Multiple Targets 28 Multitiered Deployments 28 Routed Deployments 29 Transactional Deployments 29 Specify a Target Quorum 30 Reverse Deployments 30 Access Rights and Privileges
Administrator Role 31 User Role 31 Chapter 2 Get Started
33 Start by Rebooting 34 Start from the Services Window 34 Start from the Command Line 34 UNIX 35 Start by Rebooting 35 Start from the Command Line 35 Start the User Interface
36 Stop from the Services Window 37 Stop from the Command Line 37 UNIX
Run Multiple Instances of OpenDeploy 38
38 Installation 39 Directory Structure 39 Services and Daemons 40 Instance Names 40 Properties File 40 Properties File Attributes 41 Manage OpenDeploy Instances 43 Create an Instance 4 31 44 Remove an Instance 44 Disable an Instance 45 Enable an Instance 45 Disable SNMP 45 Enable SNMP 45 Start and Stop an Instance 46 Configure Instances as Target Nodes 46 Use Database Auto-Synchronization 46 Run OpenDeploy as Non-Administrator or Non-Root 46 Run OpenDeploy on Windows as Non-Administrator 46 Run OpenDeploy on UNIX as Non-Root 47 Change Permissions to a Non-Root Ownership 47 Automatically Start OpenDeploy as a Non-Root User 48 Restrictions while Running as Non-Root 51 Refresh the OpenDeploy Server 51 OpenDeploy User Interface 52 Browser Refresh Requirements 53 Access the User Interface 53 Log In 54 Select the Host 54 First-Time Login as Bootstrap Administrator 55 Timeout Setting
OpenDeploy Server Management 55
56 Add an OpenDeploy Server 56 Change Server Information 57 Delete OpenDeploy Servers 58 Monitor Server Logs and Configurations 58 Server Management Window 59 View the Base Server and Receiver Log Files 61 Upload Modified Server Configuration Files 61 View Server Configuration Files 62 Refresh the OpenDeploy Server 63 Server Groups 64 5 Create a Server Group 64 View Server Groups 65 Edit a Server Group 66 Delete a Server Group 67 Manage Server Group Configuration Files 67 Edit Configuration Files for Server Groups 67 Upload Modified Configuration Files to the Server Group 68 Server Group Status Pane
Refresh the Server Group 70 Reconnect to a Restarted OpenDeploy Server 70 Determine the OpenDeploy Server Version 71 Display the OpenDeploy Server Status 71 Chapter 3 Server and Host Configuration 73 Access Service Management 73 Access Service Management with CSF 73 Access Service Management with TeamSite 74 Web Services Clients 75 Modify the Service Configuration File 75 Specify the TeamSite Release 76 Specify the Base Server and Receiver Configuration Files 76 Specify the Nodes Configuration File 76 Specify the Bootstrap Administrator User Name 76 Disable the Default Bootstrap Administrator Users 77 Specify the Access Service Key File Usage and Name 77 Disable Authorization Check for Deployments Invoked with iwodcmd start 78 Configure RMI Ports for Administration through a Firewall 78 Update Port Entries from a Previous Release 79 Specify the RMI Server Host Name or Binding IP Address 79 Restrict rmiPort Binding to a Single IP Address 80 Update Service Configuration File from a Previous Release 80 Configure the Bootstrap Administrator 6 69 81 Default Bootstrap Administrator Users 81 Disable the Default Bootstrap Administrator Users 81 Modify the Bootstrap Administrator User
Configure the Administration Server 82
82 Configure a Non-Default RMI Registry Port 82 ContentServices Foundation Access Service 83 Configure HTTPS for the CSF Access Service 83 Configure HTTPS Browser Access for OpenDeploy 84 Change the Keystore Password 85 New Installations 85 Existing Installations 86 Specify an Alternate TeamSite Mount Point 87 Enable Cross-Platform Administration 88 Define Target Nodes 89 Encoding 89 Physical Host Names 89 Logical Server Names 90 Specify Server Nodes 90 Multiple Instances 91 Hosts with Multiple IP Addresses 91 Case Insensitivity of Logical Names Allowed 92 Define Target Replication Farms
Set Up OpenDeploy in a Microsoft Cluster Environment 92
93 Prerequisites 93 License 93 Installation 93 OpenDeploy Server Setup 94 Configure OpenDeploy Web Service 95 Configure Event Reporting 95 Microsoft Cluster Setup 96 Deploy into a Microsoft Cluster 98 Deploy Content from a Microsoft Cluster 98 Administration Package Configuration 99 Add the Administration Server to the Microsoft Cluster 99 Configure the CSF Access Service for the OpenDeploy Administration Server 99 7 Configure Event Reporting in the Microsoft Cluster
Access the OpenDeploy Administration Server in a Microsoft Cluster 100 CSF Access Service Package Configuration 100 Configure the iwodcmd Command-Line Tool 101 Service Configuration File Settings 101 Specify Alternate Ports and Hosts 101 Migration Help 102 Deploy through a Firewall 102 Configuration Requirements 102 Host Matching 103 Back Up OpenDeploy Files 103 Base Server and Receiver 104 Administration/Report Server 105 Recovery Procedure 106 Internationalization 106 Service Configuration File Format 106 Encoding for XML-Based Configuration Files 106 Configure File Descriptor Limits on Solaris 107 SNMP 107 Start and Stop SNMP 107 Configure SNMP for OpenDeploy Instances 107 Enable and Disable SNMP 108 Instance Creation 108 Existing Instances 108 SNMP Agent Configuration 108 SNMP Agent Properties 108 Set Up SNMP Polling 110 Logs 110 Security 110 Disable Alert Notifications 111 Object IDs 112 Management Information Base Support 113 Configure DAS for TeamSite 8 99 113 Auto-registration for OpenDeploy Receiver to Base Servers 114 Chapter 4 Base Server and Receiver Configuration Files 119 Overview of Server Configuration Files 119 Encoding 120 Identify the Host 121 Specify the Communication Port 121 Host Checks During Deployments 122 Specify Alternate Locations for Temporary Deployment Files 122 Enable Concurrency Management 123 Clear the Registry of Target Path Entries 124 Allow Traversal of Target Links in File List Deployments 125 Set the File Transport Buffer Size 125 Restrict Access to Users with OpenDeploy Roles 126 Invoke from a TeamSite Workflow External Task 126 Enable Authentication when iwodcmd Commands Run 127 Use Strict Authorization in ControlHub 127 Authorization when Running Deployments 127 Authorization when Running Select and Deploy 127 Enable Deploy and Run on the Target Side 127 Specify the Deployment Information Stream Format 128 Limit the Size of the Scheduler Script File 128 Specify Allowed Hosts for Received Deployments 129 Check for Allowed Hosts 130 Manage IP Address Checks 130 Reverse Deployments 130 Host Checks 130 Specify Allowed Directories for Deployments 130 Logs 131 logRules Element Attributes 132 Default Log Settings 133 Reports 133 Encryption 134 Specify the Completed Deployments List 134 9 Completed Deployments Sent 134 Completed Deployment Received 135 Web Services
HTTP Transport 136 HTTPS Transport 136 Configure Both HTTP and HTTPS on Hosts with Multiple IP Addresses 136 Transport Connection Parameters 137 Configure for HTTPS 138 Manage the Keystore File 138 Create a New Certificate 139 Export an Existing Certificate 139 Add an Existing Certificate 139 Display the List of Certificates 140 Database Deployments
Determine the Runmode 141
143 Performance Throttle 143 Base Server Only Features 145 Set the Number of Connection Retries 145 Define the Scheduler Database 145 URL Choices 146 In-Memory Database URL 146 Standalone URL 146 Use Third-Party JDBC Drivers with the OpenDeploy Scheduler
Deployment Queues 10 135 147
148 Example 149 Limitations 149 Validate Deployment Configuration Syntax 149 Serialize Transactional Deployments 150 Time-Based Serialization 151 Serialize Randomly 151 Specify Allowed Deploy and Run Scripts 152 Specify Payload Adapters 152 Hot Folder 153 Chapter 5 Deployment Configuration
Compose Deployments 155
155 Use a Text or XML Editor 155 Use the Deployment Configuration Composer 156 View Deployment Configuration Source Code 156 Upload Deployment Configurations 158 Organize Deployment Configurations 159 Create Deployment Groups 159 View Deployment Groups 160 Directory Permissions for Deployment Groups–UNIX only 161 Assign Access Controls 161 Run a Deployment from the User Interface 161 Deployment Started Dialog Box 162 Deployment Instance Names 163 Perform a Test Deployment 164 Perform a Simulated Deployment 164 Check File Integrity on Production Servers 165 Cancel Deployments in Progress 165 Cancel Deployments in the User Interface 165 Monitor Deployments 166 Source Deployments Window 167 Completed Sent Deployments Limit
Target Deployments Window 169
169 Completed Received Deployments Limit 170 Deployment Logs 170 Run Deployments from the Command Line 170 Authorization Checks 171 Start a Deployment 171 Perform a Simulated Deployment 172 Specify a Deployment Instance 172 Use with Parameter Substitution 173 Use with Schedules 173 Run Deployments Asynchronously 173 11 Cancel a Deployment in Progress
Roles and Authorization 174 Administrator Role 174 User Role 175 Server Access 175 Deployment and Deployment Groups Access 176 Authorize Deployment Access from the User Interface 176 Authorize Deployment Access from the Command Line 178 Add a Deployment Authorization 180 Remove a Deployment Authorization 181 Reset All Deployment Authorizations 181 Role Access in TeamSite Workflows 181 Chapter 6 Scheduled Deployments 183 Introduction to Scheduled Deployments 183 Schedule from the User Interface 183 Create a Scheduled Deployment
Resolve Time Zone Differences 183
186 View Schedules 186 View Scheduled Deployment Information 186 Edit Scheduled Deployments 187 Activate and Deactivate Scheduled Deployments 188 Delete Scheduled Deployments 188 Schedule from the Command Line
Add a Schedule 12 173 189
189 One-Time Only Deployments 190 Recurrent Deployments 190 Recurrent Deployments with End Dates 191 Use of Comments 191 Apply Parameter Substitution to Scheduled Deployments 191 Schedule Deployment Instances 192 View Scheduled Deployment Information 192 Delete a Schedule 193 Activate and Deactivate a Schedule 194 Reactivate Schedules During or Past Their Effective Periods 196 Chapter 7 Logs 197 Logs Overview 197 Log File Location 198 Log File Permissions 198 View Log Information 198 View Log Files from a Text Editor 198 View Log Files from the OpenDeploy User Interface 198 OpenDeploy Log Viewer Window Contents 199 Base Server Logs 200 Receiver Logs 202 Macro Deployment Logs 202 Source Macro Deployment Log 203 Receiver Macro Deployment Log 204 Micro Deployment Logs 205 Source Micro Deployment Log 205 Receiver Micro Deployment Log 207 Administration Server Logs 208 Reporting Logs 208 Adapter Logs 208 Log Levels 209 Define Log Levels in the User Interface 210 Define Log Levels from the Command Line 210 Configure Log Settings
Base Server and Receiver Configurations 210
210 Log Rotation based on Size 211 Log Rotation based on Time 211 Deployment Configurations 212 Log Rules Hierarchy 213 Log File Size Management 214 Rollover Threshold Size Determination 214 Rolled Over Log File Names 214 Maximum Archives Allowed 215 13 Log File Management for Adapters
Log File Recovery 215 Chapter 8 Security 217 Sender Node Authentication 217 Encryption 217 Symmetric Key Encryption 218 Configure OpenDeploy for Symmetric Encryption 218 Use Symmetric Encryption with Reverse Deployments 219 Secure Data Transfer with SSL 14 215 219 Obtain Additional SSL Information 220 Set up SSL Private Keys and Certificates 220 Set up the Certificate Authority 221 Certificate Authority Expiration 223 Generate a Certificate 223 Certificate Expiration 224 Support for Third-Party Certificate Authority 224 Change OpenSSL Defaults 226 SSL Configuration and Deployment Errors 226 Verify Certificates 227 Use Multiple Certificates 227 Configure OpenDeploy for SSL Data Transfer Encryption 228 Ciphers 229 Test the SSL Encryption Configuration 230 Logs 231 Non-Root Operation 232 Support for Multiple Instances of OpenDeploy 232 Deploy and Run 232 Command-Line Tools 232 Bootstrap Administrator 233 Administration Setup 233 strictAuthentication 233 allowedEventReportingHost 233 Decode Requests to OpenDeploy Server Treated as Decryption 234 Secure RMI 234 OpenDeploy Server Configurations for Secure RMI 234 Additional OpenDeploy Instance Configuration for Secure RMI 236 OpenDeploy Client Configurations and Enhancements for Secure RMI 236 Configuration 236 Implementation 237 Backward Compatibility 237 Chapter 9 Reports 239 Reports Overview 239 Server Configuration 240 Server Configuration File 240 Enable Reports 240 Path to Server Reporting Configuration File 240 Logs
Administration Server Configuration for Reports 241
241 Add Servers to the Report Environment 241 Connection Management 242 Add OpenDeploy Servers to Reports 242 Logs 244 Subprocess Commands 244 Environmental Variables 245 Report Server Database 246 Use Your Own Database 246 Reset the Database 249 Reset the Hypersonic Database 249 Reset the Hypersonic Database When Using ControlHub 250 Logs 251 Use a Third-Party Database for a Store-and-Forward System
Custom Reports 251
253 Configure Custom Report Queries 253 Export Custom Report Queries 254 Generate Custom Reports 255 Preconfigured Reports 255 15 Deployment Report Structure 255 Deployment Leg Report 256 Manifest Report 257 Download Custom Reports 258 Save Custom Reports as Quick Reports 259 DAS Custom Reports 259 SQL Query Reports 261 Access to Report Server Database Tables 262 Case Sensitivity 262 Create SQL Queries 262 Generate SQL Query Reports 263 Download an SQL Query Report 263 Save an SQL Query Report as a Quick Report 263 Quick Reports
Add New Entries to Quick Report List 264 Edit Existing Entries 264 Delete Quick Reports 265 Manage Report Data 265 Report Database Size Guidelines 266 Capture Error Messages into an MIB File 266 Chapter 10 Troubleshoot Administration Issues 16 263 269 Failure during Database Migration with the Default Hypersonic Reporting
Database 269 Error 12505 Occurs while Deploying to the Clustered Database with DataDeploy 270 Synchronize User Locales on Windows 270 Cannot Share servletd with TeamSite HA 271 Non-Root Users Cannot Run the slibclean Command on AIX 271 Error During Schema Creation on Scheduler DB with MySQL 271 Chapter 1 Introduction to OpenDeploy Chapter 1
Introduction to OpenDeploy
l This section provides an introduction to the OpenDeploy software components, and
explains how OpenDeploy works. l Conventions in the Administration Guide l Overview of OpenDeploy l The OpenDeploy Environment l How OpenDeploy Works l Deployment Types l Content Delivery Methods l Access Rights and Privileges Conventions in the Administration Guide
This guide uses Windows to indicate any supported version of the Microsoft Windows
operating system, such as Windows NT® .
This guide uses UNIX to indicate any supported UNIX® operating system.
Windows users should be familiar with either IIS or Netscape® Web servers, and with basic
Windows server operations such as adding users and modifying access control lists (ACLs).
UNIX users should be familiar with basic commands and be able to use a text editor such as
emacs or vi.
It is also helpful to be familiar with regular expression syntax.
Note: The Supported environments and compatibility section in the TeamSite Release
Notes supersedes all other references to specifically supported software versions found in
this document. Overview of OpenDeploy
OpenDeploy is a content distribution product for deploying static and dynamic enterprise
content, including Web sites, code, and documents, to a multitier, multiple server
environment. OpenDeploy runs on a variety of common servers, and is well suited for a
cross-platform enterprise. OpenDeploy Administration Guide 17 Chapter 1 Introduction to OpenDeploy l l l
l l OpenDeploy provides a secure, flexible, and scalable solution for the cross-platform,
transactional transfer of content to multiple servers. An open architecture enables
OpenDeploy to distribute content managed in any repository or file system. No special
tagging of content is required. OpenDeploy empowers users to:
Mobilize IT operations staff with a browser-based user interface for remotely controlling
and monitoring distribution activities.
Segment enterprise initiatives and responsibilities with finely grained user rights.
Securely automate content distribution to multiple tiers of servers inside and outside
Ensure data integrity and synchronization via transactional distribution to multiple
server farms. l Deliver content to the right place at the right time using a built-in scheduler. l Quickly determine results through comprehensive reporting services. l Seamlessly integrate content distribution with business applications and tasks. l l Extend content delivery to any device or protocol, thereby implementing a consistent,
end-to-end distribution solution.
Expand IT infrastructure without costly custom scripting. The OpenDeploy software family includes the optional DataDeploy module that enables
secure delivery and synchronization of database content. A unified distribution architecture
seamlessly combines the advantages of secure, reliable file asset distribution with delivery
of structured content to databases that drive Web-based applications. The OpenDeploy Environment
OpenDeploy consists of a suite of interlocking services that create the OpenDeploy
environment. The OpenDeploy environment contains the following components.
l l l l l 18 Base server software enables the OpenDeploy server to start deployments to other
servers, as well as to receive files deployed from other OpenDeploy servers. You can
run additional instances of the base server from single base server software installation.
Receiver software enables the OpenDeploy server only to receive deployed files. You
can run additional instances of the receiver from a single receiver software installation.
Administration package manages the following OpenDeploy functions:
n generation of the browser-based user interface n reporting through the reporting server n access to OpenDeploy servers, features, and functions, based on user and
administrator roles DataDeploy module (optional) adds secure delivery and synchronization of database
Archival module (optional) allows the writing of deployed files to storage devices,
such as ...
View Full Document