How to install OpenDeploy
November 13, 2010 Leave a comment
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
Chapter 2: Installation
Interwoven, Inc. 26
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
ODNG_base_full.tar (for the full version of the base server software) file
OpenDeploy_base_license.txt file
README_OPENDEPLOY file
startinstall_od 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.
OpenDeploy Installation Guide 27
Chapter 2: Installation
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
IWOVadmin.tar file
README_ADMINSERVER file
Chapter 2: Installation
Interwoven, Inc. 28
OpenDeploy_admin_pkg_license.txt file
startinstall_admin 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 115 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.
OpenDeploy Installation Guide 29
Chapter 2: Installation
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 116 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 27 in the OpenDeploy Release Notes for any additional
instructions related to installing OpenDeploy on a specific host platform.
Chapter 2: Installation
Interwoven, Inc. 30
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.
OpenDeploy Installation Guide 31
Chapter 2: Installation
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 52 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.
Chapter 2: Installation
Interwoven, Inc. 32
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:
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 239
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 239 in the OpenDeploy
Administration Guide for more information.
OpenDeploy Installation Guide 33
Chapter 2: Installation
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
Chapter 2: Installation
Interwoven, Inc. 34
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.
OpenDeploy Installation Guide 35
Chapter 2: Installation
Refer to “Running Multiple Releases of OpenDeploy” on page 34 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 release’s home value.
Chapter 2: Installation
Interwoven, Inc. 36
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.
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 41 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
OpenDeploy Installation Guide 37
Chapter 2: Installation
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.
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 41 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
Chapter 2: Installation
Interwoven, Inc. 38
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.
parent_dir/iwinstall/products/CSF/UninstallerData
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 entering
the following command at the prompt:
./CSFuninstall
OpenDeploy Installation Guide
interwoven support 