Professional Documents
Culture Documents
Version 7.2
13 August 2010
Copyright Notice
Notice
This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this documentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability is assumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation. The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner. This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations are strictly coincidental.
Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referenced herein are trademarks of Microsoft Corporation. UNIX is a registered trademark of The Open Group. AvantGo is a trademark of AvantGo, Inc. Epicentric Foundation Server is a trademark of Epicentric, Inc. Documentum and eRoom are trademarks of Documentum, a division of EMC Corp. FileNet is a trademark of FileNet Corporation. Lotus Notes is a trademark of Lotus Development Corporation. mySAP Enterprise Portal is a trademark of SAP AG. Oracle is a trademark of Oracle Corporation. Adobe is a trademark of Adobe Systems Incorporated. Novell is a trademark of Novell, Inc. Stellent is a trademark of Stellent, Inc. All other trademarks are the property of their respective owners.
Contents
7 9 11
Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 1:
Preparation
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OpenDeploy Software Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Base and Receiver Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administration Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Report Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ContentServices Foundation Access Service Software. . . . . . . . . . . . . . . . . . . . Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Base Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administration Package Placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administration and Report Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ContentServices Foundation Access Service . . . . . . . . . . . . . . . . . . . . . . . . . . . RMI Registry Service Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enable DOS-Compatible 8.3 Format File Names for Windows . . . . . . . . . . . . . Port Requirements for Firewall Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
13 14 14 15 16 16 16 17 18 18 19 19 20 20 21
Chapter 2:
Installation
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Base Server Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Receiver Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Administration Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the ContentServices Access Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Bootstrap Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Base Server Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Receiver Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the Administration Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
23 24 26 27 29 31 31 31 33 33
3
Contents
Install the ContentServices Foundation Access Service . . . . . . . . . . . . . . . . . . . Configure the Bootstrap Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Platform-Specific Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade from a Previous Release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CAP Solution-based OpenDeploy is Not Upgradable . . . . . . . . . . . . . . . . . . . . Changes to DataDeploy Module Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade the Default Report Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enable DAS after Updating OpenDeploy and TeamSite . . . . . . . . . . . . . . . . . . Administration Package Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Update the OpenDeploy Home Value in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . Install Multiple Releases of OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure OpenDeploy Home Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Platform-Specific Installation, Upgrades, and Configuration . . . . . . . . . . . . . . . . . Red Hat Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SuSE Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstall OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34 35 36 36 36 39 40 40 41 44 44 45 46 46 47 47 48 50 52 52 53
Chapter 3:
License
License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Base Server License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Receiver License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administration Package License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DataDeploy Module License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . License Hosts with Multiple Host Names and Interfaces . . . . . . . . . . . . . . . . . . License Cluster Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . License OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Single License Activation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Batch Server Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expired License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
57 58 58 58 58 59 59 59 59 61 63
Chapter 4:
Remote Upgrades
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preparation for Remote Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade Installation File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify Short Upgrade File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Distribute the Target Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Monitor the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Collect License Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure a New License Identification Deployment. . . . . . . . . . . . . . . . . . . . .
65
66 66 67 68 68 68 69 73 73 75
Contents
Distribute Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure a New License Distribution Deployment. . . . . . . . . . . . . . . . . . . . . . Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote Upgrades on UNIX Target Hosts as a Non-Root User . . . . . . . . . . . . . . . .
76 77 78 78
Chapter 5: Index
81 83
Contents
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
Base Server Installation Program ............................................................................... 25 Administration Package Installation Program ............................................................. 28 Introduction ................................................................................................................. 29 ContentServices Foundation License Agreement....................................................... 30 Remote Upgrade dialog box ....................................................................................... 70 Remote Upgrade dialog boxSoftware Distribution Configurations .......................... 70 Remote Upgrade dialog boxSoftware Distribution Configurations (2) ..................... 71 Remote Upgrade dialog boxSoftware Distribution Configurations (3) ..................... 72 Start Deployment dialog box....................................................................................... 72 Remote Upgrade dialog boxLicense Identification Configurations.......................... 74 Remote Upgrade dialog boxLicense Identification Configurations (2) .................... 75 License Distribution dialog box ................................................................................... 76 New License Distribution Configurations dialog box ................................................... 77
Procedures
To check for DOS-compatible 8.3 format file names ...................................................................20 To install the base server software on a Windows host ................................................................24 To install the administration package on a Windows host ...........................................................27 To install the ContentServices Access Service .............................................................................30 To install the base server package on a UNIX host ......................................................................32 To install the administration package on a UNIX host .................................................................33 To install the CSF software on UNIX from the command-line ....................................................34 To configure your upgraded OpenDeploy server for database deployments ...............................38 To use a third-party database for reporting ...................................................................................39 To enable DAS for use with OpenDeploy 7.2.0 and TeamSite 7.2.0 or higher ...........................41 To enable DAS with OpenDeploy 7.0, but not TeamSite 7.1.0 ...................................................42 To install OpenDeploy on 64-bit Red Hat Linux .........................................................................47 To create a symbolic link to the stdc++ libraries ..........................................................................48 To start and stop OpenDeploy ......................................................................................................48 To configure SuSE Linux after installing OpenDeploy on the SuSE Linux host .........................48 To install OpenDeploy on a 64-bit version of SuSE Linux ..........................................................49 To uninstall each OpenDeploy software component from Windows ...........................................52 To uninstall the OpenDeploy software on a Windows server ......................................................53 To uninstall each OpenDeploy software component on a UNIX host ..........................................53 To uninstall the administration server on a UNIX host ................................................................54 To uninstall the base server or receiver software on a UNIX host ...............................................54 To uninstall the CSF access server software on a UNIX host ......................................................55 To activate a single OpenDeploy server .......................................................................................59 To request licenses for the batch server activation .......................................................................61 To distribute the licenses ..............................................................................................................62 To run the software distribution deployment ................................................................................70 To run the license identification deployment ...............................................................................74 To configure a new license identification deployment .................................................................75 To distribute the licenses ..............................................................................................................76 To configure a new license distribution deployment ....................................................................77 To perform remote upgrades on UNIX target hosts as a non-root user ........................................79
OpenDeploy Installation Guide 9
To resolve cannot OpenDeploy UI and Web services URL in the same login session ............81 To uninstall the CSF software on a SuSE Enterprise Linux 9.0 host ...........................................82 To install, uninstall, or upgrade OpenDeploy on Windows .........................................................82 To remedy host failure due to insufficient disk storage ................................................................82
Intended Audience
This guide is for personnel who install and configure the OpenDeploy software. If you use OpenDeploy in conjunction with TeamSite, you should also know the TeamSite functionality and terminology. Many of the operations described in this guide 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 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. The term UNIX indicates any supported flavor of the UNIX operating system. 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
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 guide should be familiar with basic UNIX commands and be able to use an editor such as emacs or vi.
11
It is also helpful to be familiar with regular expression syntax. If you are not familiar with regular expressions, refer to a reference such as, Mastering Regular Expressions by Jeffrey Friedl.
Notation Conventions
This guide 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/index.html
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.
12
Chapter 1
Preparation
This chapter describes the installed components of the OpenDeploy software, and provides information to help you install your software successfully. The major topics in this chapter are:
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 Update requirements Supported browsers Certified reporting server databases Compatibility between OpenDeploy releases Compatibility between OpenDeploy and other Autonomy Interwoven products Supplemental information regarding installation on particular operating systems
13
Chapter 1: Preparation
Base server software is the software that controls the management of deployments on the source server. This software permits the OpenDeploy server to send and receive deployed files. Receiver software 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 contains the following components:
Administration server software for managing and generating the user interface Reporting server software for managing the storage and publication of event-based reports ContentServices Foundation access service for authenticating individuals who access OpenDeploy base servers or receivers through the browser-based user interface or Web services.
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 or 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 no need to install both software components on the same server. During installation, you receive a prompt to designate the parent directory for the base server or receiver software. The installer creates the following home directory:
parent_directory/OpenDeployNG
14
On Windows hosts, the default parent directory is: C:\Interwoven, however, you can select another parent directory. On UNIX, you must select the parent directory. The following locations are typical home directories for the base server or receiver software:
The base server or receiver home directory is indicated in this guide by the term:
od-home
On Windows hosts, the default parent directory is C:\Interwoven, however, you can select another parent directory. On UNIX, you must select the parent directory. The following locations are typical home directories for the administration server software:
The administration server home directory is indicated in this guide by the term:
admin-home
NOTE
If Administration Console is installed on your system, you need not install the standalone OpenDeploy Administration package as OpenDeploy Administration is handled by Administration Console.
The Tomcat server is one component of the administration server. The Tomcat server helps to 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.
15
Chapter 1: Preparation
On Windows hosts, the default parent directory is C:\Interwoven, however, you can select another parent directory. On UNIX, you must select the parent directory. The following locations are typical home directories for the administration server software:
The administration server home directory is indicated in this guide by the term:
csf-home
Installation Prerequisites
The next 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.
16
Installation Prerequisites
Base Server
Installation of the base server software includes the following tasks:
accepting the license agreement. specifying where to install the base server software. You can accept the default installation location or specify another. specifying the port number for RMI registry service. The default port number is 9173. To avoid conflicts with the RMI registry service, Autonomy strongly recommends not to include non-Autonomy Interwoven applications that may need to use these ports in your OpenDeploy environment. specifying the listening port number for incoming deployments. The default port number is 20014. deciding whether to enable the report feature. By default, the setting is enabled. selecting 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. The bootstrap administrator can subsequently create other users with access to the server. indicating the user name and domain (Windows only) assigned to the bootstrap administrator. By default, the following values listed as bootstrap users:
Any additional user name and domain you enter is added as the bootstrap administrator to the service configuration file (deploy.cfg) of the OpenDeploy server.
License Types
When you first install the base server software, you have full use of its features and functionality for 30 days, however, after that time you must provide the appropriate license to use it. You can provide one of the following license types:
Full: the full-featured version without a time limit. EasyDeploy: a restricted-feature version that you can use without a time limit. EasyDeploy is sometimes included as part of other Autonomy Interwoven products. EasyDeploy does not support the following OpenDeploy features and functions:
17
Chapter 1: Preparation
secure data transfer multiple base server instances on one host use of delivery adapters use of payload adapters
See License on page 57 for more information on licensing your base server.
Receiver
Installation of the receiver software includes the following tasks:
accepting the license agreement. specifying where to install the receiver software. You can accept the default installation location or specify another. specifying the port number for RMI registry service. The default port number is 9173. To avoid conflicts with the RMI registry service, Autonomy Interwoven strongly recommends not include to non-Autonomy Interwoven applications that may need to use these ports in your OpenDeploy environment. specifying the port number for incoming deployments. The default port number is 20014. deciding whether to enable the report feature. The default setting is disabled. indicating the user name and domain (Windows only) assigned to the bootstrap administrator. This user and domain are 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. The bootstrap administrator can subsequently create other users with access to the server. (Windows only) specifying the location for the TMP system environmental variable.
18
Installation Prerequisites
specifying where to install the administration server software. You can accept the default installation location or specify another. 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 in the OpenDeploy Administration Guide for more information.
machines 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 to use the OpenDeploy browser-based user interface. machines that are accessed through a Web services client program
Any instances of the OpenDeploy base server or receiver operating under these conditions that you subsequently create on the host must also have the key file added to it. Refer to Access Service Management in the OpenDeploy Administration Guide for more information. Refer to the ContentServices Foundation access service documentation for more information on installation and generation of the key file.
19
Chapter 1: Preparation
The following item appears in the Name column as part of the contents of the FileSystem folder on the right pane of the Registry Editor:
NtfsDisable8Dot3NameCreation
If DOS-compatible 8.3 format file names support is enabled, the corresponding value displays in the Data column: 0x00000000 (0). No further modification is required and you can close the Registry Editor. If DOS-compatible 8.3 format filenames support is disabled, the displayed value is: 0x00000001 (1). In this case, you must continue with the following steps to enable the DOS-compatible 8.3 format file names. 4. Select the NtfsDisable8Dot3NameCreation entry, and select Edit > Modify to open the Edit DWORD Value dialog box.
20
Installation Prerequisites
5. Change the value from 1 to 0 in the Value data box and click the OK. This setting enables the feature, which is indicated by the corresponding Data column value in the Registry Editor as 0x00000000 (0). No further modification is necessary. 6. Close the Registry Editor.
21
Chapter 1: Preparation
22
Chapter 2
Installation
This chapter describes the installation procedure for your OpenDeploy software. Install the appropriate components, one at a time, on the servers that make up your OpenDeploy environment. See OpenDeploy Software Components on page 14 to determine the requirements for each component. Refer to the OpenDeploy Release Notes for any additional information regarding installing your OpenDeploy software before going further. The major topics in this chapter are:
Windows UNIX Platform-Specific Installation Requirements Upgrade OpenDeploy Install Multiple Releases of OpenDeploy Platform-Specific Installation, Upgrades, and Configuration Uninstall OpenDeploy
Windows
Installation of OpenDeploy on a Windows host requires completing the following tasks:
ensuring that the DOS-compatible 8.3 format file names feature is enabled, and if necessary, enabling it. See Enable DOS-Compatible 8.3 Format File Names for Windows on page 20 for more information. installing the base server or receiver software
23
Chapter 2: Installation
installing the administration package, which includes the administration server and reporting server software.
You must have Administrator privileges to install OpenDeploy on your Windows server. Close all other programs before installing OpenDeploy software. You must close the Services window (not just minimize it) before installing OpenDeploy on a Windows host. Otherwise, the Windows registry keys are not updated properly.
CAUTION
Before installing or upgrading OpenDeploy 7.2.0, verify that Microsoft Visual C++ 2005 C Runtime is installed on the Windows machine. Search for msvcr80.dll in the C:\<WINDOWS_HOME> directory. If it is not installed, download and install the Microsoft Visual C++ 2005 Redistributable Package from http://www.microsoft.com/downloads/
details.aspx?FamilyId=32BC1BEE-A3F9-4C13-9C99-220B62A191EE&displaylang=en
Upgrade to the current release. See Upgrade OpenDeploy on page 36 for more information on upgrades. Keep your existing OpenDeploy 6.x base server installation intact (if your release is supported) and install the current release to a different location on your host. See Install Multiple Releases of OpenDeploy on page 45 for more information.
To install the base server software on a Windows host 1. Navigate to the working directory that contains the appropriate base server installation file:
IWOVOpenDeployBaseFull-Windows-7.x.x.exe
24
Windows
2. Double-click the installation file to start the installation (see Figure 1). Figure 1 Base Server Installation Program
3. Click Next. 4. Read the license agreement and click Yes to accept its conditions. Clicking No quits the installation program. 5. Select the parent directory for where to install the base server software and click Next. The default location is:
C:\Interwoven
After installation, the base server software resides in the following location:
parent-dir\OpenDeployNG
NOTE
The installation directory path cannot contain any multibyte characters. Use only single-byte characters. 6. Type the port number for the RMI registry in the Registry box. The default value is 9173. 7. Type the listening port number for incoming deployment in the Deploy box. The default value is 20014. Click Next. 8. Click Enable (default) or Disable to indicate whether you want the base server to broadcast event reporting. Click Next.
25
Chapter 2: Installation
If you select Enable, go to the next step. Otherwise, skip to step 11. 9. Click Windows or UNIX to indicate the operating system. This step determines the format of the bootstrap administrator. Click Next. The Bootstrap User Information dialog box opens. 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 choose, the following default bootstrap administrator user values display:
To specify an additional bootstrap administration user displayed, go to step 10. To use the default bootstrap administrator (as shown), click Next and skip step 10. 10. (If you specify your own bootstrap administrator user, type the bootstrap name in the Name box, and (if necessary, the domain to which it belongs) in the Domain box. Click Next. 11. Verify the settings in the Summary Report dialog box 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:
C:\Interwoven\OpenDeployNG
Upgrade to the current release. See Upgrade OpenDeploy on page 36 for more information on upgrades. Keep your existing legacy receiver installation intact (if your release is supported), and install this release to a different location on your host. Refer to Running Multiple Releases of OpenDeploy in the OpenDeploy Release Notes for more information.
26
Windows
Installation of the receiver software is similar 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-Windows-7.x.x.exe, where x.x indicates the product release number, to start the installation program. Follow the installation instructions described in Install the Base Server Software on page 24 to install the receiver software. You cannot install the receiver software on a host that already has base server software installed.
27
Chapter 2: Installation
2. Double-click the installation file to start the installation program (see Figure 2). Figure 2 Administration Package Installation Program
3. Click Next. 4. Read the license agreement and click Yes to accept its conditions. Clicking No quits the installation program. 5. Select the parent location where to install the administration server and reporting server software and click Next. The default location is: C:\Interwoven. You can click Browse and navigate to another location. After installation, the administration and reporting server software resides in:
parent-dir\AdminServer
6. Type the port number for the administration server and click Next. The default port number is 8081. 7. Verify the settings in the Summary Report dialog box 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: C:\Interwoven\AdminServer After the administration and reporting servers install, the ContentServices Foundation (CSF) installer begins automatically.
28
Windows
29
Chapter 2: Installation
To install the ContentServices Access Service 1. Click Next. The license agreement screen displays (see Figure 4). Figure 4 ContentServices Foundation License Agreement
2. Read the license agreement and select the option to Accept the conditions. Click Next. 3. Select the parent location for where to install the ContentServices Foundation software and click Install. This path cannot contain any multibyte characters. The default location is: C:\Interwoven After installation, the ContentServices Foundation software resides in:
parent-dir\CSF
4. Type 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 according to Non-default CSF Port on page 19. 5. Type the appropriate resolvable host name or IP address in the Access Service hostname or IP address text box. The default value is the name of the host on which the CSF software is being installed. Click Next. A new dialog box opens summarizing the settings you specified for the installation. 6. Click Install to proceed with the installation.
30
UNIX
7. When the installation completes, restart the host. The ContentServices Foundation access service starts automatically. If you accepted the default installation locations, the installed software resides in: C:\Interwoven\CSF
You must restart the base server or receiver after performing this task.
After you configure your bootstrap administrator and restart the 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 in the OpenDeploy Administration Guide for more information.
UNIX
You must have root privileges to install OpenDeploy on your UNIX server.
Upgrade to the current release. See Upgrade OpenDeploy on page 36 for more information. Keep your existing legacy base server installation intact (if your release is supported), and install the current release to a different location on your host. See Install Multiple Releases of OpenDeploy on page 45 for more information.
31
Chapter 2: Installation
To install the base server package on a UNIX host 1. Navigate to the working directory containing the appropriate base server installation file: IWOVOpenDeployBaseFull-UNIX_OS-7.x.x.tar.gz where x.x indicates the product release number, and UNIX_OS indicates the particular UNIX platform. 2. Use one of the following methods to unzip or untar the base server installation file:
Unzip the installation file by typing the following command at the prompt (use the installation file appropriate for your base server version):
gzip -d IWOVOpenDeployBaseFull-UNIX_OS-7.x.x.tar.gz
Then, untar the installation file by typing the following command at the prompt (use the installation file appropriate for your base server version):
IWOVOpenDeployBaseFull-UNIX_OS-7.x.x.tar
Unzip and untar the installation file by typing the following command at the prompt (use the installation file appropriate for your base server version):
gzip -c -d IWOVOpenDeployBaseFull-UNIX_OS-7.x.x.tar.gz | tar xvpf -
odsfiles
directory (for the full version of the base server software) file file
ODNG_base_full.tar
file
file
3. Ensure you are in your installation working directory. Start the installation script by typing the following command at the prompt:
./startinstall_od
4. Accept the licensing agreement by pressing Enter. 5. Indicate whether you want to do a fresh install (1) or exit the installer (2), and press Enter. The default value is 1 (install). 6. Type the installation location for the base server software. For example /usr. 7. Type a port number for the Registry service. The default value is 9173. 8. Type a listening port number for incoming deployment. The default value is 20014. 9. Event reporting is enabled by default. Indicate whether (y or n) you want to disable the base server to broadcast event reporting. Event reporting can be configured after installation. 10. If event reporting is enabled indicate whether (y or n) to specify an add it on al bootstrap administrator user (in addition to the default bootstrap administrator root). The default value is n. The bootstrap administrator account can access the browser-based user interface (through the administration server) immediately after installation.
32
UNIX
11. If you add an additional bootstrap administrator, indicate whether the host platform is Windows (1) or UNIX (2). 12. If you add an additional bootstrap administrator user, type the user name. 13. If the host platform is Windows, you must also add the domain. The base server package extracts to /tmp and the installer 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 the installation completes, the package cleans up from /tmp.
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-UNIX_OS-7.x.x.tar.gz, where x.x indicates the product release number, and UNIX_OS indicates the particular UNIX platform. Follow the installation instructions in Install the Base Server Software on page 31 to install the receiver software. You cannot install the receiver software on a host that has base server software installed.
Unzip the installation file by typing the following command at the prompt:
gzip -d IWOVOpenDeployAdmin-UNIX_OS-7.x.x.tar.gz
Next, untar the installation file by typing the following command at the prompt:
tar -xvf IWOVOpenDeployAdmin-UNIX_OS-7.x.x.tar
Unzip and untar the installation file by typing the following command at the prompt:
33
Chapter 2: Installation
gzip -c -d
IWOVadmin.tar
README_ADMINSERVER
OpenDeploy_admin_pkg_license.txt startinstall_admin
file
3. Ensure you are in your installation working directory before running this command. Start the installation script by typing the following command at the prompt:
./startinstall_admin
4. Accept the licensing agreement by pressing Enter. 5. Type the installation location for the administration server and reporting server software. For example, /usr. 6. Type the port number for the administration server and press Enter. The default port number is 8081. The administration package is extracted to /tmp and the installer installs the administration server and reporting server on your host in: /parent_dir/AdminServer, where parent_dir is the location you selected for the software installation. When the installation completes, the package cleans up from /tmp. After you install 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 in the OpenDeploy Administration Guide for more information. After installing the administration and reporting servers, the ContentServices Foundation (CSF) installer automatically begins.
UNIX
2. Press Enter. 3. Type Y to Accept the terms of the license agreement. 4. Either:
Accept the default parent directory, /usr, where the ContentServices Foundation software directory, CSF, will install. Type the path of the location where you want the ContentServices Foundation software directory, CSF, to install, and then press Enter.
NOTE
The CSF directory path cannot contain any multibyte characters. 5. Press Enter to confirm the location. 6. Accept the default port number (12973), or type an alternative at the Access Service HTTP port number prompt. Then press Enter. If you specify a non-default port number, you must perform additional configuration according to Non-default CSF Port on page 19. 7. Either accept the default host name, the name of the host the software is being installed on, or type an alternative at the Web Services HTTP hostname or IP address prompt. Then press Enter. 8. Press Enter to continue the installation. 9. Press Enter to exit the installer when the installation completes. 10. Configure ContentServices Foundation after the installation. Refer to the ContentServices Foundation Developer Guide for more information.
You must restart the base server or receiver after performing this task.
After you configure the bootstrap administrator and restart the 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
35
Chapter 2: Installation
the Bootstrap Administrator User in the OpenDeploy Administration Guide for more information.
Upgrade OpenDeploy
The next sections describe upgrading from a previous release of OpenDeploy to the current release. In addition to the upgrade methods described here, you can use the remote upgrade feature to update multiple OpenDeploy base server and receivers to OpenDeploy 6.1 and higher simultaneously. See Remote Upgrades on page 65 for more information.
Upgrade OpenDeploy
current OpenDeploy release, copy and convert your configuration files from the earlier version, and then uninstall the earlier version. For each OpenDeploy software component you want to upgrade, the installer checks for existing software:
If you install the base server or receiver component on a host that has an OpenDeploy 6.x release of the same component, the installer prompts you for whether to upgrade the existing OpenDeploy 6.x software with the current release. Select the upgrade option to upgrade existing software. See Install Multiple Releases of OpenDeploy on page 45 for more information on installing multiple OpenDeploy releases. If you install the base server or receiver component on a host that has an OpenDeploy release earlier than 6.x of the same component, the installer prompts you for whether to install the new component alongside the existing one on the same host. If you install the administration package, it prompts you to either upgrade or exit. You cannot install a new administration package alongside a legacy release of the same component. To upgrade the administration server requires manually updating the reporting database. See Changes to DataDeploy Module Installation on page 40 for more information.
When you choose to upgrade, the installer program automatically uninstalls the earlier software and installs the current version. The new installation automatically uses existing port settings and other configurations. For new features, you receive a prompt to enter the required information.
NOTE
Upgrading to the current version of OpenDeploy on Windows requires that the Windows host to reboot.
37
Chapter 2: Installation
38
Upgrade OpenDeploy
where MYDATABASEDEPLOYPORT is the internal port used by the OpenDeploy base server or receiver for database deployment support. 3. Save and close the OpenDeploy server configuration file.
2. Configure this file as needed to use your database. See Reporting Server Database in the OpenDeploy Administration Guide for more information. 3. Ensure that the required database drivers are present. You may need to refer to the publishers Web site for current drivers. 4. Save and close the file. 5. Restart the OpenDeploy services.
39
Chapter 2: Installation
Error messages prevent you from navigating the reporting screens in the user interface. The out-of-the-box quick reports are missing. New deployment reporting data does not appear.
In these cases, follow the instructions described in Upgrading the Default Reporting Database in the OpenDeploy Administration Guide. When you upgrade the administration server, make sure the reporting management configuration file (adminEventReportingConfig.xml) has the correct port configuration for all the OpenDeploy servers to which the administration server subscribes. Each server has an associated odNode element in the file. The port number is configured in the odNode elements port attribute. Use the following guidelines to determine the appropriate values for each:
For OpenDeploy 6.0.1 and earlier: the port attribute represents the RMI port (default is 9173). For OpenDeploy 6.0.2 and higher: the port attribute represents the TCP port (default is 9172).
odNode
In addition, you must specify the OpenDeploy version of each server as the value of the elements version attribute, using the x.x.x format. For example:
<odNode host="MYHOST" port="9172" version="6.1.0"/>
40
Upgrade OpenDeploy
Refer to Administration Server Configuration for Reporting in the OpenDeploy Administration Guide for more information on this file.
41
Chapter 2: Installation
5. Restart the TeamSite event subsystem and the OpenDeploy services to resynchronize the products.
For example:
<jndiproperties> <property name="java.naming.provider.url" value="tcp://localhost:3035/" /> <property name="java.naming.factory.initial" value="org.exolab.jms.jndi.InitialContextFactory" /> <property name="jmsTopicSep" value="_" /> <property name="java.naming.security.principal" value="" /> <property name="java.naming.security.credentials" value="" /> </jndiproperties>
3. For TeamSite versions earlier than TeamSite version 6.7.1 Service Pack 1: a. Open the file od-home/etc/daemon.cfg with a text or XML editor b. Type the following attribute and value in the jmsproperties element:
<jmsproperties> <property name="jmsVendor" value="OpenJms" /> <property name="jmsTopic" value=" TeamSite_User" /> <property name="jmsTopicSep" value="_" /> <property name="jmsTopicConnectionFactory" value="JmsTopicConnectionFactory" /> <property name="jmsclasspath" value="D:\Interwoven\OpenDeployNG\lib\tsjms761.jar" /> </jmsproperties>
c. Open the file iw-home/httpd/webapps/eventsubsystem/WEB-INF/ iw_bridge_cfg.xml with a text or XML editor. d. Type the following attribute and value in the iwovJMS element:
dasTopic="TeamSite_User"
42
Upgrade OpenDeploy
For example:
<iwovJMS classpath="D:/iw-home/TeamSite/eventsubsystem/lib/ openjms-client-0.7.6.1.jar" initialContextFactory="org.exolab.jms.jndi.InitialContextFactory" url="tcp://localhost:3035/" factoryName="JmsTopicConnectionFactory" topic="Interwoven" dasTopic="TeamSite_User" waitTime="300000" />
4. Open the file iw-home/httpd/webapps/eventsubsystem/WEB-INF/iw_bridge_cfg.xml with a text or XML editor. 5. Uncomment the following elements: For example:
<!-<logFile name="TeamSiteDASLog" baseLogName="D:/iw-home/TeamSite/local/logs/iwevents/TeamsiteEvents" stateFileName="D:/iw-home/TeamSite/servletd/logs/ iwDASproxy.properties" waitTime="30000" isDAS="true" /> --> <!-<logFile name="TeamSiteClientDASLog" baseLogName="D:/iw-home/TeamSite/local/logs/iwui/iwevents/ TeamSiteClientEvents" stateFileName="D:/iw-home/TeamSite/servletd/logs/ iwclientDASproxy.properties" waitTime="30000" isDAS="true" /> -->
6. Save and close the file. 7. Restart the TeamSite event subsystem and the OpenDeploy services to resynchronize the products.
Chapter 2: Installation
(DAS) must upgrade OpenDeploy to version 7.1.0 or higher before upgrading TeamSite to version 7.2.0.
Upgrade your reporting tables. Refer to Upgrading Reporting Tables in the OpenDeploy Administration Guide for more information. Upgrade the demonstration database that comes with OpenDeploy. Refer to Upgrading the Default Reporting Database in the OpenDeploy Administration Guide for more information.
Windows: the system environment variable is IWOD60HOME UNIX: the home file is /etc/defaultiwodhome
Windows: the system environment variable was IWOD60HOME UNIX: the home file was /etc/defaultiwod60home
This change allows you to have both the current release of OpenDeploy, and one of the supported legacy releases (for example release 5.x) 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. 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 iwodHOME system environment variable.
44
UNIX: a. Configure a well known wrapper to point to /etc/defaultiwodhome. Program your scripts to look for the wrapper instead of /etc/defaultiwod60home. If you upgrade from this release to a higher one, you only need to change the wrapper instead of your custom scripts. b. Create a symbolic link from /etc/defaultiwod60home to /etc/defaultiwodhome or any future release. Following the above techniques does 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.
Each release must be installed in a separate location. Both software releases must be of the same component type (such as, 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 OpenDeploy Ports in the OpenDeploy Reference for more information. The remote upgrade feature is not available for use because it does not support hosts with multiple OpenDeploy installations.
Refer to Running Multiple Releases of OpenDeploy in the OpenDeploy Release Notes for supported legacy releases and other specific information. If you install 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 install it in addition to your existing software. You should choose to install it in addition to the existing software.
45
Chapter 2: Installation
Installation Order
If you perform 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).
This is a change from previous OpenDeploy releases where you could reference the OpenDeploy home directory simply as iwod60home. For example:
Windows: the system environment variable is iwod60home UNIX: the home file is /etc/defaultiwodhome
See Update the OpenDeploy Home Value in Scripts on page 44 for suggestions on managing changes in the OpenDeploy releases home value.
46
Software Requirements
If you perform the WorkStation type installation of Red Hat Linux, OpenDeploy does not require the installation of additional packages. If you perform the Server type installation of Red Hat Linux, you also must select and install the following package:
compat-libstdc++
which you can select by using the Individual Package Selection feature in the Red Hat Linux installer.
2. If nothing returns, the package is not installed. Log in as root and run the following command at the prompt:
rpm -i libstdc++32-3.2.2-5.fdr.0.rh73.i386.rpm
3. Restart OpenDeploy.
47
Chapter 2: Installation
SuSE Linux
The following sections describe issues related to running OpenDeploy on SuSE Linux and SuSE Enterprise Linux.
Ensure that you receive a response that includes the file name.
48
ls -l /lib/i686/libc.so.6
Ensure you get a response that includes the file name. 3. Type the following commands at the prompt:
cd od-home/lib ./dbtool -create -config ../etc/jmsConfig.xml
4. Start OpenDeploy.
NOTE
If you fail to perform these post-installation steps, OpenDeploy cannot run and the following error message is written to your od.log file: od-home/java: error while
loading shared libraries: libpthread.so.0: cannot open shared object file: No such file or directory SuSE Linux OpenDeploy Start and Stop Scripts Location
If this occurs, you can use your OpenDeploy start and stop scripts in the alternate location. You do not need to move them.
49
Chapter 2: Installation
2. If it returns nothing, the package is not installed. Log in as root and run the following command at the prompt:
rpm -i libstdc++32-3.2.2-5.fdr.0.rh73.i386.rpm
3. Restart OpenDeploy.
HP-UX
The following sections describe issues related to running OpenDeploy on HP-UX.
In this case, you must then create the link by entering the following commands at the prompt:
cd /etc ln -s /sbin/init.d init.d
50
(the maximum percentage of memory to be used by dynamic buffer (the minimum percentage of memory to be used by the dynamic buffer (the maximum number of concurrent threads allowed per process):
cache): 15
dbc_min_pct
cache): 5
max_thread_proc
1024
maxdsix
(the maximum size in bytes of the data segment for any user process): 2 GB
maxdsiz_64bit (the maximum size in bytes of the data segment for any user process for 64 bit application): 3 GB maxfiles (the soft limit for the number of files a process is allowed to have open simultaneously): 4096 maxfiles_lim (the hard limit for the number of files that a process is allowed to have open simultaneously): 4096 maxssiz
(the maximum size (in bytes) of the stack for any user process): 250 MB
(the maximum size (in bytes) of the stack for any user process for 64 bit application): 350 MB
maxssiz_64bit maxuprc
(the limits the maximum number of concurrent user processes per user):
2048
msgmnb
(the maximum number of bytes on a single System V IPC message queue ): (the maximum System V IPC message size in bytes): 32767
65535
msgmax msgmni
(the maximum number of system-wide System V IPC message queues (IDs) allowed): 2048 (the number of System V IPC message segments in the system ): 32767 (the number of bytes in a System V IPC message segment): 1024
(the maximum number of System V IPC messages in the system at any time): 2048
nfile (the maximum number of files that can be open simultaneously on the system at any given time): 30000 nflocks
(the maximum combined total number of file locks that are available system-wide to all processes at any given time): 15000 (the maximum number of open inodes that can be in memory): 15000
51
ninode
Chapter 2: Installation
requests): 1024 Autonomy also recommends that you install the java_oob package if your system meets the minimum requirements (512 MB of RAM) for this package. You can obtain this package from the HP Web site:
www.hp.com/products1/unix/java/java2/outofbox/index.html
Uninstall OpenDeploy
Uninstall OpenDeploy software components one at a time, similar to the way you installed them. In some cases, you may want to remove all of the components on a server. In other cases, you may 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 over several servers. Uninstallation procedures for OpenDeploy software vary depending on the server platform.
Windows
You must have Administrator privileges to uninstall OpenDeploy software on a Windows host. To uninstall each OpenDeploy software component from Windows 1. Stop the OpenDeploy service for each corresponding software component. 2. Uninstall the software component, using the Windows Add or Remove Programs tool in the Control Panel. 3. 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 may want to maintain in the event you decide to reinstall OpenDeploy.
Uninstall OpenDeploy
components, and how to stop those services. After you stop the appropriate OpenDeploy services, you can uninstall the OpenDeploy software.
Interwoven OpenDeploy 7.x.x Admin/Reporting Server Interwoven OpenDeploy 7.x.x Base Server (base server only) Interwoven OpenDeploy 7.x.x Receiver (receiver only) Interwoven ContentServices Foundation 7.x.x
where 7.x.x indicates the release numbers of OpenDeploy and CSF. 3. Click Change/Remove to remove the software. 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. To remove these files as well, you can manually delete them with the Windows Explorer.
UNIX
You must be the root user to uninstall OpenDeploy software on a UNIX host. To uninstall each OpenDeploy software component on a UNIX host 1. Stop the OpenDeploy daemon for each corresponding software component. 2. Uninstall each software component using the uninstallation script for that component. The uninstallation script removes the entire directory.
53
Chapter 2: Installation
NOTE
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.
54
Uninstall OpenDeploy
where parent_dir is the location you selected for the software installation. 2. Run the uninstallation script to remove the CSF access service software by typing the following command at the prompt:
./CSFuninstall
55
Chapter 2: Installation
56
Chapter 3
License
This chapter describes the license 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 higher. 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 Autonomy sales representative for further information on purchasing the necessary licenses for your OpenDeploy software. After you install the OpenDeploy software, you must obtain a license key file from the Autonomy Technical 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 Autonomy Technical 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 servers. The major topics in this chapter are:
License Requirements
You must perform the necessary software activation after installation of each OpenDeploy base server and receiver on their respective hosts.
57
Chapter 3: License
Full: the full-featured version without a time limit. EasyDeploy: a restricted-feature version you can use without time limit.
Receiver License
You must license and activate each OpenDeploy receiver installation. An expired receiver only accepts incoming license deployments.
58
License OpenDeploy
License OpenDeploy
You can license OpenDeploy base servers and receivers with one of the following methods:
59
Chapter 3: License
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 Obtain the Host Information. You will receive an e-mail with the OD.lic license file attached.
NOTE
You should provide the primary host name of the OpenDeploy servers host. Note that IP addresses are not supported. 3. Place the OD.lic license file in: od-home/etc 4. Restart the OpenDeploy server.
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 perform a batch license activation, which obtains this information automatically.
60
License OpenDeploy
61
Chapter 3: License
3. Open licidentification.xml with a 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 collected information is written to file odlicreq_datetimestamp.zip residing on the following location of the host running the deployment: od-home/install/batch/
req
Only the targets listed in the updated replication farm (see step 3) have their information written to the file, so ensure that each OpenDeploy server that requires activation is included in replicationFarm element in the deployment configuration. Refer to Target Replication Farms in the OpenDeploy Deployment Configuration Guide fore more information. 6. Access the OpenDeploy batch license generator page from the Autonomy Technical 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 Autonomy Technical Support Web site. You will receive an e-mail from Autonomy containing the file odbatchlic.zip, which contains the bundled set of license files required for activating your OpenDeploy servers.
62
Expired License
2. Open the licdistribute.xml file with a text or XML editor, and update its replication farm to include the targets (similar to what you did for the 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.
OD.lic
When the license distribution deployment runs successfully, each target has its own license file deployed to: od-home/etc
Your OpenDeploy target server automatically accepts the license file in this location. It is not necessary to configure an allowed directory for it.
Expired License
Your OpenDeploy base server and receiver software will start with an expired license, however, the functionality of base servers and receivers is limited to receiving license identification and distribution deployments. Base servers that run on expired licenses cannot start any deployments, including those related to licensing.
63
Chapter 3: License
64
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, which saves much labor and time. Software upgrades can include new versions of OpenDeploy, service packs to existing versions, and updates. Remote upgrades use preconfigured deployments to perform the following tasks:
Perform the software distribution. Upgrade installation packages deploy 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 Autonomy Technical 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 Autonomy. You can also place each license individually in target servers.
Prerequisites Limitations Best Practices Preparation for Remote Upgrades Distribute the Target Server Software Collect License Information Distribute Licenses Log File
65
Prerequisites
The following prerequisites apply to your OpenDeploy servers participating in remote upgrades:
The sending server must have release 6.1 or higher. The target servers being upgraded must have release 6.x or higher. The upgrade must result in the target servers having release 6.1 or higher. 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 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 and Specifying Allowed Directories for Deployments 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 Composite Application Solution (CAS). Administration package software cannot be upgraded with this method.
66
Best Practices
Upgrade deployments using the routed deployment feature is not supported. Upgrade deployments using the multitiered 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 restarts after the upgrade.
Best Practices
To help with the remote upgrade, Autonomy recommends using the following best practices:
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 (the default configuration). This setting allows each target to be upgraded independently of the others. Any failed targets can be upgraded independently at a later time. Break a large upgrade deployment into small 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.
67
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">
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>
68
For
example:
relPath="IWOVOpenDeployBaseFull-Windows-7.2.0.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="ODBase720" relPath="IWOVOpenDeployBaseFull-Windows-7.2.0.exe"/ > <alias name="ODRcvr720" relPath="IWOVOpenDeployRcvr-Windows-7.2.0.exe"/> </upgradeBitsMap>
To assign short names to your upgrade installation files, but not 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.
69
To run the software distribution deployment 1. Select Servers > Remote Upgrade to display the Remote Upgrade dialog box (see Figure 5). Figure 5 Remote Upgrade dialog box
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 dialog box for software distribution configurations (see Figure 6). Figure 6 Remote Upgrade dialog boxSoftware Distribution Configurations
This dialog box displays a list of any existing software distribution deployments, along with the ability to start, schedule, or view each one.
70
4. Click New Configuration. The dialog box updates with items for you to complete that determine how the configuration of the software distribution deployment (see Figure 7). Figure 7 Remote Upgrade dialog boxSoftware Distribution Configurations (2)
It also contains a separate list for each replication farm (with its member target nodes listed below) 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 automatically applies to each listed target node, however, you can change this value for any individual entry. You can also leave this box clear and select the upgrade package for each target node separately. 7. Type the destination directory on the targets for the software installation file in the Target Directory box. The value you type automatically applies to each listed target node, however, you can change this value for any individual item. You can also leave this text box clear and type 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.
71
9. Select the check box by each target node entry to indicate that those targets are to participate in the software distribution. The cleared node entries will not receive the deployed software distribution installation file. You must select at least one target node entry to generate the configuration file. 10. Click Save. The dialog box reappears with your new software distribution configuration included in the list (see Figure 8). Figure 8 Remote Upgrade dialog boxSoftware Distribution Configurations (3)
In addition, the configuration files needed to acquire 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 files are used in later tasks. 11. Click Start associated with the software distribution deployment you want to run. The Start Deployment dialog box opens (see Figure 9). Figure 9 Start Deployment dialog box
72
12. Click Start Deployment. The upgrade installation file deploys to each target host listed in the deployment, along with a script that allows the installation file to begin running after it deploys. 13. Reboot your target server host. After deploying the installation file and script, a Deploy and Run script is invoked. The Deploy and Run performs validation checks before the installation begins. If the validation succeeds, the Deploy and Run then begins the installation. You can view details on how the upgrade performed in the sender and receiver target logs.
specifies the number of times to poll the target for information before the deployment to that target quits. Default value is 20.
checkIntervalInMins specifies the amount of time in minutes between polling of the target. Default value is 2 minutes.
At the time the software distribution deployment generates, OpenDeploy also generates a corresponding license identification deployment in: 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 1. Select Servers > Remote Upgrade to display the Remote Upgrade dialog box. 2. Select License Identification from the Configuration Type list to display the Remote Upgrade dialog box for license identification configurations (see Figure 10). Figure 10 Remote Upgrade dialog boxLicense Identification Configurations
This dialog box displays a list of any existing license identification deployments, including the one automatically generated when you created the software distribution deployment. Here you can Start, Schedule, or View any of the listed deployments by clicking the appropriate associated button. To run the license identification deployment associated with the software distribution deployment you already ran, click its Start. The Start Deployment dialog box opens, where you can run the license identification deployment as you would a regular deployment. The collected information is written to file odlicreq_datetimestamp.zip, which resides in the following location of the host running the deployment:
od-home/install/batch/req
After you run the license identification deployment, continue on starting with step 6 of Batch Server Activation on page 61.
74
To configure a new license identification deployment 1. Type a name for the license identification deployment in the Configuration Name box. 2. Select one of the following options from the Encryption list:
None for no encryption. SSL for secure data transfer using Secure Sockets Layer-based (SSL) encryption. Key File for weak (40-bit) symmetric key file-based encryption.
Refer to Encryption in the OpenDeploy Administration Guide for more information. 3. Select the targets to include in your deployment. You must select at least one target. 4. Click Save. The original License Identification dialog box reappears with your new license identification deployment included in the list. The license identification deployment is created in: od-home/conf/licID An accompanying license distribution deployment configuration file with the same name also generates automatically in the following location: od-home/conf/licDist
75
Distribute Licenses
After you run the license identification deployment and send the collected information to the Autonomy Technical Support Web site, you will receive the batch license file odbatchlic.zip. This file contains licenses for the OpenDeploy servers that are part of your license identification deployment. After you receive this file, place it in the following location: od-home/install/batch You must run the license distributing deployment associated with your license identification deployment. This action deploys the license to each target and activates it. At the time a software distribution deployment configuration or a license identification deployment generates, OpenDeploy also generates a corresponding license distribution deployment configuration in: od-home/conf/licDist 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 1. Select Servers > Remote Upgrade to display the Remote Upgrade dialog box. 2. Select License Distribution from the Configuration Type list to display the Remote Upgrade dialog box for license distribution configurations (see Figure 12). Figure 12 License Distribution dialog box
The dialog box displays a list 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 listed configuration by clicking the associated button.
76
Distribute Licenses
To run the license distribution deployment associated with the software distribution or license identification deployment that you already ran, click its Start. The Start Deployment dialog box opens, where you can run the license distribution deployment as you would a regular deployment. After the license distribution deployment runs, the targets that successfully received license files are now fully operable.
To configure a new license distribution deployment 1. Type 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.
77
3. Select the targets to include in your license distribution deployment. You must select at least one target. 4. Click Save. The original License Distribution dialog box reappears with your new license distribution deployment configuration in the list. The new license distribution configuration file is created in: od-home/conf/licDist
Log File
The remote upgrade script that runs on each target host generates the log file od_remote_upgrade.log. This file contains entries that detail 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.
Exercise caution and understand the risks of this type of operation before beginning it. If you attempt to run a remote upgrade as a non-root user without performing the following procedure, the remote upgrade will fail. An error message appears in the od_remote_upgrade.log file. See Log File on page 78 for more information.
78
To perform remote upgrades on UNIX target hosts as a non-root user 1. Configure a software distribution deployment as described in Distribute the Target Server Software on page 69. Ensure that 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:
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 with a text or XML editor. Each target has its own corresponding DeployNRun element. Within this DeployNRun element 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-UNIX_OS-7.x.x.tar.gz"
and
cmd="/usr/local/bin/sudo /path/unixupgrade.sh REMOTE_INSTALL /path/ IWOVOpenDeployBaseFull-UNIX_OS-7.x.x.tar.gz"
6. Save and close the file. 7. Configure Sudo on each target host to allow unixupgrade.sh to 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 upgraded successfully. 9. Reverse the changes made to the /etc/sudoers file so that a password is required again.
79
80
Chapter 5
The Web services endpoint for OpenDeploy is specified as the httpTransport elements host attribute value in the odbase.xml or odrcvr.xml file. For example:
<webServices> <httpTransport port="9273" host="mycompany.com"> ... </webServices>
Both files reside in: od-home/etc To resolve this issue: 1. Ensure that both the CSF and OpenDeploy Web services endpoints match. 2. Open the framework.properties file with a text editor. This file resides in:
admin-home/httpd/iwwebapps/opendeploy/WEB-INF/conf
3. Set the DeployAdmin.ASHostname value to your OpenDeploy servers host name. For example:
DeployAdmin.ASHostname=mycompany.com
81
This value should be the same as is listed for the CSF and OpenDeploy Web service endpoints. 4. Save and close the file. 5. Restart OpenDeploy, including the administration and CSF services. To uninstall the CSF software on a SuSE Enterprise Linux 9.0 host If you uninstall the CSF software on a SuSE Enterprise Linux 9.0 host, residual k88iwaccess entries are left in some of the /etc/rc.* files. To fix this: 1. Login as root. 2. Type the following commands:
cd rm cd rm cd rm cd rm cd rm /etc/rc0.d k88iwaccess /etc/rc2.d k88iwaccess /etc/rc3.d k88iwaccess /etc/rc5.d k88iwaccess /etc/rc6.d k88iwaccess
To install, uninstall, or upgrade OpenDeploy on Windows When installing, uninstalling or upgrading OpenDeploy software on a Windows host, make sure the Services window is closed. Otherwise, the OpenDeploy services might not properly register. This is a known Microsoft issue. The Services window must be completely closed, not just minimized, to avoid this issue. To remedy host failure due to insufficient disk storage The OpenDeploy base server and receiver software fail if there is insufficient disk storage for the deployment. Refer to Transactional Deployments in the OpenDeploy Administration Guide for more information on disk storage requirements. You can adjust the percentage of host disk space for the file system as a way to improve OpenDeploy performance. Refer to Performance Throttling in the OpenDeploy Administration Guide for more information.
82
Index
A
administration package 14 installation 27, 33 administration server 15 installation 19 software 14 Tomcat server 15 uninstallation 54 alias element 68 attributes checkIntervalInMins 73 dirPath 68 maxIterations 73 name (alias) 69 relPath 69
F
firewall, port access 21
I
installation 14, 23, 33 administration package 14, 27, 33 administration server 14, 19 base server 14, 17, 24, 31 ContentServices Foundation Access Service 14, 16, 19, 29, 34 DOS-compatible 8.3 format 20 home values 46 information requirements 16 multiple releases 45 order 46 platform-specific requirements 36 receiver 14, 18, 26, 33 reporting server 14, 19 Tomcat server 15 UNIX 31 upgrades 36 Windows 23
B
base server 14 installation 17, 24, 31 license types 17 software 14 uninstallation 54 bootstrap administrator 31, 35
L
licensing 57, 59 add-on modules 58 administration package 58 base server 58 batch 61 cluster 59 distribution 62 EasyDeploy 58 expired 63 multiple host names 59 receiver 58 requests 61 single 59 software activation 57
83
C
checkIntervalInMins attribute 73 ContentServices Foundation Access Service 55 installation 16, 19, 29, 34 non-default port configuration 19 software 14 uninstallation 55
D
dirPath attribute 68
E
EasyDeploy 17, 58
M
maxIterations attribute 73
N
name (alias) attribute 69
O
OpenDeploy administration server 15 base server 14 configuration 23 home values 46 installation 14, 23, 31, 46 licensing 57, 59 multiple releases 45 receiver 14 Release Notes 13 reporting server 16 uninstalling 52 upgrades 36 OpenDeploy licensing 57
S
servers administration 15 report 16 source 14 Tomcat 15 software activation 57 source servers installation 14
T
target servers 14 Tomcat server 15 installation 15
U P
ports firewall access 21 uninstallation 52 administration server 54 base server 54 receiver 54 UNIX 53 Windows 52 upgradeBitsMap element 68 upgrades 36 configuration files 38 DAS and database deployments 38 event reporting 38 home values, updating 44 multiple instances 38 non-Administrator 37 non-root 37 previous releases 36 remote 65 reporting server 44
R
receiver 14 installation 14, 18, 26, 33 uninstallation 54, 55 relPath attribute 69 remote upgrades 65 best practices 67 installation file location 68 license distribution 76 license requests 73 limitations 66 logging 78 monitoring 73 non-root user 78 preparation 68 prerequisites 66 short names, specifying 68 target software, distributing 69
84