OpenDeploy Installation Guide

OpenDeploy
Installation Guide
Release 6.2
1999-2007 Interwoven, Inc. All rights reserved. No part of this publication (hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Interwoven. Information in this manual is furnished under license by Interwoven, Inc. and may only be used in accordance with the terms of the license agreement. If this software or documentation directs you to copy materials, you must first have permission from the copyright owner of the materials to avoid violating the law which could result in damages or other remedies. Interwoven, ConfirmSite, ContentServices, ControlHub, DataDeploy, DeskSite, FileSite, iManage, LiveSite, MediaBin, MetaCode, MetaTagger, OffSite, OpenDeploy, Primera, Scrittura, TeamPortal, TeamSite, VisualAnnotate, WorkDocs, WorkPortal, WorkRoute, WorkSite, WorkTeam, the respective taglines, logos and service marks are trademarks of Interwoven, Inc., which may be registered in certain jurisdictions. All other trademarks are owned by their respective owners. Some or all of the information contained herein may be protected by patent numbers: US # 6,505,212, GBRI # 1053523, US # 6,480,944, US# 5,845,270, US #5,430,812, US #5,754,704, US #5,347,600, AUS #735365, AU 7830068, GB #GB2333619, US #5,845,067, US #6,675,299, US #5,835,037, AUS #632333, CAN #2,062,965, FRAN / GRBI / SPAI / SWED #480941, GERM #69020564.3, KORS 10-0576487, JAPA #2968582, MX #219522, NZ #516340, SING #109524, SG #89006, SG #89086, SG #74973, SG #85502 US #5,065,447, US #6,609,184, US #6,141,017, US #5,990,950, US #5,821,999, US #5,805,217, US #5,838,832, US #5,867,221, US #5,923,376, US #6,434,273, US #5,867,603, US #4,941,193, US #5,822,721, US #5,923,785, US #5,982,938, US #5,790,131, US #5,721,543, US #5,982,441, US #5,857,036, US #6,697,532, US #6,792, 454, US #6,928,149, US #7,092,969 or other patents pending application for Interwoven, Inc.
Interwoven, Inc. 160 East Tasman Drive San Jose, CA 95134 http://www.interwoven.com OpenDeploy Installation Guide Part 03-003-02-EN November 2007
Table of Contents
List of Figures About This Book 5 7
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Chapter 1:
Preparation
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 OpenDeploy Software Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Base and Receiver Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Administration Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Reporting Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 ContentServices Foundation Access Service Software . . . . . . . . . . . . . . . . . . . .12 Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Base Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14 Administration Package Placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Administration and Reporting Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 ContentServices Foundation Access Service . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 RMI Registry Service Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Enabling DOS-Compatible 8.3 Format File Names for Windows . . . . . . . . . . . .16
Chapter 2:
Installation
19
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Installing the Base Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 Installing the Receiver Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 Installing the Administration Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 Installing the ContentServices Access Service. . . . . . . . . . . . . . . . . . . . . . . . . . .24 Configuring the Bootstrap Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing the Base Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing the Receiver Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 Installing the Administration Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 Installing the ContentServices Foundation Access Service . . . . . . . . . . . . . . . . .28 Configuring the Bootstrap Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 Platform-Specific Installation Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 Upgrading OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30 Upgrading From a Previous Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30 Administration Package Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Operations Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 Updating OpenDeploy Home Value in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . .33 Installing Multiple Releases of OpenDeploy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Installation Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 Configuring OpenDeploy Home Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 Uninstalling OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
OpenDeploy Installation Guide
Contents
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36 UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Chapter 3:
Licensing
39
Licensing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Base Server Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Receiver Licensing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Administration Package LIcensing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Add-On Module Licensing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Licensing Hosts with Multiple Host Names and Interfaces . . . . . . . . . . . . . . . . .41 Licensing Cluster Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Licensing OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Single License Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 Batch Server Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Remote Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Suggested Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Upgrade Installation File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Specifying Shortened Upgrade File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Distributing the Target Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Collecting License Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Distributing Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Upgrading from OpenDeploy 5.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Performing Remote Upgrades on UNIX Target Hosts as a Non-Root User . . . . .58 Expired License Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Chapter 4:
Remote Upgrades
61
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Suggested Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Preparation for Remote Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Upgrade Installation File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Specifying Shortened Upgrade File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64 Distributing the Target Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Monitoring the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Collecting License Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Configuring a New License Identification Deployment . . . . . . . . . . . . . . . . . . . .70 Distributing Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Configuring a New License Distribution Deployment . . . . . . . . . . . . . . . . . . . . .72 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 Upgrading from OpenDeploy 5.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 Reboot Required After Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 Remote Upgrade Configuration File Location for OpenDeploy 5.6 Targets . . . .73 Remote Upgrades on UNIX Target Hosts as a Non-Root User . . . . . . . . . . . . . . . . .74
Index
77
Interwoven, Inc.
List of Figures
Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Base Server Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 Administration Package Installation Program . . . . . . . . . . . . . . . . . . . . . .23 ContentServices Foundation Installation Program . . . . . . . . . . . . . . . . . . .24 Remote Upgrade Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Remote Upgrade Window Software Distribution Configurations . . . . .50 Remote Upgrade Window Software Distribution Configurations (cont.) . 50 Remote Upgrade Window Software Distribution Configurations (cont.) . 51 Start Deployment Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 Remote Upgrade Window License Identification Configurations . . . . .53 Remote Upgrade Window License Identification Configurations . . . . .54 License Distribution Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 License Distribution Windows for New Configurations . . . . . . . . . . . . . .56 Remote Upgrade Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Remote Upgrade Window Software Distribution Configurations . . . . .65 Remote Upgrade Window Software Distribution Configurations (cont.) . 66 Remote Upgrade Window Software Distribution Configurations (cont.) . 67 Start Deployment Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Remote Upgrade Window License Identification Configurations . . . . .69 Remote Upgrade Window License Identification Configurations . . . . .70 License Distribution Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 License Distribution Windows for New Configurations . . . . . . . . . . . . . .72
List of Figures
Interwoven, Inc.
About This Book

OpenDeploy Installation Guide is a manual that contains installation information for OpenDeploy , including installation preparation, licensing requirements, and remote upgrade procedures.
Intended Audience
This manual is for those tasked with installing and configuring OpenDeploy software. If you are using OpenDeploy in conjunction with TeamSite , you should also know TeamSite functionality and terminology. Many of the operations described in this manual require root or Administrator access to the OpenDeploy server host. If you do not have root or Administrator access to the OpenDeploy server host, consult your system administrator.
This manual uses the term Windows to indicate any supported version of the Microsoft Windows operating system, such as Windows NT or Windows 2000.

This manual uses the term UNIX to indicate any supported flavor of the 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 of this manual should be familiar with basic UNIX commands and be able to use an editor such as emacs or vi. It is also helpful to be familiar with regular expression syntax. If you are not familiar with regular expressions, consult a reference manual such as Mastering Regular Expressions by Jeffrey Friedl.
About This Book
Notation Conventions
This manual uses the following notation conventions: Table 1 Bold Notation Conventions
Definition and Usage
Convention
Text that appears in a GUI element such as, a menu item, button, or element of a dialog box, and command names are shown in bold. For example: Click Edit File in the Button Bar. Book titles appear in italics. Terms are italicized the first time they are introduced. Important information may be italicized for emphasis. Commands, command-line output, and file names are in monospace type. For example: The iwextattr command-line tool allows you to set and look up extended attributes on a file. Monospaced italics are used for command-line variables.For example:
iwckrole role user
Italic
Monospace
Monospaced italic
This means that you must replace role and user with your values.
Monospaced bold
Monospaced bold represents information you enter in response to system prompts. The character that appears before a line of user input represents the command prompt, and should not be typed. For example:
iwextattr -s project=proj1 //IWSERVER/default/main/dev/WORKAREA/andre/products/ind ex.html
Monospaced bold italic
Monospaced bold italic text is used to indicate a variable in user input. For example:
iwextattr -s project=projectname workareavpath
means that you must insert the values of projectname and workareavpath when you enter this command.
[] |
Square brackets surrounding a command-line argument mean that the argument is optional. Vertical bars separating command-line arguments mean that only one of the arguments can be used.
This guide also uses the following conventions: The term Windows indicates any supported version of the Microsoft Windows operating system, such as Windows NT or Windows 2000.

Directory paths use UNIX conventions. These conventions mandate using forward slashes (/) in path names. (Windows systems use backward slashes.) The Windows convention is used when referring to a Windows-specific directory. For example:
UNIX: docroot/news/front.html Windows: docroot\news\front.html
Interwoven, Inc.
Chapter 1
Preparation
This chapter describes the installed components of the OpenDeploy software, and provides information to help you install your software successfully.
System Requirements
Refer to the OpenDeploy Release Notes for the latest information on the following installation-related topics: Supported operating systems Localized operating system support RAM requirements Storage requirements Patch requirements Supported browsers Certified reporting server databases Compatibility between OpenDeploy releases Compatibility between OpenDeploy and other Interwoven products Supplemental information regarding installation on particular operating systems
Chapter 1: Preparation
OpenDeploy Software Components

OpenDeploy has several software components, each of which must be installed on the appropriate server. Here are the components: Base server software - this is the software which controls the management of deployments on the source server. This software permits the OpenDeploy server to send and receive deployed files. Receiver software - this is the software that must be installed on each server designated only for receiving deployed files. Servers with the base server software installed do not need the receiver software. Administration software package containing the following components: Administration server software - this is software for managing and generating the user interface. Reporting server software - this is software for managing the storage and publication of event-based reports. ContentServices Foundation access service - this is software for authenticating individuals who will access OpenDeploy base servers or receivers through the browser-based user interface or web services.
Base and Receiver Software

Any host that is participating in deployments must have either the base server or receiver software installed. Installation of the base server and receiver software is essentially the same. Here is the criteria for where these software components should be installed. Base server software - install on the server designated as an OpenDeploy source server, a server capable of sending deployments to target servers. The base server is also capable of receiving deployments from other source servers. Receiver software - install on each server designated as an OpenDeploy target server, a server capable only of receiving deployments from the source server. Because a server with the base server software installed can receive deployed files as well as send them, there is never a need to install both software components on the same server. During installation, you are prompted to designate the parent directory for the base server or receiver software. The installer creates the following home directory:
parent_directory/OpenDeployNG
On Windows hosts, the default parent directory is:

C:\Interwoven
Interwoven, Inc.
10
However, you can select another parent directory if you want. On UNIX, you must select the parent directory. The following locations are typical home directories for the base server or receiver software: Windows - C:\Interwoven\OpenDeployNG UNIX - /usr/Interwoven/OpenDeployNG The base server or receiver home directory is indicated in this manual by the term:
od-home
Administration Server Software

The administration server software, combined with the reporting server, is installed as part of the administration package. During installation, you are prompted to designate the parent directory for the administration server software. The installer creates the following home directory for the administration and reporting server software:
parent_directory/AdminServer

C:\Interwoven
However, you can select another parent directory if you want. On UNIX, you must select the parent directory. The following locations are typical home directories for the administration server software: Windows - C:\Interwoven\AdminServer UNIX - /usr/Interwoven/AdminServer The administration server home directory is indicated in this manual by the term:
admin-home
Tomcat Server
One component of the administration server is the Tomcat server. The Tomcat server helps manage and generate the OpenDeploy user interface. OpenDeploy installs and uses its own Tomcat server, even if other Tomcat server software resides on your OpenDeploy server host.
11
Reporting Server Software

The reporting server software is installed as part of the administration server software. Within the administration server software home directory are subdirectories containing reporting server files.
ContentServices Foundation Access Service Software

OpenDeploy uses the ContentServices Foundation (CSF) access service to authenticate individuals who will access OpenDeploy base servers or receivers through the browser-based user interface or web services. The CSF access service software is installed as part of the administration package installation, seamlessly following the installation of the administration and reporting server software. During installation, you are prompted to designate the parent directory for the CSF access service software. The installer creates the following home directory for the CSF access service software:
parent_directory/CSF

C:\Interwoven
However, you can select another parent directory if you want. On UNIX, you must select the parent directory. The following locations are typical home directories for the administration server software: Windows - C:\Interwoven\CSF UNIX - /usr/Interwoven/CSF The administration server home directory is indicated in this manual by the term:
csf-home
Interwoven, Inc.
12
Installation Prerequisites
The following sections describe the information and decisions you must provide for each software component installation. Refer to the OpenDeploy Release Notes for any additional installation-related information, such as those for installation on a specific operating system.
Base Server
Installation of the base server software includes the following tasks: Accepting the license agreement. Specifying where the base server software is to be installed. You can accept the default installation location or specify your own. Specifying the port number for RMI registry service. The default port number is 9173. To avoid conflicts with the RMI registry service, it is strongly recommended that you do not include non-Interwoven applications that might need to use these ports in your OpenDeploy environment. Specifying the listening port number for incoming deployments. The default port number is 20014. Whether to enable or disable the reporting feature. The default setting is enabled. Select the platform (Windows or UNIX) of the bootstrap user. The bootstrap user is the first user to access your OpenDeploy server from the browser-based user interface. Using the bootstrap administrator, you can subsequently create other users with access to your server. Indicating the user name and domain (Windows only) assigned to the bootstrap administrator. By default, the following values listed as bootstrap users: Windows - hostname\Administrator UNIX - root Any additional user name and domain you enter will be added as the bootstrap administrator to the service configuration file (deploy.cfg) of the OpenDeploy server.
13
License Types
When you first install the base server software, you have full usage of its features and functionality for 30 days. However, after that time you must provide the appropriate license to use it further. You can provide one of the following license types: Full - the full-featured version with no time limit. EasyDeploy - a restricted-feature version you can use with no time limit. EasyDeploy is sometimes included as part of other Interwoven products. EasyDeploy does not support the following OpenDeploy features and functionality: Fan-out deployment Multi-tiered deployment Secure data transfer Multiple base server instances on one host Use of delivery adapters Use of payload adapters See Chapter 3, Licensing for more information on licensing your base server.
Receiver
Installation of the receiver software includes the following tasks: Accepting the license agreement. Specifying where the receiver software is to be installed. You can accept the default installation location or specify your own. Specifying the port number for RMI registry service. The default port number is 9173. To avoid conflicts with the RMI registry service, it is strongly recommended that you do not include non-Interwoven applications that might need to use these ports in your OpenDeploy environment. Specifying the port number for incoming deployments. The default port number is 20014. Whether to enable or disable the reporting feature. The default setting is disabled. Indicating the user name and domain (Windows only) assigned to the bootstrap administrator. This user and domain will be added as the bootstrap administrator to the service configuration file (deploy.cfg) of the OpenDeploy server.The bootstrap user is the first user to access your OpenDeploy server from the browser-based user interface. Using the bootstrap administrator, you can subsequently create other users with access to your server. (Windows only) Specifying the location for the TMP system environmental variable.
Interwoven, Inc.
14
Administration Package Placement

The OpenDeploy administration package can be installed on any host that has network access to the base servers and receivers to be administered. You may install the administration package on a host that also has a base server or receiver installed on it. The order of installation does not matter.
Administration and Reporting Servers

Installation of the administration server software includes the following tasks: Specifying where the administration server software is to be installed. You can accept the default installation location or specify your own. Specifying the port number used to broadcast the user interface. The default port is 8081. The port number you choose must be included in the URL that you enter to access the OpenDeploy user interface. Refer to OpenDeploy User Interface on page 61 in the OpenDeploy Administration Guide for more information.
ContentServices Foundation Access Service

The CSF access service generates a key file named passphrase by default. After installing the OpenDeploy base server or receiver software for the first time on a host, you must copy the CSF access service key file to those base servers or receivers on which one or both of the following apply: Those that require that a specific CSF access service authenticate users logging into the OpenDeploy browser-based user interface. By default, you do not need to copy the CSF access service key file to base servers or receivers in order to use the OpenDeploy browser-based user interface. Those that will be accessed through a Web services client program. Any instances of the OpenDeploy base server or receiver operating under these circumstances you subsequently create on the host must also have the key file added to it. Refer to the section on Access Service Management on page 111 in the OpenDeploy Administration Guide for more information. Refer to your ContentServices Foundation access service documentation for more information on installation and generation of the key file.
15
Using a Non-Default CSF Port

If you specify a port number other than the default (12973) during the CSF installation, you must open the administration servers framework.properties file and update its DeployAdmin.ASPort property to reflect the correct port number. Otherwise, the OpenDeploy administration server will not be able to communicate with CSF and a failure will occur. Refer to ContentServices Foundation Access Service on page 120 in the OpenDeploy Administration Guide for more information.
RMI Registry Service Considerations

One of the underlying services of Interwoven products such as OpenDeploy and TeamSite is the RMI registry. Interwoven products using this service can work together without a problem. However, other software products that make use of the RMI registry can cause conflicts that might prevent OpenDeploy and other Interwoven products from working properly. It is strongly recommended that no other programs accessing the same RMI registry as the ones used by OpenDeploy and TeamSite be included in your OpenDeploy environment. The RMI registry port used is 9173 (default) or a port you specify during installation.
Enabling DOS-Compatible 8.3 Format File Names for Windows

OpenDeploy requires that the DOS-compatible 8.3 format file names feature be enabled prior to the installation of OpenDeploy software on a Windows host. You can check if this feature is enabled, and if necessary enable it, by editing the registry key and values. To check for DOS-compatible 8.3 format file names, follow these steps: 1. Select Start > Run to open a Run window. 2. Enter the following value in the Open box:
regedit
and click OK. The Registry Editor window is displayed. 3. Navigate to the following directory path in the Registry Editor window:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem
The following item appears under the Name column as part of the contents of the FileSystem folder on the right pane of the Registry Editor window:
NtfsDisable8Dot3NameCreation
If DOS-compatible 8.3 format file names support is enabled, the corresponding value is displayed under the Data column:
0x00000000 (0)
Interwoven, Inc.
16
No further modification is required, and you can close the Registry Editor window. If DOS-compatible 8.3 format filenames support is disabled, this value is displayed as:
0x00000001 (1)
You must continue with the following steps to enable the DOS-compatible 8.3 format file names. 4. Highlight the NtfsDisable8Dot3NameCreation entry, and select Edit > Modify to open the Edit DWORD Value window. 5. Change the value from 1 to 0 in the Value data box and click the OK. This enables the feature, which is indicated by the corresponding Data column value in the Registry Editor window being displayed as:
0x00000000 (0)
No further modification is necessary, and you can close the Registry Editor window.
17
Interwoven, Inc.
18
Chapter 2
Installation
This chapter describes the installation procedure for your OpenDeploy software. Install the appropriate components, one at a time, on the servers making up your OpenDeploy environment. See OpenDeploy Software Components on page 10 to determine the requirements for each component. Check the OpenDeploy Release Notes for any additional information regarding installing your OpenDeploy software before going any further.
Windows
Installation of OpenDeploy on a Windows host requires the following tasks: Ensuring the DOS-compatible 8.3 format file names feature is enabled, and if necessary, enabling it yourself. See Enabling DOS-Compatible 8.3 Format File Names for Windows on page 16 for more information. Installation of the base server or receiver software Installation of the administration package, which include the administration server and reporting server software pieces. You must have Administrator privileges to install OpenDeploy on your Windows server. Close all other open applications before installing OpenDeploy software on your Windows server. You must close the Services window (not just minimize it) prior to installing OpenDeploy on a Windows host. Otherwise, the Windows registry keys will not get updated properly.
19
Chapter 2: Installation
Installing the Base Server Software

The following instructions are for performing a fresh installation (not an upgrade) of the OpenDeploy base server package. If you already have a previous release of the OpenDeploy base server installed, you can perform one of the following options: Upgrade that release to the current one. See Upgrading OpenDeploy on page 30 for more information on upgrades. Keep your existing OpenDeploy 5.x base server installation intact (if your release is supported), and install this release into a different location on your host. See Installing Multiple Releases of OpenDeploy on page 34 for more information. To install the base server software on a Windows host, follow these steps: 1. Navigate to the working directory containing the appropriate base server installation file:
IWOVopendeployBaseFull.6.x.x.x.x.Buildyyyyy.Windows.exe
where xxxx indicates the product release number and yyyyy indicates the build number of the final shipping product. 2. Double-click the installation file to start the installation program to start the installation program (Figure 1): Figure 1 Base Server Installation Program
3. Click Next to continue. 4. Read the license agreement and click Yes to accept its conditions. Clicking No quits the installation program. 5. Select the parent directory where the base server software will be installed and click Next. The default location is:
C:\Interwoven
Upon installation, the base server software will reside in the following location:
parent-dir\OpenDeployNG
6. Enter the port number for the RMI registry in the Registry box. The default value is 9173. 7. Enter the listening port number for incoming deployment in the Deploy box. The default value is 20014. Click Next to continue.
Interwoven, Inc.
20
8. Click Enable (default) or Disable to indicate whether or not you want your base server to broadcast event reporting. Click Next to continue. If you selected Enable, go to the next step. Otherwise, skip to step 11. 9. Enter the TCP port number for event reporting in the TCP Port box. The default value is 9171. 10. Enter the JNDI port number for event reporting in the JNDI Port box. The default value is 9172. Click Next to continue. 11. Click Windows or UNIX to indicate whether the host is a Windows or UNIX operating system. This step is required to determine the format of the bootstrap administrator. Click Next to continue. The Bootstrap User Information window is displayed. The bootstrap administrator is a user account that can access the browser-based user interface (through the administration server) initially after installation. Depending on which operating system you chose, the following default bootstrap administrator user values are displayed: Windows: Name: Administrator Domain: host_name UNIX: Name: root If you want to specify another bootstrap administration user in addition to the default one displayed, proceed to the next step. If you want to use the default bootstrap administrator listed, click Next to continue and skip the next step. 12. (If you are specifying your own bootstrap administrator user) Enter the bootstrap name in the Name box, and (if necessary) domain to which it belongs in the Domain box. Click Next to continue. 13. Verify the settings you want in the Summary Report window and click Next. The base server installer program installs the base server on your host. If you accepted the default installation locations, the installed software resides in the following location:
C:\Interwoven\OpenDeployNG
21
Installing the Receiver Software

The following instructions are for performing a fresh installation (not an upgrade) of the OpenDeploy receiver package. If you already have a previous release of the OpenDeploy receiver installed, you can perform one of the following options: Upgrade that release to the current one. See Upgrading OpenDeploy on page 30 for more information on upgrades. Keep your existing legacy receiver installation intact (if your release is supported), and install this release into a different location on your host. Refer to Running Multiple Releases of OpenDeploy on page 30 in the OpenDeploy Release Notes for more information. Installation of the receiver software is nearly identical to installing the base server software with the following exceptions: The receiver software does not include a scheduler database. By default, the reporting server is disabled. The receiver installation file is named:
IWOVopendeployRcvr.6.x.x.x.x.Buildyyyyy.Windows.exe
where xxxx indicates the product release number and yyyyy indicates the build number of the final shipping product, to start the installation program. Follow the installation instructions described in Installing the Base Server Software on page 20 to install the receiver software. You cannot install the receiver software on a host that already has base server software installed.
Installing the Administration Package

The following instructions are for performing a fresh installation (not an upgrade) of the OpenDeploy Administration package. If you already have a previous release of the OpenDeploy administration package installed, you must upgrade to this release. You cannot co-locate different versions of the OpenDeploy administration package software on the same host. See Upgrading OpenDeploy on page 30 for more information on upgrades. To install the administration package on a Windows host, follow these steps: 1. Navigate to the working directory containing the administration package installation file:
IWOVopendeployAdmin.6.x.x.x.x.Buildyyyyy.Windows.exe
where xxxx indicates the product release number and yyyyy indicates the build number of the final shipping product.
Interwoven, Inc.
22
2. Double-click the installation file to start the installation program (Figure 2). Figure 2 Administration Package Installation Program
3. Click Next to continue. 4. Read the license agreement and click Yes to accept its conditions. Clicking No quits the installation program. 5. Select the parent location where the administration server and reporting server software will be installed and click Next. The default location is:
C:\Interwoven
You can also click Browse and navigate to another location. Upon installation, the administration and reporting server software will reside in the following location:
parent-dir\AdminServer
6. Enter the port number for the administration server and click Next. The default port number is 8081. 7. Verify the settings you want in the Summary Report window and click Next. The administration package installer program installs the administration server and reporting server on your host. If you accepted the default installation locations, the installed software resides in the following location:
C:\Interwoven\AdminServer
When the administration and reporting servers have been installed, the ContentServices Foundation (CSF) installer automatically begins. The following section describes the installation of the CSF access service.
23
Installing the ContentServices Access Service

The CSF access service is installed as part of the administration package. The CSF installer begins automatically following the installation of the administration and reporting server, starting with the license agreement (Figure 3). Figure 3 ContentServices Foundation Installation Program
1. Read the license agreement and click the option to accept its conditions. Click Next to continue. 2. Select the parent location where the ContentServices Foundation software will be installed and click Next. This path cannot contain any multi-byte characters. The default location is:
C:\Interwoven
Upon installation, the ContentServices Foundation software will reside in the following location:
parent-dir\CSF
3. Enter the appropriate port number in the AccessService HTTP port number box. The default port number is 12973. If you specify a non-default port number, you must perform additional configuration. See Using a Non-Default CSF Port on page 16 for more information. 4. Enter the appropriate resolvable host name or IP address in the Access Service HTTP hostname or IP address box. The default value is the name of the host on which the CSF software is being installed. Click Next to continue. A new window appear summarizing the settings you specified for the installation. 5. Click Install to proceed with the installation. When the installation is completed, restart the host. The ContentServices Foundation access service will start automatically. If you accepted the default installation locations, the installed software resides in the following location:
C:\Interwoven\CSF
Interwoven, Inc.
24
Configuring the Bootstrap Administrator

After you have completed installing your OpenDeploy software components, you may configure or change a bootstrap administrator on the host where you installed your base server or receiver software. You must restart the base server or receiver after performing this task. After you have configured your bootstrap administrator and restarted your base server or receiver, you can log in to the OpenDeploy user interface as the bootstrap administrator, access the base server or receiver, and perform administrative functions. Refer to Modifying the Bootstrap Administrator User on page 118 in the OpenDeploy Administration Guide for more information.
UNIX
You must have root privileges to install OpenDeploy on your UNIX server.
Installing the Base Server Software

The following instructions are for performing a fresh installation (not an upgrade) of the OpenDeploy base server package. If you already have a previous release of the OpenDeploy base server installed, you can perform one of the following options: Upgrade that release to the current one. See Upgrading OpenDeploy on page 30 for more information on upgrades. Keep your existing legacy base server installation intact (if your release is supported), and install this release into a different location on your host. See Installing Multiple Releases of OpenDeploy on page 34 for more information. To install the base server package on a UNIX host, follow these steps: 1. Navigate to the working directory containing the appropriate base server installation file:
IWOVopendeployBaseFull.6.x.x.x.x.Buildyyyyy.UNIX_OS.tar.gz
where xxxx indicates the product release number, yyyyy indicates the build number of the final shipping product, and UNIX_OS indicates the particular UNIX platform. 2. Use one of the following methods to unzip and untar the base server installation file: Unzip the installation file by entering the following command at the prompt (use the installation file appropriate for your base server version):
gzip -d IWOVopendeployBaseFull.6.x.x.x.x.Buildyyyyy. UNIX_OS.tar.gz
Next, untar the installation file by entering the following command at the prompt (use the installation file appropriate for your base server version):
tar -xvf IWOVopendeployBaseFull.6.x.x.x.x.yyyyy.UNIX_OS.tar
25
Unzip and untar the installation file by entering the following command at the prompt (use the installation file appropriate for your base server version):
gzip -c -d IWOVopendeployBaseFull..6.x.x.x.x.Buildyyyyy. UNIX_OS.tar.gz | tar -xvpf -
The following items are created:

odsfiles
directory (for the full version of the base server software) file file
ODNG_base_full.tar
OpenDeploy_base_license.txt README_OPENDEPLOY startinstall_od
file
file
3. Start the installation script by entering the following command at the prompt:
./startinstall_od
Ensure you are in your installation working directory before running this command. 4. Accept the licensing agreement by pressing Enter. 5. Enter the location where the base server software will be installed, for example /usr. 6. Enter a port number for the RMI registry. The default value is 9173. 7. Enter the name for the default scheduler database. The default name is schedDB. 8. Enter a listening port number for incoming deployment. The default value is 20014. 9. Indicate whether (y) or not (n) you want to enable your base server to broadcast event reporting. 10. (If event reporting is enabled) Enter a TCP port for event reporting. The default value is 9171. 11. (If event reporting is enabled) Enter a JNDI port for event reporting. The default value is 9172. 12. Indicate whether or not you want to add a bootstrap administrator user in addition to the default bootstrap administrator root. The bootstrap administrator is a user account that can access the browser-based user interface (through the administration server) immediately after installation. 13. (If you are adding an additional bootstrap administrator user) indicate whether the host platform is Windows (1) or UNIX (2). 14. (If you are adding an additional bootstrap administrator user) Enter the additional bootstrap administrator user name. If the host platform is Windows, you must also add the domain. The base server installer now installs the software on your host in the following location:
/parent_dir/OpenDeployNG
where parent_dir is the location you selected for the software installation.When you have completed the installation, delete the installation file to save room on your server.
Interwoven, Inc.
26
Installing the Receiver Software

Installation of the receiver software is nearly identical to installing the base server software with the following exceptions: The receiver software does not include a scheduler database. By default, the reporting server is disabled. The receiver license is named OpenDeploy_receiver_license.txt. The receiver installation file is named:
IWOVopendeployRcvr.6.x.x.x.x.Buildyyyyy.UNIX_OS.tar.gz
where xxxx indicates the product release number, yyyyy indicates the build number of the final shipping product, and UNIX_OS indicates the particular UNIX platform. Follow the installation instructions described in Installing the Base Server Software on page 25 to install the receiver software. You cannot install the receiver software on a host that already has base server software installed.
Installing the Administration Package

To install the administration package on a UNIX host, follow these steps: 1. Navigate to the working directory containing the administration package installation file:
IWOVopendeployAdmin.6.x.x.x.x.Buildyyyyy.UNIX_OS.tar.gz
where xxxx indicates the product release number and yyyyy indicates the build number of the final shipping product and UNIX_OS indicates the particular UNIX platform. 2. Use one of the following methods to unzip and untar the installation file: Unzip the installation file by entering the following command at the prompt:
gzip -d IWOVopendeployAdmin.6.x.x.x.x.Buildyyyyy.UNIX_OS.tar.gz
Next, untar the installation file by entering the following command at the prompt:
tar -xvf IWOVopendeployAdmin.6.x.x.x.x.Buildyyyyy.UNIX_OS.tar
Unzip and untar the installation file by entering the following command at the prompt:
gzip -c -d IWOVopendeployAdmin.6.x.x.x.x.Buildyyyyy. UNIX_OS.tar.gz | tar -xvpf -
The following items are created:

csp.pkg directory odadmfiles
directory file file
IWOVadmin.tar
README_ADMINSERVER
27
OpenDeploy_admin_pkg_license.txt startinstall_admin
file
file
3. Start the installation script by entering the following command at the prompt:
./startinstall_admin
Ensure you are in your installation working directory before running this command. 4. Accept the licensing agreement by pressing Enter. 5. Enter the location where the administration server and reporting server software will be installed, for example /usr. 6. Enter the port number for the administration server. The default port number is 8081. The administration package installer program now installs the administration server and reporting server on your host in the following location:
/parent_dir/AdminServer
where parent_dir is the location you selected for the software installation.When you have completed the installation, delete the installation file to save room on your server. After you have installed all the base server or receiver software, as well as any other OpenDeploy components, you must configure your bootstrap administrator before restarting the host. Refer to Configuring the Bootstrap Administrator on page 117 in the OpenDeploy Administration Guide for more information. When the administration and reporting servers have been installed, the ContentServices Foundation (CSF) installer automatically begins. The following section describes the installation of the CSF access service.
Installing the ContentServices Foundation Access Service

The CSF access service is installed as part of the administration package. The CSF installer begins automatically following the installation of the administration and reporting server. To install the ContentServices Foundation software on UNIX from the command-line, follow these steps: 1. Enter Y at the prompt and press Enter to accept the license agreement. 2. Accept the default parent directory, /Interwoven, in which the ContentServices Foundation software directory, CSF, will be placed or enter the path of the location where you want the ContentServices Foundation software directory, CSF, to be installed and then press Enter. This path cannot contain any multi-byte characters. 3. Press Enter to confirm the location you specified.
Interwoven, Inc.
28
4. Accept the default port number, 12973, or enter an alternative after the Access Service HTTP port number prompt. Then press Enter. If you specify a non-default port number, you must perform additional configuration. See Using a Non-Default CSF Port on page 16 for more information. 5. Accept the default host name, the name of the host the software is being installed on, or enter an alternative after the Web Services HTTP hostname or IP address prompt. Then press Enter. 6. Press Enter to proceed with the installation. After you have installed the ContentServices Foundation, you can configure it. Refer to ContentServices Foundation Developer Guide for more information.
Configuring the Bootstrap Administrator

After you have completed installing your OpenDeploy software components, you may configure or change a bootstrap administrator on the host where you installed your base server or receiver software. You must restart the base server or receiver after performing this task. After you have configured your bootstrap administrator and restarted your base server or receiver, you can log in to the OpenDeploy user interface as the bootstrap administrator, access the base server or receiver, and perform administrative functions. Refer to Modifying the Bootstrap Administrator User on page 118 in the OpenDeploy Administration Guide for more information.
Platform-Specific Installation Requirements

OpenDeploy software on certain supported host platforms might require additional installation steps and configurations. Refer to Platform-Specific Installation, Upgrades and Configuration on page 24 in the OpenDeploy Release Notes for any additional instructions related to installing OpenDeploy on a specific host platform.
29
Upgrading OpenDeploy
The following sections describe upgrading from a previous release of OpenDeploy to the current release. In addition to the upgrade methods described here, you can also use the remote upgrade feature to update multiple OpenDeploy base server and receivers to OpenDeploy 6.1 and later simultaneously. See Remote Upgrades on page 46 for more information.
Upgrading From a Previous Release

You can use the upgrade feature of the installation program to automatically upgrade your OpenDeploy software to the current release. Upgrading OpenDeploy allows you to keep many of your existing settings, such as those for the ports, bootstrap administrator information, and scheduler database. Important configuration files, such as deployment configurations are also preserved for use with the upgraded software. Upgrading your OpenDeploy software in this manner installs the new software in the same location as your earlier release, and keeps all applicable settings. Upgrading also preserves your existing OpenDeploy directory structure. Upgrading is the same for both Windows and UNIX hosts. To upgrade your software, run the appropriate OpenDeploy software installation program. See Windows on page 19 and UNIX on page 25 for the file names and other information. When upgrading on Windows, the Services window must be closed (not just minimized) prior to installation. Otherwise, the Windows registry keys will not get updated properly. It is not possible to automatically upgrade to the current release of OpenDeploy from releases earlier than 5.5.1. To upgrade from releases earlier than 5.5.1, you can install the current OpenDeploy release, copy and convert your configuration files from the older version, and then uninstall the older version. For each OpenDeploy software component you want to upgrade, the installer will check for existing software already installed: If you are installing the base server or receiver component on a host that has an OpenDeploy 5.x release of the same component, the installer will prompt you on whether you want to upgrade your existing OpenDeploy 5.x software with the current release, or whether you want to install the new component alongside the existing one on the same host. Select the upgrade option to upgrade your existing software. See Installing Multiple Releases of OpenDeploy on page 34 for more information on installing multiple OpenDeploy releases. If you already have an OpenDeploy 6.x installation present on your host, you only have the option of upgrading that 6.x software to the current release.
Interwoven, Inc.
30
If you are installing the administration package, it will prompt you to either upgrade or exit. You cannot install a new administration package alongside a legacy release of the same component. Upgrading the administration server requires manual updating of the reporting database. See Administration Package Upgrades on page 32 for more information. When you choose to upgrade, the installer program automatically uninstalls the old software and installs the current version. The new installation automatically uses your existing port settings and other configurations. For new features, you are prompted to input the required information.
NOTE
Upgrading to the current version of OpenDeploy on Windows requires that the Windows host be rebooted.
Upgrading When Running as Non-Administrator or Non-Root

If your existing release of the OpenDeploy base server or receiver was configured to allow running the software as someone other than the Administrator user on Windows or the root user on UNIX, upgrading it to this release will remove this configuration. You must reconfigure it for non-Administrator or non-root usage following the upgrade. Refer to Running OpenDeploy as Non-Administrator or Non-Root on page 54 in the OpenDeploy Administration Guide for more information.
Updating Your Configuration Files

OpenDeploy configuration files such as the base server, receiver, and nodes configuration files, can have new or changed elements and attributes when upgrading to a new OpenDeploy release. To avoid overwriting your existing configuration files, those configuration files that have been modified in the new OpenDeploy release are given the newxx extension, where xxx is the three-digit release number for the updated release, for example, odbase.xml.new602, and are co-located with the existing equivalent file in the same location. Check your od-home/etc and other directories where user-defined configuration files reside after you upgrade to the latest OpenDeploy release. If you notice the presence of files with the newxx extension, that is indicative that the associated configuration file has been modified since the last release. Compare your existing configuration with the updated version to observe any additions or changes. Then consult the OpenDeploy documentation to determine the nature of the changes.
31
Upgrading With Multiple OpenDeploy Instances That Use Event Reporting

If your OpenDeploy base server or receiver installation has multiple instances which you have created using the iwodinsttool command, the instances event reporting configuration files and database files will not be automatically upgraded when OpenDeploy is upgraded. The procedure on how to reconfigure the event reporting files and migrating the event reporting database for the instance will be published in a Knowledge Base (KB) article shortly. Contact Interwoven support for assistance in upgrading the multiple instances.
Updating Requirements for Database Deployments Use

If you have been running database deployments on your previous OpenDeploy 6.0.x software, you must perform additional configuration when upgrading to this release. This configuration compensates for the deprecated iwsyncdb.cfg file, which is no longer used. To configure your upgraded OpenDeploy server for database deployments, follow these steps: 1. Open your base server or receiver configuration file (by default odbase.xml and odrcvr.xml) using your favorite text or XML editor. 2. Update the databaseDeployment element with the new daemon_port attribute as follows:
<databaseDeployment daemon_port="MYDATABASEDEPLOYPORT" ... >
where MYDATABASEDEPLOYPORT is the internal port used by the OpenDeploy base server or receiver for database deployment support. 3. Save and close your OpenDeploy server configuration file.
Administration Package Upgrades

With this release of OpenDeploy, the reporting database schema has changed. As a result, when you upgrade your administration package software, you must perform the following configuration tasks: Upgrade your reporting tables. Refer to Upgrading Reporting Tables on page 339 in the OpenDeploy Administration Guide for more information. Upgrade the demonstration database that comes with OpenDeploy. Refer to Upgrading the Default Reporting Database on page 340 in the OpenDeploy Administration Guide for more information.
Interwoven, Inc.
32
Operations Server
If you are upgrading from a previous release of OpenDeploy that used the operations server, that software is no longer needed with this release. After upgrading the OpenDeploy administration package, you should uninstall the operations server software.
Uninstalling the Operations Server on WIndows

To uninstall the operations server software on Windows, follow these steps: 1. Open the Add/Remove Programs window. This process may differ depending on the version of Windows you are using. 2. Select Interwoven Operation Server from the Currently Installed Programs list. 3. Click Change/Remove to remove the software. Certain files and directories remain on your host after the uninstallation, such as log files and configuration files. This allows you to keep a record of your OpenDeploy activities even after the software is removed. If you want to remove these files as well, you can manually delete them from within the Windows Explorer.
Uninstalling the Operations Server Software on UNIX

To uninstall the operations server software on a UNIX server, follow these steps: 1. Navigate to the parent directory where you installed the administration package software. 2. Run the uninstallation script to remove the operations server software by entering the following command at the prompt:
./OpenAPI/install/uninstallopserver
The uninstallation script removes the entire directory. You must save any log and configuration files you want to preserve to another location prior to uninstalling the software.
Updating OpenDeploy Home Value in Scripts

The OpenDeploy release number is now a component of the OpenDeploy home variable name: Windows - the system environment variable is IWOD60HOME UNIX - the home file is /etc/defaultiwod60home The previous home variables were: Windows - the system environment variable was IWODHOME
33
UNIX - the home file was /etc/defaultiwodhome This change is to allow you to have both the current release of OpenDeploy, and one of the supported legacy releases, for example release 5.6, installed on the same host. If you have scripts that use the previous OpenDeploy home directory variable, you must modify them to apply to the current release. Future releases of OpenDeploy are expected to have their release numbers incorporated into the home value in the same manner as this release. Therefore, you should configure your scripts in such a manner that you are not required to manually update them to the next OpenDeploy release when you upgrade. For example: Windows - set the IWODHOME system environment variable to equal the IWOD60HOME system environment variable. UNIX: Configure a well known wrapper to point to /etc/defaultiwod60home. Program your scripts to look for the wrapper instead of /etc/defaultiwod60home. If you upgrade from this release to a later one, you only need to change the wrapper instead of your custom scripts. Create a symbolic link from /etc/defaultiwodhome to /etc/defaultiwod60home or any future release. Following the above techniques will not allow you to reuse the same scripts against all the co-existing release versions. You can only use the scripts against the designated OpenDeploy version.
Installing Multiple Releases of OpenDeploy

You can install the current release of OpenDeploy alongside a supported OpenDeploy 5.x release on the same host, with the following limitations: Each must be installed in a separate location. Both software releases must be of the same component type (base server or receiver). Only the current administration package is supported for all installed OpenDeploy releases. You cannot have multiple administration packages installed in your OpenDeploy environment. You must ensure that there are no port conflicts between the OpenDeploy installations. Refer to Chapter 2, OpenDeploy Ports in the OpenDeploy Reference for more information. The remote upgrade feature is not available for use. It does not support hosts with multiple OpenDeploy installations.
Interwoven, Inc.
34
Refer to Running Multiple Releases of OpenDeploy on page 30 in the OpenDeploy Release Notes for those supported legacy releases, and any other specific information. If you are installing the current base server or receiver on a host that already contains an OpenDeploy 5.x release of the same software component, the installer may ask you whether you want to install this release of OpenDeploy as an upgrade to your existing software, or whether you want to install it in addition to your existing software. You should indicate that you want to install it in addition to the your existing software.
Installation Order
If you are performing fresh installations of the current base server or receiver software, as well as the supported legacy release, you must install the software in the following order: Install the legacy OpenDeploy release. Install the latest legacy OpenDeploy service pack release. Install the current release. Install the latest current OpenDeploy service pack release (if available).
Configuring OpenDeploy Home Values

If you have multiple releases of OpenDeploy on the same host, you must reference the home value of the specific release in any scripts you create, for example:
/etc/defaultiwod60home
This is a change from previous OpenDeploy releases where you could reference the OpenDeploy home directory simply as iwodhome, for example: Windows - the system environment variable is IWOD60HOME UNIX - the home file is /etc/defaultiwod60home See Updating OpenDeploy Home Value in Scripts on page 33 for suggestions on managing changes in the OpenDeploy releases home value.
Uninstalling OpenDeploy
Uninstall OpenDeploy software components one at a time, similar to the way you installed them. In some cases you will want to remove all of the components on a server. In other cases you might only want to remove some components, such as if you have a single-host installation of all the components on a single server and you want to spread them out over several servers. Uninstallation of OpenDeploy software varies depending on the server platform.
35
Windows
You must have Administrator privileges to uninstall OpenDeploy software on a Windows host. To uninstall each OpenDeploy software component, you must perform the following tasks in order: Stop the OpenDeploy service for each corresponding software component. Uninstall the software component itself, using the Windows Add/Remove Programs tool. Remove any remaining files and directories as necessary. Even after uninstallation, OpenDeploy leaves some legacy files and directories, such as od-home/conf. This allows you to retain files such as customized configuration files that you might want to maintain even if you decide to reinstall OpenDeploy.
Stopping the OpenDeploy Services

Refer to Stopping OpenDeploy on page 43 in the OpenDeploy Administration Guide for instructions on which OpenDeploy services are associated with which software components, and how to stop those services. After you have stopped the appropriate OpenDeploy services, you can now uninstall the OpenDeploy software.
Uninstalling the OpenDeploy Software

To uninstall the OpenDeploy software on a Windows server, follow these steps: 1. Open the Add/Remove Programs window. This process may differ depending on the version of Windows you are using. 2. Select the OpenDeploy software component you want to uninstall from the Currently Installed Programs list: Interwoven OpenDeploy 6.x.x Admin/Reporting Server Interwoven OpenDeploy 6.x.x Base Server (base server only) Interwoven OpenDeploy 6.x.x Receiver (receiver only) Interwoven ContentServices Foundation 1.1.x.x where 6.x.x and 1.1.x.x indicates the release numbers of OpenDeploy and CSF, respectively. 3. Click Change/Remove to remove the software.
Interwoven, Inc.
36
4. Repeat this procedure for the remaining OpenDeploy software components you want to remove. Follow the order listed in step 2. Certain files and directories remain on your server after the uninstallation, such as log files and configuration files. This allows you to keep a record of your OpenDeploy activities even after the software is removed. If you want to remove these files as well, you can manually delete them from within the Windows Explorer.
UNIX
You must be root to uninstall OpenDeploy software on a UNIX host. To uninstall each OpenDeploy software component, you must perform the following tasks in order: Stop the OpenDeploy daemon for each corresponding software component. Uninstall each software component using the uninstallation script provided for that component. The uninstallation script removes the entire directory. You must save any log and configuration files you want to preserve to another location prior to uninstalling the software. The following sections describe the uninstallation of each software component.
Stopping the OpenDeploy Daemons

Refer to Stopping OpenDeploy on page 43 in the OpenDeploy Administration Guide for instructions on which OpenDeploy daemons are associated with which software components, and how to stop those daemons. After you have stopped the appropriate OpenDeploy services, you can now uninstall the OpenDeploy software.
Uninstalling the Administration and Reporting Server Servers

Uninstalling the administration package software automatically uninstalls reporting server software as well. To uninstall the administration server on a UNIX server, follow these steps: 1. Navigate to the parent directory where you installed the administration package software. 2. Run the uninstallation script to remove the administration server software by entering the following command at the prompt:
./AdminServer/odadmin/install/uninstalladmin
37
Uninstalling the Base Server and Receiver Software

To uninstall the base server or receiver software on a UNIX server, follow these steps: 1. Navigate to the parent directory where you installed the base server or receiver package software. 2. Run the uninstallation script to remove the OpenDeploy software by entering the following command at the prompt:
./OpenDeployNG/install/uninstallod
Uninstalling the CSF Access Service Software

To uninstall the CSF access server software on a UNIX server, follow these steps: 1. Navigate to the parent directory where you installed the CSF access service software. 2. Run the uninstallation script to remove the CSF access service software by entering the following command at the prompt:
./CSFuninstall
Interwoven, Inc.
38
Chapter 3
Licensing
This chapter describes the licensing requirements for OpenDeploy software. It also describes the process of obtaining and installing the required license keys. Software activation of base servers and receivers is required for OpenDeploy 6.1 and later. Earlier software does not require activation. The software activation process requires that you purchase a license entitlement for each OpenDeploy base server, receiver, and add-on module. If you have servers in excess of your license entitlement, you must license those additional servers separately. Contact your OpenDeploy sales representative for further information on purchasing the necessary licenses for your OpenDeploy software. After you install your OpenDeploy software, you must obtain a license key file from the Interwoven support site for each OpenDeploy base server and receiver, and subsequently deploy or manually place these files in each installation. You have the option of requesting from the Interwoven support site a single OpenDeploy license key for a particular server in your environment, or obtaining a batch set of license keys for a group of OpenDeploy server.
39
Chapter 3: Licensing
Licensing Requirements
You must perform the necessary software activation following installation of each OpenDeploy base server and receivers on their respective hosts.
Base Server Licensing

At the end of 30 days, OpenDeploy can no longer initiate or receive deployments other than the deployments required for licensing. You must obtain the appropriate software license and activate the software to extend the OpenDeploy functionality beyond that time frame. You can license your OpenDeploy base server software to operate as one of the following options: Full - the full-featured version with no time limit. EasyDeploy - a restricted-feature version you can use with no time limit. See Base Server on page 13 for more information on these types of options.
Receiver Licensing
You must license and activate each OpenDeploy receiver installation. An expired receiver will only accept incoming license deployments.
Administration Package LIcensing

Licensing of OpenDeploy administration package software is not required.
Add-On Module Licensing

The following OpenDeploy add-on modules all require separate licensing: DataDeploy Intelligent Delivery You have unrestricted use of the DataDeploy and Intelligent Delivery modules for 30 days after installation, similar to the basic OpenDeploy functionality.
Interwoven, Inc.
40
These modules do not have separate license files. Instead, the appropriate add-on module licenses are incorporated into your base server license. When you go to the Interwoven Support Web site to request your base server license, you will be prompted to indicate which add-on modules you have purchased. If you select any modules that you have not purchased, your base server license will still activate that module. An Interwoven sales representative will contact you at a later date to purchase the necessary module license.
Licensing Hosts with Multiple Host Names and Interfaces

If your OpenDeploy servers host has multiple host names, the license key file (OD.lic) should always use the primary host name. The license file supports only host names. It does not support using IP address as the host name. If you are having problems related to the license key file, contact Interwoven support for help. Be prepared to supply your existing OD.lic file and all the names associated with that host. If you host also has multiple IP addresses or interfaces, you will also need to provide that information.
Licensing Cluster Hosts

If OpenDeploy is installed in a cluster environment with multiple nodes using different host names, you should contact Interwoven Support for a special license for this type of configuration. You should be prepared to supply the host names of the nodes in your environment and the other information typically solicited for license keys.
Licensing OpenDeploy
You can license OpenDeploy base servers and receivers using one of the following methods: Single license activation - a license for a single OpenDeploy server is requested. Required information is provided manually, and the generated license is manually placed in the server host. Batch license activation - licenses for multiple OpenDeploy servers are requested. License deployments are used to collect the required information, and to distribute the generated licenses to their corresponding targets.
41
Single License Activation

To activate a single OpenDeploy server, follow these steps: 1. Access the OpenDeploy single license generator page from the Interwoven Support site:
http://support.interwoven.com
The OpenDeploy single license generator page has a link on the Support sites main page. 2. Provide the information required on the page and submit your request. Some of this information can be obtained by following the instructions described in Obtaining Host Information on page 43. You will subsequently be sent an e-mail with the OD.lic license file attached.
NOTE
You should provide the primary host name of the OpenDeploy servers host. IP addresses are not supported. 3. Place the OD.lic license file in the following location:
od-home/etc
4. Restart your OpenDeploy server.
Interwoven, Inc.
42
Obtaining Host Information

The information required for requesting a single license activation for your OpenDeploy server includes its hosts name and domain. You can determine this by navigating to the following location on your OpenDeploy host:
od-home/jre/bin
and entering the following command at the prompt:

java -cp od-home/lib/odng.jar com.interwoven.license.LicInfo -f output-file -p OD
The information appears on screen, for example:

HOSTNAME=mars DOMAIN=interwoven.com PRODUCT=OD
This information also is written to the file whose name and path you specified as the output-file variable.
NOTE
Obtaining the host name and domain is not necessary if you are performing a batch license activation. This information is obtained automatically.
Batch Server Activation

Batch server activation requires that you run a license identification deployment to collect required information regarding your OpenDeploy servers, and a license distribution deployment to distribute the generated licenses. This section assumes that you are capable of running a deployment, either from the browser-based user interface, or from the command line. Refer to the OpenDeploy Administration Guide for more information on accessing the user interface, and running deployments. You can manually generate the license identification and license distribution configuration files as described in the following sections.Alternately, after you have configured your nodes and server configuration files (steps 1-3), you can use the browser-based user interface to both request the necessary licenses for your OpenDeploy base server and receiver software, and distribute those licenses after you receive them. It is highly recommended to use the browser-based user interface to create the configuration files rather than doing it manually. Configuration through the browser-based user interface is described in Remote Upgrades on page 46, and can be performed after using the remote upgrade feature to upgrade the OpenDeploy software on a group of servers. In addition, this user interface can be used at any time to generate these configuration files.
43
Requesting the Licenses

To request licenses for the batch server activation, follow these steps: 1. Configure your OpenDeploy base servers nodes configuration file (by default odnodes.xml) to include each OpenDeploy server that you are activating. Refer to Defining Target Nodes on page 126 in the OpenDeploy Administration Guide for more information. If you are only activating the base server itself, you do not need to modify the nodes configuration file. By default, the base server is listed as a target node. Those servers that are already activated do not need to be included. 2. Use the licidentification.xml file as a basis for creating your own license identification deployment. The licidentification.xml deployment will contact each OpenDeploy base server and receiver and collect the required information on each one, for example, host name, operating system, and OpenDeploy release. The licidentification.xml file resides in the following location:
od-home/conf/licID
3. Open licidentification.xml using your favorite text or XML editor, and update its replication farm to include the appropriate targets. 4. Save the updated licidentification.xml file using a different unique name. Your original licidentification.xml file should remain unchanged so you can use it as the basis for future license identification deployments. 5. Run the license identification deployment, either from the browser-based user interface, or from the command line. The information collected is written to file odlicreq_datetimestamp.zip residing on the following location of the host running the deployment:
od-home/install/batch/req
Only those targets listed in the updated replication farm (see step 3) will have their information written to the file. So ensure that each OpenDeploy server requiring activation is included in replicationFarm element in the deployment configuration. Refer to Target Replication Farms on page 27 in the OpenDeploy Deployment Configuration Guide fore more information. 6. Access the OpenDeploy batch license generator page from the Interwoven Support site:
http://support.interwoven.com
The OpenDeploy batch license generator page has a link on the Support sites main page. Follow the instructions on the OpenDeploy batch license generator page for uploading the generated .zip file to the Interwoven Support Web site.
odbatchlic.zip,
You will subsequently receive an email from Interwoven containing the file which contains the bundled set of license files required for activating your OpenDeploy servers.
Interwoven, Inc.
44
The following section describes how to distribute the licenses you received.
Distributing the Licenses

To distribute the licenses, follow these steps: 1. Place the odbatchlic.zip file in the following location:
od-home/install/batch
Use the licdistribute.xml file as a basis for creating your own license distribution deployment. The licdistribute.xml deployment is a license distribution deployment that will pick up the odbatchlic.zip file from its location and deploy the appropriate license file into the following location on each server host: The licdistribute.xml file resides in the following location:
od-home/conf/licDist
2. Open the file licdistribute.xml using your favorite text or XML editor, and update its replication farm to include the targets (similar to what you did for your license identification deployment). 3. Save the updated licdistribute.xml file using a different unique name. Your original licdistribute.xml file should remain unchanged so you can use it as the basis for future license distribution deployments. 4. Run the license distribution deployment, either from the browser-based user interface, or from the command line. When the license distribution deployment is successfully run, each target will have its own OD.lic license file deployed to the following location:
od-home/etc
Your OpenDeploy target server will automatically accept the license file in this location. It is not necessary to configure an allowed directory for it.
45
Remote Upgrades
The remote upgrade feature allows you to deploy software upgrades automatically to a user-specified list of OpenDeploy base servers and receivers. This type of deployment relieves you of having to manually upgrade your OpenDeploy server individually, saving you large amounts of labor and time. Software upgrades can include new versions of OpenDeploy, service packs to existing versions, and patches. Remote upgrades use pre-configured deployments to perform the following tasks: Perform the software distribution - upgrade installation packages are deployed to the target server hosts, and run automatically to upgrade the existing software to the new desired version. License identification - information needed for the proper licensing of each target server is collected and combined into a .zip file. You then upload this license identification file to the Interwoven Support Web site as part of your request for the OpenDeploy server licenses associated for the upgraded servers. License distribution - deploy the licenses received from Interwoven. You can also place each license individually in target servers.
Prerequisites
The following prerequisites apply to your OpenDeploy servers participating in remote upgrades: The sending server must be release 6.1 or later. The target servers being upgraded must be release 5.6 or later. The upgrade must result in the target servers being release 6.1 or later. The server host must have a resolvable host name. You must perform the following prerequisite tasks before performing the upgrade deployment: Ensure each target server host is listed in the sending servers nodes configuration file (by default odnodes.xml). Refer to Defining Target Nodes on page 126 in the OpenDeploy Administration Guide for more information. Create a directory on the target servers host outside the od-home directory to which the sending server can deploy files. Update the configuration file of each target server to include the sending server host as an allowed host, and the directory you created in the previous step as an allowed directory. Refer to Specifying Allowed Hosts for Received Deployments on page 169 and Specifying Allowed Directories for Deployments on page 170 in the OpenDeploy Administration Guide for more information.
Interwoven, Inc.
46
Limitations
The following limitations apply to the remote upgrade feature: Only equivalent OpenDeploy software can be upgraded, for example, you can only upgrade a receiver to another receiver. You cannot upgrade a receiver to a base server. The target must be a standalone OpenDeploy installation, rather than an installation of Content Provisioning Solution (CPS). Administration package software cannot be upgraded using this method. Upgrade deployments using the routed deployment feature is not supported. Upgrade deployments using the multi-tiered deployment feature is not supported. Only the initial OpenDeploy instance of the sending server can be used to perform the upgrade deployment, and only the initial instance of the target server is restarted after the upgrade. If your remote upgrade targets include one or more OpenDeploy 5.6 servers, all configuration files associated with the remote upgrade, including licensing, must reside in the /conf directory, rather than their default deployment group locations. See Remote Upgrade Configuration File Location for OpenDeploy 5.6 Targets on page 57 for more information. The target host can have only one installation of an OpenDeploy base server or receiver. The remote upgrade feature is not supported on hosts that have both OpenDeploy 5.x and 6.x server software installed.
Suggested Best Practices

To help with the remote upgrade, the following best practices are recommended: To facilitate configuration of the sending server for the remote upgrade deployment, first collect the following information for each remote target. Host name Platform/operating system Base server or receiver Name of the temporary directory where the source will deploy the installation package and script On the sending server, ping each target to ensure network connectivity. Run the various remote upgrade deployments as non-transactional (this is the default configuration). This allows each target to be upgraded independently of the other targets. Any failed targets can be upgraded independently at a later time. Break down a large upgrade deployment into smaller deployments. For example, if you have a target upgrade farm of 50 servers, split the deployment into groups of 10 rather than trying to deploy to all the servers at the same time.
47
Upgrade Installation File Location

You must obtain the appropriate upgrade installation files and place them on the sending base server. By default, these files must reside in the following directory:
od-home/upgradeBits
You can specify an alternate location for the upgrade installation files by adding the upgradeBitsMap element to your sending base servers configuration file (by default odbase.xml). For example:
<deployServerConfiguration> ... <upgradeBitsMap ...> </deployServerConfiguration>
Specify the full path on your host where the upgrade installation files reside as the value for the upgradeBitsMap elements dirPath attribute, for example:
<upgradeBitsMap dirPath="/upgrades">
Specifying Shortened Upgrade File Names

By default, the browser-based user interface displays the full names of the upgrade installation package files. However, these can often be quite long, and may not be easily identifiable. For example, if you had the following upgrade installation file:
IWOVopendeployBaseFull.6.1.1.0.0.Build12345.Windows.exe
it might be easier if it appeared in the user interface as:

ODBase611
You can map individual shortened logical names to some or all of these files by adding the alias element as a child element of the upgradeBitsMap element, for example:
<upgradeBitsMap ...> <alias ...> </upgradeBitsMap>
The alias element contains the following attributes:

name - specifies the shortened logical name that is mapped to the actual upgrade installation file as specified by the relPath attribute value. For example: name="ODBase611" relPath - specifies the actual upgrade installation file and its path upgradeBitsMap elements dirPath attribute value of the upgrade
relative to the installation file.
For example:
relPath="IWOVopendeployBaseFull.6.1.1.0.0.Build12345.Windows.exe"
Interwoven, Inc.
48
You must specify a separate alias element for each upgrade installation file to which you want to assign a shortened name. For example:
<upgradeBitsMap ...> <alias name="ODBase611" relPath="IWOVopendeployBaseFull.6.1.1.0.0. Build12345.Windows.exe"/> <alias name="ODRcvr611" relPath="IWOVopendeployRcvr.6.1.1.0.0. Build12345.Windows.exe"/> </upgradeBitsMap>
If you want to assign short names to your upgrade installation files, but do not want to change their default location on the sending server, modify your base server configuration file with the upgradeBitsMap and alias elements as necessary, but omit the dirPath attribute.
Distributing the Target Server Software

Upgrading the OpenDeploy software on your targets requires you to configure a special software distribution deployment using the browser-based user interface. This deployment sends both the installation package file and a script to start and run the upgrade to each target. The upgrade is performed automatically using existing and default settings. No user input is required during these upgrades. Composing the deployment manually using a text or XML editor is not recommended. Your sending base servers nodes configuration file must have entries for all targets participating in the remote upgrade. Upgrades to OpenDeploy server software accept all default and existing settings, including the location of od-home, that were present in the current version. This is similar to performing an upgrade manually. If you want to change any settings, run the software distribution deployment and then change the settings of your OpenDeploy server as necessary. To run the software distribution deployment, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window (Figure 4). Figure 4 Remote Upgrade Window
2. Select the base server that will perform the software distribution deployment from the Selected Server list.
49
3. Select Software Distribution from the Configuration Type list to display the Remote Upgrade window for software distribution configurations (Figure 5). Figure 5 Remote Upgrade Window Software Distribution Configurations
This window displays a listing of any existing software distribution deployments, along with the ability to start, schedule, or view each one. 4. Click New Configuration. The window (Figure 6) is updated with items for you to complete that will determine how the software distribution deployment will be configured. Figure 6 Remote Upgrade Window Software Distribution Configurations (cont.)
It also contains a separate listing for each replication farm (with its member target nodes listed underneath) and individual target node present in your sending servers nodes configuration file. 5. Enter the name of the software distribution deployment in the Configuration Name box, for example, upgradeTest. 6. Select the software distribution installation file you want to deploy from the Upgrade Package list. The value you enter here is automatically applied to each target node listed. However, you can change this value for any individual listing. You can also leave this box unselected and select the upgrade package for each target node separately. 7. Enter the destination directory on the targets for the software installation file in the Target Directory box. The value you enter here is automatically applied to each target node listed. However, you can change this value for any individual listing. You can also leave this box empty and enter the target directory for each target node separately.
Interwoven, Inc.
50
8. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer to Chapter 8, Encryption in the OpenDeploy Administration Guide for more information. 9. Check the box in front of each target node listing to indicate that those targets are participating in the software distribution. Those node listings that are not checked will not receive the deployed software distribution installation file. At least one target node listing must be checked to generate the configuration file. 10. Click Save. The window reappears with your new software distribution configuration included in the list (Figure 7). Figure 7 Remote Upgrade Window Software Distribution Configurations (cont.)
The software distribution deployment configuration is generated and stored in the following location:
od-home/conf/softDist
In addition, the configuration files needed for acquiring information about the target nodes, and for distributing the licenses, are also created in the following locations, respectively:
od-home/conf/licID od-home/conf/licDist
Each of these locations includes an XML-based file with the same name as the one created in the od-home/conf/softDist directory. These will be used in later tasks. If any of the upgrade targets are OpenDeploy version 5.6, see Upgrading from OpenDeploy 5.6 on page 57 for additional information.
51
11. Click the Start button associated with the software distribution deployment you want to run. The Start Deployment window appears (Figure 8). Figure 8 Start Deployment Window
12. Click Start Deployment. The upgrade installation file is deployed to each target host listed in the deployment, along with a script that allows the installation file to begin running after it is deployed. 13. (Upgrades from OpenDeploy 5.6 on Windows only) Reboot your target server host. After deploying the installation file and script, a Deploy and Run script is invoked. The Deploy and Run first performs validation checks before the installation begins. If the validation is successful, the Deploy and Run then begins the installation. You can view details on how the upgrade performed in the sender and receiver target logs.
Monitoring the Upgrade

The sending server will periodically check the status of each target during the software distribution deployment. When the target returns the correct updated version, the software upgrade for that target is complete. You can specify the interval at which the sending server polls the status of the target by configuring the software distribution deployments getInfo element:
<execDeploymentTask ...> <getInfo maxInterations="20" checkIntervalInMins="2"> ... </getInfo> ... <execDeploymentTask ...>
The getInfo element contains the following attributes:

maxIterations - specify the number of times the target is to be polled for information before the deployment to that target quits. Default value is 20. checkIntervalInMins
- specify the amount of time in minutes between polling of the target. Default value is 2.
Interwoven, Inc.
52
Collecting License Information

After the software distribution deployment is run, if you want to obtain licenses for your target hosts, you can generate a license identification deployment for those targets that received the software distribution. The license identification deployment collects information regarding each target server required by Interwoven to issue the appropriate licenses for each target host. This information is packaged into a single file that you provide Interwoven in order to receive the appropriate licenses. At the time the software distribution deployment is generated, OpenDeploy also generates a corresponding license identification deployment in the following location:
od-home/conf/licID
The name of the license identification deployment in this directory is the same as the associated software distribution deployment. To run the license identification deployment, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window. 2. Select License Identification from the Configuration Type list to display the Remote Upgrade window for license identification configurations (Figure 9). Figure 9 Remote Upgrade Window License Identification Configurations
This window displays a listing of any existing license identification deployments, including the one generated automatically when you created the software distribution deployment. Here you can start, schedule, or view any of the ones listed by clicking the appropriate associated button. If you want to run the license identification deployment associated with the software distribution deployment you have already ran, click its associated Start button. The Start Deployment window appears, where you can run the license identification deployment as you would a regular deployment. The information collected is written to file odlicreq_datetimestamp.zip residing on the following location of the host running the deployment:
After you have run the license identification deployment, continue on starting with step 6 of Batch Server Activation on page 43.
53
Configuring a New License Identification Deployment

If you want to create a new license identification deployment, rather than using the one that is generating automatically with your software distribution deployment, you can do so by clicking the New Configuration button when in the Remote Upgrade window with the License Identification configuration type selected. When you click New Configuration, the window appears with a list of available targets (Figure 10). Figure 10 Remote Upgrade Window License Identification Configurations
To configure a new license identification deployment, follow these steps: 1. Enter a name for the license identification deployment in the Configuration Name box. 2. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer toChapter 8, Encryption in the OpenDeploy Administration Guide for more information. 3. Check those targets that you want included in your deployment. You must select at least one target. 4. Click Save. The original License Identification window reappears with your new license identification deployment included in the list. The license identification deployment is created in the following location:
od-home/conf/licID
An accompanying license distribution deployment configuration file with the same name is also generated automatically in the following location:
Interwoven, Inc.
54
Distributing Licenses
After you have run the license identification deployment and sent the collected information to the Interwoven Support Web site, you will receive the batch license file odbatchlic.zip. This file contains licenses for the OpenDeploy servers that were part of your license identification deployment. After you receive this file, place it in the following location:
You must run the license distributing deployment associated with your license identification deployment. This will deploy the license to each target and activate it. At the time a software distribution deployment configuration or a license identification deployment is generated, OpenDeploy also generates a corresponding license distribution deployment configuration in the following location:
The name of the license distribution deployment configuration file in this directory is the same as the associated software distribution or license identification deployment. To distribute the licenses, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window. 2. Select License Distribution from the Configuration Type list to display the Remote Upgrade window for license distribution configurations (Figure 11). Figure 11 License Distribution Window
The window displays a listing of any existing license distribution deployment configurations, including the one generated automatically when you created the software distribution or license identification deployment configuration file. Here you can start, schedule, or view any of the ones listed by clicking the appropriate associated button. If you want to run the license distribution deployment associated with the software distribution or license identification deployment you have already ran, click its associated Start button. The Start Deployment window appears, where you can run the license distribution deployment as you would a regular deployment. After the license distribution deployment is run, those targets that successfully received their license files are now fully operable.
55
Configuring a New License Distribution Deployment

If you want a new license distribution deployment configuration, rather than using the one that is generating automatically with your software distribution or license identification deployments, you can do so by clicking the New Configuration button when in the Remote Upgrade window with the License Distribution configuration type selected. When you click New Configuration, the License Distribution window displays a list of available targets (Figure 12). Figure 12 License Distribution Windows for New Configurations
To configure a new license distribution deployment, follow these steps: 1. Enter a name for the license distribution deployment in the Configuration Name box. 2. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer to Chapter 8, Encryption in the OpenDeploy Administration Guide for more information. 3. Check those targets that you want included in your license distribution deployment. You must select at least one target. 4. Click Save. The original License Distribution window reappears with your new license distribution deployment configuration included in the list. The new license distribution configuration file is created in the following location:
Interwoven, Inc.
56
Logging
The remote upgrade script which runs on each target host generates the log file od_remote_upgrade.log. This file contains entries detailing the upgrade including any errors. The od_remote_upgrade.log file resides in the following locations on each remote upgrade target host:
od-home/install
The directory on the target host that receives the deployed upgrade installation file.
Upgrading from OpenDeploy 5.6

The following sections apply to upgrades from OpenDeploy 5.6 to the current release. Upgrading from later OpenDeploy releases are not affected.
Reboot Required After Upgrade

You must reboot the host of an OpenDeploy 5.6 target server that was upgraded using remote upgrade.
Remote Upgrade Configuration File Location for OpenDeploy 5.6 Targets

If you are performing remote upgrades to OpenDeploy 5.6 targets, you must relocate your remote upgrade configuration files from their default locations: Software distribution - od-home/conf/softDist License identification - od-home/conf/licID License distribution - od-home/conf/licDist to the root deployment group (/conf) directory. This is because the use of deployment groups is not supported on OpenDeploy 5.x servers. This also requires you to manually change the names of any license identification and license distribution deployments that are configured automatically when you create software distribution or license identification deployments manually using the browser-based user interface. This is to avoid file name conflicts in the /conf directory. For example, if you create the software distribution configuration file upgrade.xml, then you could rename the generated files upgradeLicID.xml and upgradeLicDist.xml, or something similar. These requirements apply to remote upgrades of a mix of OpenDeploy 5.6 and 6.0.x targets, as well as just OpenDeploy 5.6 targets alone.
57
Performing Remote Upgrades on UNIX Target Hosts as a Non-Root User

You can perform remote upgrades of OpenDeploy software running on UNIX hosts as a non-root user. This procedure requires you to allow the OpenDeploy remote upgrade script unixupgrade.sh to run on the target UNIX host as root without requiring a password. To limit the security risk, you should configure the required Sudo access only for the duration of remote upgrade and promptly turn it off as soon as the remote upgrade is finished.
NOTE
You should exercise caution and understand the risks of this type of operation before beginning.
To perform remote upgrades on UNIX target hosts as a non-root user, follow these steps: 1. Configure a software distribution deployment as described in Distributing the Target Server Software on page 49. Ensure you have the appropriate permissions to write to the target directory specified in the deployment. 2. Install Sudo (superuser do) on each target host. This is free software available from the following Web site:
http://www.courtesan.com/sudo/
You must have root access on each target host to install and configure Sudo. 3. Open the software distribution deployment using your favorite text or XML editor. Each target has its own corresponding DeployNRun element. Within this DeployNRun element, there are two script elements, one for validation and one for remote installation. 4. Remove the following attribute and value from each of the script elements:
as="root"
5. Add the absolute path to the Sudo command to the beginning of each of the script elements cmd attribute value. For example:
cmd="/usr/local/bin/sudo /path/unixupgrade.sh VALIDATE /path/ IWOVopendeployBaseFull.6.1.1.0.0.Build55148.SunOS.tar.gz"
and
cmd="/usr/local/bin/sudo /path/unixupgrade.sh REMOTE_INSTALL /path/ IWOVopendeployBaseFull.6.1.1.0.0.Build55148.SunOS.tar.gz"
6. Save and close the file. 7. Configure Sudo on each target host to allow unixupgrade.sh to be run as root without requiring a password. Sudo is configured by modifying the /etc/sudoers file using the visudo command that comes with the sudo package.
Interwoven, Inc.
58
One method to configure the required access is by adding the following lines to the /etc/sudoers file:
User_Alias ODREMOTEUPGRADERS = user Cmnd_Alias ODREMOTEUPGRADE = /path/unixupgrade.sh ODREMOTEUPGRADERS targetHostName = (root) NOPASSWD: ODREMOTEUPGRADE
8. Run the software distribution deployment and verify that the target OpenDeploy servers have been successfully upgraded. 9. Reverse the changes made to the /etc/sudoers file so that a password is once again required. If you attempt to run a remote upgrade as a non-root user without performing the steps described in this section, the remote upgrade will fail. An error message will be entered in the od_remote_upgrade.log file. See Logging on page 57 for more information.
Expired License Behavior

Your OpenDeploy base server and receiver software will start up if your license is expired. However, the functionality of base servers and receivers is limited to receiving license identification and distribution deployments. Base servers running on expired licenses cannot start any deployments, including those related to licensing.
59
Interwoven, Inc.
60
Chapter 4
Remote Upgrades
This chapter describes how to configure your OpenDeploy base server to upgrade the software and licenses of its target servers. The remote upgrade feature allows you to deploy software upgrades automatically to a user-specified list of OpenDeploy base servers and receivers. This type of deployment relieves you of having to manually upgrade your OpenDeploy server individually, saving you large amounts of labor and time. Software upgrades can include new versions of OpenDeploy, service packs to existing versions, and patches. Remote upgrades use pre-configured deployments to perform the following tasks: Perform the software distribution - upgrade installation packages are deployed to the target server hosts, and run automatically to upgrade the existing software to the new desired version. License identification - information needed for the proper licensing of each target server is collected and combined into a .zip file. You then upload this license identification file to the Interwoven Support Web site as part of your request for the OpenDeploy server licenses associated for the upgraded servers. License distribution - deploy the licenses received from Interwoven. You can also place each license individually in target servers.
Prerequisites
The following prerequisites apply to your OpenDeploy servers participating in remote upgrades: The sending server must be release 6.1 or later. The target servers being upgraded must be release 5.6 or later. The upgrade must result in the target servers being release 6.1 or later. The server host must have a resolvable host name. You must perform the following prerequisite tasks before performing the upgrade deployment: Ensure each target server host is listed in the sending servers nodes configuration file (by default odnodes.xml). Refer to Defining Target Nodes on page 126 in the OpenDeploy Administration Guide for more information.
61
Chapter 4: Remote Upgrades
Create a directory on the target servers host outside the od-home directory to which the sending server can deploy files. Update the configuration file of each target server to include the sending server host as an allowed host, and the directory you created in the previous step as an allowed directory. Refer to Specifying Allowed Hosts for Received Deployments on page 169 and Specifying Allowed Directories for Deployments on page 170 in the OpenDeploy Administration Guide for more information.
Limitations
The following limitations apply to the remote upgrade feature: Only equivalent OpenDeploy software can be upgraded, for example, you can only upgrade a receiver to another receiver. You cannot upgrade a receiver to a base server. The target must be a standalone OpenDeploy installation, rather than an installation of Content Provisioning Solution (CPS). Administration package software cannot be upgraded using this method. Upgrade deployments using the routed deployment feature is not supported. Upgrade deployments using the multi-tiered deployment feature is not supported. Only the initial OpenDeploy instance of the sending server can be used to perform the upgrade deployment, and only the initial instance of the target server is restarted after the upgrade. If your remote upgrade targets include one or more OpenDeploy 5.6 servers, all configuration files associated with the remote upgrade, including licensing, must reside in the /conf directory, rather than their default deployment group locations. See Remote Upgrade Configuration File Location for OpenDeploy 5.6 Targets on page 73 for more information. The target host can have only one installation of an OpenDeploy base server or receiver. The remote upgrade feature is not supported on hosts that have both OpenDeploy 5.x and 6.x server software installed.
Interwoven, Inc.
62
Suggested Best Practices

To help with the remote upgrade, the following best practices are recommended: To facilitate configuration of the sending server for the remote upgrade deployment, first collect the following information for each remote target. Host name Platform/operating system Base server or receiver Name of the temporary directory where the source will deploy the installation package and script On the sending server, ping each target to ensure network connectivity. Run the various remote upgrade deployments as non-transactional (this is the default configuration). This allows each target to be upgraded independently of the other targets. Any failed targets can be upgraded independently at a later time. Break down a large upgrade deployment into smaller deployments. For example, if you have a target upgrade farm of 50 servers, split the deployment into groups of 10 rather than trying to deploy to all the servers at the same time.
Preparation for Remote Upgrades

This section describes different preparation tasks you can use for your remote upgrade.
Upgrade Installation File Location

You must obtain the appropriate upgrade installation files and place them on the sending base server. By default, these files must reside in the following directory:
od-home/upgradeBits
You can specify an alternate location for the upgrade installation files by adding the upgradeBitsMap element to your sending base servers configuration file (by default odbase.xml). For example:
<deployServerConfiguration> ... <upgradeBitsMap ...> </deployServerConfiguration>
Specify the full path on your host where the upgrade installation files reside as the value for the upgradeBitsMap elements dirPath attribute, for example:
<upgradeBitsMap dirPath="/upgrades">
63
Specifying Shortened Upgrade File Names

By default, the browser-based user interface displays the full names of the upgrade installation package files. However, these can often be quite long, and may not be easily identifiable. For example, if you had the following upgrade installation file:
IWOVopendeployBaseFull.6.1.1.0.0.Build12345.Windows.exe
it might be easier if it appeared in the user interface as:

ODBase611
You can map individual shortened logical names to some or all of these files by adding the alias element as a child element of the upgradeBitsMap element, for example:
<upgradeBitsMap ...> <alias ...> </upgradeBitsMap>
The alias element contains the following attributes:

name - specifies the shortened logical name that is mapped to the actual upgrade installation file as specified by the relPath attribute value. For example: name="ODBase611" relPath - specifies the actual upgrade installation file and its path upgradeBitsMap elements dirPath attribute value of the upgrade
relative to the installation file.
For example:
relPath="IWOVopendeployBaseFull.6.1.1.0.0.Build12345.Windows.exe"
You must specify a separate alias element for each upgrade installation file to which you want to assign a shortened name. For example:
<upgradeBitsMap ...> <alias name="ODBase611" relPath="IWOVopendeployBaseFull.6.1.1.0.0. Build12345.Windows.exe"/> <alias name="ODRcvr611" relPath="IWOVopendeployRcvr.6.1.1.0.0. Build12345.Windows.exe"/> </upgradeBitsMap>
If you want to assign short names to your upgrade installation files, but do not want to change their default location on the sending server, modify your base server configuration file with the upgradeBitsMap and alias elements as necessary, but omit the dirPath attribute.
Interwoven, Inc.
64
Distributing the Target Server Software

Upgrading the OpenDeploy software on your targets requires you to configure a special software distribution deployment using the browser-based user interface. This deployment sends both the installation package file and a script to start and run the upgrade to each target. The upgrade is performed automatically using existing and default settings. No user input is required during these upgrades. Composing the deployment manually using a text or XML editor is not recommended. Your sending base servers nodes configuration file must have entries for all targets participating in the remote upgrade. Upgrades to OpenDeploy server software accept all default and existing settings, including the location of od-home, that were present in the current version. This is similar to performing an upgrade manually. If you want to change any settings, run the software distribution deployment and then change the settings of your OpenDeploy server as necessary. To run the software distribution deployment, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window (Figure 13). Figure 13 Remote Upgrade Window
2. Select the base server that will perform the software distribution deployment from the Selected Server list. 3. Select Software Distribution from the Configuration Type list to display the Remote Upgrade window for software distribution configurations (Figure 14). Figure 14 Remote Upgrade Window Software Distribution Configurations
This window displays a listing of any existing software distribution deployments, along with the ability to start, schedule, or view each one.
65
4. Click New Configuration. The window (Figure 15) is updated with items for you to complete that will determine how the software distribution deployment will be configured. Figure 15 Remote Upgrade Window Software Distribution Configurations (cont.)
It also contains a separate listing for each replication farm (with its member target nodes listed underneath) and individual target node present in your sending servers nodes configuration file. 5. Enter the name of the software distribution deployment in the Configuration Name box, for example, upgradeTest. 6. Select the software distribution installation file you want to deploy from the Upgrade Package list. The value you enter here is automatically applied to each target node listed. However, you can change this value for any individual listing. You can also leave this box unselected and select the upgrade package for each target node separately. 7. Enter the destination directory on the targets for the software installation file in the Target Directory box. The value you enter here is automatically applied to each target node listed. However, you can change this value for any individual listing. You can also leave this box empty and enter the target directory for each target node separately. 8. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer to Chapter 8, Encryption in the OpenDeploy Administration Guide for more information. 9. Check the box in front of each target node listing to indicate that those targets are participating in the software distribution. Those node listings that are not checked will not receive the deployed software distribution installation file. At least one target node listing must be checked to generate the configuration file.
Interwoven, Inc.
66
10. Click Save. The window reappears with your new software distribution configuration included in the list (Figure 16). Figure 16 Remote Upgrade Window Software Distribution Configurations (cont.)
The software distribution deployment configuration is generated and stored in the following location:
od-home/conf/softDist
In addition, the configuration files needed for acquiring information about the target nodes, and for distributing the licenses, are also created in the following locations, respectively:
od-home/conf/licID od-home/conf/licDist
Each of these locations includes an XML-based file with the same name as the one created in the od-home/conf/softDist directory. These will be used in later tasks. If any of the upgrade targets are OpenDeploy version 5.6, see Upgrading from OpenDeploy 5.6 on page 73 for additional information. 11. Click the Start button associated with the software distribution deployment you want to run. The Start Deployment window appears (Figure 17). Figure 17 Start Deployment Window
12. Click Start Deployment. The upgrade installation file is deployed to each target host listed in the deployment, along with a script that allows the installation file to begin running after it is deployed. 13. (Upgrades from OpenDeploy 5.6 on Windows only) Reboot your target server host. After deploying the installation file and script, a Deploy and Run script is invoked. The Deploy and Run first performs validation checks before the installation begins. If the validation is successful, the Deploy and Run then begins the installation. You can view details on how the upgrade performed in the sender and receiver target logs.
67
Monitoring the Upgrade

The sending server will periodically check the status of each target during the software distribution deployment. When the target returns the correct updated version, the software upgrade for that target is complete. You can specify the interval at which the sending server polls the status of the target by configuring the software distribution deployments getInfo element:
<execDeploymentTask ...> <getInfo maxInterations="20" checkIntervalInMins="2"> ... </getInfo> ... <execDeploymentTask ...>
The getInfo element contains the following attributes:

maxIterations - specify the number of times the target is to be polled for information before the deployment to that target quits. Default value is 20. checkIntervalInMins
- specify the amount of time in minutes between polling of the target. Default value is 2.
Collecting License Information

After the software distribution deployment is run, if you want to obtain licenses for your target hosts, you can generate a license identification deployment for those targets that received the software distribution. The license identification deployment collects information regarding each target server required by Interwoven to issue the appropriate licenses for each target host. This information is packaged into a single file that you provide Interwoven in order to receive the appropriate licenses. At the time the software distribution deployment is generated, OpenDeploy also generates a corresponding license identification deployment in the following location:
od-home/conf/licID
The name of the license identification deployment in this directory is the same as the associated software distribution deployment. To run the license identification deployment, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window.
Interwoven, Inc.
68
2. Select License Identification from the Configuration Type list to display the Remote Upgrade window for license identification configurations (Figure 18). Figure 18 Remote Upgrade Window License Identification Configurations
This window displays a listing of any existing license identification deployments, including the one generated automatically when you created the software distribution deployment. Here you can start, schedule, or view any of the ones listed by clicking the appropriate associated button. If you want to run the license identification deployment associated with the software distribution deployment you have already ran, click its associated Start button. The Start Deployment window appears, where you can run the license identification deployment as you would a regular deployment. The information collected is written to file odlicreq_datetimestamp.zip residing on the following location of the host running the deployment:
After you have run the license identification deployment, continue on starting with step 6 of Batch Server Activation on page 43.
69
Configuring a New License Identification Deployment

If you want to create a new license identification deployment, rather than using the one that is generating automatically with your software distribution deployment, you can do so by clicking the New Configuration button when in the Remote Upgrade window with the License Identification configuration type selected. When you click New Configuration, the window appears with a list of available targets (Figure 19). Figure 19 Remote Upgrade Window License Identification Configurations
To configure a new license identification deployment, follow these steps: 1. Enter a name for the license identification deployment in the Configuration Name box. 2. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer to Chapter 8, Encryption in the OpenDeploy Administration Guide for more information. 3. Check those targets that you want included in your deployment. You must select at least one target. 4. Click Save. The original License Identification window reappears with your new license identification deployment included in the list. The license identification deployment is created in the following location:
od-home/conf/licID
An accompanying license distribution deployment configuration file with the same name is also generated automatically in the following location:
Interwoven, Inc.
70
Distributing Licenses
After you have run the license identification deployment and sent the collected information to the Interwoven Support Web site, you will receive the batch license file odbatchlic.zip. This file contains licenses for the OpenDeploy servers that were part of your license identification deployment. After you receive this file, place it in the following location:
You must run the license distributing deployment associated with your license identification deployment. This will deploy the license to each target and activate it. At the time a software distribution deployment configuration or a license identification deployment is generated, OpenDeploy also generates a corresponding license distribution deployment configuration in the following location:
The name of the license distribution deployment configuration file in this directory is the same as the associated software distribution or license identification deployment. To distribute the licenses, follow these steps: 1. Select Servers > Remote Upgrade to display the Remote Upgrade window. 2. Select License Distribution from the Configuration Type list to display the Remote Upgrade window for license distribution configurations (Figure 20). Figure 20 License Distribution Window
The window displays a listing of any existing license distribution deployment configurations, including the one generated automatically when you created the software distribution or license identification deployment configuration file. Here you can start, schedule, or view any of the ones listed by clicking the appropriate associated button. If you want to run the license distribution deployment associated with the software distribution or license identification deployment you have already ran, click its associated Start button. The Start Deployment window appears, where you can run the license distribution deployment as you would a regular deployment. After the license distribution deployment is run, those targets that successfully received their license files are now fully operable.
71
Configuring a New License Distribution Deployment

If you want a new license distribution deployment configuration, rather than using the one that is generating automatically with your software distribution or license identification deployments, you can do so by clicking the New Configuration button when in the Remote Upgrade window with the License Distribution configuration type selected. When you click New Configuration, the License Distribution window displays a list of available targets (Figure 21). Figure 21 License Distribution Windows for New Configurations
To configure a new license distribution deployment, follow these steps: 1. Enter a name for the license distribution deployment in the Configuration Name box. 2. Select one of the following options from the Encryption list: None - no encryption. SSL - secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File - weak (40-bit) symmetric key file-based encryption. Refer to Chapter 8, Encryption in the OpenDeploy Administration Guide for more information. 3. Check those targets that you want included in your license distribution deployment. You must select at least one target. 4. Click Save. The original License Distribution window reappears with your new license distribution deployment configuration included in the list. The new license distribution configuration file is created in the following location:
Interwoven, Inc.
72
Logging
The remote upgrade script which runs on each target host generates the log file od_remote_upgrade.log. This file contains entries detailing the upgrade including any errors. The od_remote_upgrade.log file resides in the following locations on each remote upgrade target host:
od-home/install
The directory on the target host that receives the deployed upgrade installation file.
Upgrading from OpenDeploy 5.6

The following sections apply to upgrades from OpenDeploy 5.6 to the current release. Upgrading from later OpenDeploy releases are not affected.
Reboot Required After Upgrade

You must reboot the host of an OpenDeploy 5.6 target server that was upgraded using remote upgrade.
Remote Upgrade Configuration File Location for OpenDeploy 5.6 Targets

If you are performing remote upgrades to OpenDeploy 5.6 targets, you must relocate your remote upgrade configuration files from their default locations: Software distribution - od-home/conf/softDist License identification - od-home/conf/licID License distribution - od-home/conf/licDist to the root deployment group (/conf) directory. This is because the use of deployment groups is not supported on OpenDeploy 5.x servers. This also requires you to manually change the names of any license identification and license distribution deployments that are configured automatically when you create software distribution or license identification deployments manually using the browser-based user interface. This is to avoid file name conflicts in the /conf directory. For example, if you create the software distribution configuration file upgrade.xml, then you could rename the generated files upgradeLicID.xml and upgradeLicDist.xml, or something similar.
73
These requirements apply to remote upgrades of a mix of OpenDeploy 5.6 and 6.0.x targets, as well as just OpenDeploy 5.6 targets alone.
Remote Upgrades on UNIX Target Hosts as a Non-Root User

You can perform remote upgrades of OpenDeploy software running on UNIX hosts as a non-root user. This procedure requires you to allow the OpenDeploy remote upgrade script unixupgrade.sh to run on the target UNIX host as root without requiring a password. To limit the security risk, you should configure the required Sudo access only for the duration of remote upgrade and promptly turn it off as soon as the remote upgrade is finished.
NOTE
You should exercise caution and understand the risks of this type of operation before beginning.
To perform remote upgrades on UNIX target hosts as a non-root user, follow these steps: 1. Configure a software distribution deployment as described in Distributing the Target Server Software on page 65. Ensure you have the appropriate permissions to write to the target directory specified in the deployment. 2. Install Sudo (superuser do) on each target host. This is free software available from the following Web site:
http://www.courtesan.com/sudo/
You must have root access on each target host to install and configure Sudo. 3. Open the software distribution deployment using your favorite text or XML editor. Each target has its own corresponding DeployNRun element. Within this DeployNRun element, there are two script elements, one for validation and one for remote installation. 4. Remove the following attribute and value from each of the script elements:
as="root"
5. Add the absolute path to the Sudo command to the beginning of each of the script elements cmd attribute value. For example:
cmd="/usr/local/bin/sudo /path/unixupgrade.sh VALIDATE /path/ IWOVopendeployBaseFull.6.1.1.0.0.Build55148.SunOS.tar.gz"
and
cmd="/usr/local/bin/sudo /path/unixupgrade.sh REMOTE_INSTALL /path/ IWOVopendeployBaseFull.6.1.1.0.0.Build55148.SunOS.tar.gz"
6. Save and close the file.
Interwoven, Inc.
74
7. Configure Sudo on each target host to allow unixupgrade.sh to be run as root without requiring a password. Sudo is configured by modifying the /etc/sudoers file using the visudo command that comes with the sudo package. One method to configure the required access is by adding the following lines to the /etc/sudoers file:
User_Alias ODREMOTEUPGRADERS = user Cmnd_Alias ODREMOTEUPGRADE = /path/unixupgrade.sh ODREMOTEUPGRADERS targetHostName = (root) NOPASSWD: ODREMOTEUPGRADE
8. Run the software distribution deployment and verify that the target OpenDeploy servers have been successfully upgraded. 9. Reverse the changes made to the /etc/sudoers file so that a password is once again required. If you attempt to run a remote upgrade as a non-root user without performing the steps described in this section, the remote upgrade will fail. An error message will be entered in the od_remote_upgrade.log file. See Logging on page 73 for more information.
75
Interwoven, Inc.
76
Index
A
administration package 10 installation 22, 27 administration server 11 installation 15 software 10 Tomcat server 11 uninstallation 37 alias element 48, 64 attributes checkIntervalInMins 52, 68 dirPath 48, 63 maxIterations 52, 68 name (alias) 48, 64 relPath 48, 64 alias 48, 64 upgradeBitsMap 48, 63
I
installation 10, 19, 27 administration package 10, 22, 27 administration server 10, 15 base server 10, 13, 20, 25 ContentServices Access Service 24 ContentServices Foundation Access Service 28 ContentServices Foundation access service 10, 12, 15 DOS-compatible 8.3 format 16 home values 35 information requirements 13 multiple releases 34 order 35 platform-specific requirements 29 receiver 10, 14, 22, 27 reporting server 10, 15 Tomcat server 11 UNIX 25 upgrades 30 Windows 19
B
base server 10 installation 13, 20, 25 license types 14 software 10 uninstallation 38 bootstrap administrator 25, 29
C
checkIntervalInMins attribute 52, 68 ContentServices Access Service installation 24 ContentServices Foundation Access Service installation 28 ContentServices Foundation access service 38 installation 12, 15 non-default port configuration 16 software 10 uninstallation 38
L
licensing 39, 40, 41 add-on modules 40 administration package 40 base server 40 batch 43 cluster 41 distribution 45 EasyDeploy 40 expired 59 multiple host names 41 receiver 40 requests 44 single 42 software activation 39
D
dirPath attribute 48, 63
E
EasyDeploy 14, 40 elements
M
maxIterations attribute 52, 68
77
Index
N
name (alias) attribute 48, 64
T
target servers installation 10 Tomcat server installation 11
O
OpenDeploy administration server 11 base server 10 configuration 19 home values 35 installation 10, 19, 25, 35 licensing 41 multiple releases 34 receiver 10 reporting server 12 uninstalling 35 upgrades 30 OpenDeploy licensing 39, 40 OpenDeploy Release Notes 9
U
uninstallation 35 administration server 37 base server 38 receiver 38 UNIX 37 Windows 36 upgradeBitsMap element 48, 63 upgrades 30 configuration files 31 DAS and database deployments 32 event reporting 32 home values, updating 33 multiple instances 32 non-Administrator 31 non-root 31 operations server 33 previous releases 30 remote 46, 61 reporting server 32
R
receiver 10 installation 10, 14, 22, 27 uninstallation 38 relPath attribute 48, 64 remote upgrades 46, 61 best practices 47, 63 installation file location 48, 63 license distribution 55, 71 license requests 53, 68 limitations 47, 62 logging 57, 73 monitoring 52, 68 non-root user 58, 74 OpenDeploy 5.6 57, 73 preparation 63 prerequisites 46, 61 short names, specifying 48, 64 target software, distributing 49, 65 reporting server 12 installation 15 software 10 upgrades 32 RMI registry service 16
S
software activation 39 source servers installation 10
Interwoven, Inc.
78

OpenDeploy Installation Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OpenDeploy Installation Guide

Uploaded by

Copyright:

Available Formats

OpenDeploy