ObjectStore Installation and License for Solaris

Chapter 4

Installing ObjectStore C++ Release 5.1

This module provides instructions for loading and configuring ObjectStore C++ Release 5.1 on your system.

Caution

Before you follow the steps in this chapter,

You must have read the previous chapters in this book.
You should back up existing ObjectStore software and databases.

OS_ROOTDIR

In this chapter, OS_ROOTDIR is the top-level directory in the part of the distribution hierarchy containing ObjectStore files.

This installation consists of the following phases:

Accessing ObjectStore from the CDROM

This section provides instructions for accessing local and remote CDROMs. There are several commands that you can execute directly from the ObjectStore CDROM. The procedure is the same regardless of the command you want to execute. Be sure to follow the correct procedure according to whether you are mounting a local or remote CDROM.

Using a Local CDROM to Access the ObjectStore CDROM

Follow these steps to access the ObjectStore CDROM from a local CDROM:

On the host where you want to execute a particular ObjectStore command, mount the CDROM.

If you are running the volume daemon (vold), insert the CDROM in its carrier into the drive. The system should mount it automatically as
```
      /cdrom
```
If you are not running the volume daemon, you must mount the CDROM using the command line
```
      mount -F hsfs -r /dev/ disk-device /mount-point 
```
If OS_ROOTDIR is set, disable the OS_ROOTDIR environment variable before installing ObjectStore C++ Release 5.1. For example:
```
      unsetenv OS_ROOTDIR
```
Or, for sh and ksh, OS_ROOTDIR =
While logged in as root, change your current directory to the CDROM directory.
```
      cd /cdrom/packages/ostore
```
Or, if the CDROM was mounted automatically by the volume daemon,
```
      cd /cdrom/packages/ostore
```
Go to Installing ObjectStore and follow the instructions to complete your installation.

Using a Remote CDROM to Access the ObjectStore CDROM

Follow these steps to access the ObjectStore CDROM from a remote CDROM:

Export the cdrom directory by means of NFS.

If you are running the volume daemon on the machine that you mounted the CDROM on, follow these steps:

Insert the CDROM into the drive. The volume daemon automatically mounts it.
Determine where the volume daemon mounted the CDROM:
```
            df -k | grep /cdrom 
```

Check whether or not the NFS daemons are running using a command such as the following:

            ps -elf | grep mountd

            ps -elf | grep nfsd

If either one is not running then restart it (as root) with a command such as the following:

            /usr/lib/nfs/nfsd -a 16

            /usr/lib/nfs/mountd

Export the directory as follows:

share -F nfs -o ro path-returned-in-step-b

            mount -F nfs -o ro  remote-host:path-returned-in-step-b /cdrom

If you are not running the volume daemon, export /cdrom.

Mount the exported directory on the local machine. For example:
```
      mount -F nfs -o ro  remote-host:/cdrom /cdrom
```
where remote-host is the name of the remote host.
If OS_ROOTDIR is set, disable the OS_ROOTDIR environment variable before installing ObjectStore C++ Release 5.1 initially. For example:
```
      unsetenv OS_ROOTDIR
```
Or, for sh and ksh,
```
      OS_ROOTDIR = 
```
While logged in as root, change your current directory to the CDROM directory.
```
      cd /cdrom/packages/ostore
```
Go to Installing ObjectStore and follow the instructions to complete your installation.

Installing ObjectStore

The preparatory procedure for installing ObjectStore is the same regardless of whether you are upgrading ObjectStore or installing ObjectStore for the first time. The procedure is different for local and remote CDROMs, however, so be sure to follow the correct instructions.

osinstal -nonroot Parameter

The osinstal utility accepts the command-line parameter -nonroot. This allows non-root users to install an ObjectStore release. A consideration with this type of installation is that directory permissions for OS_ROOTDIR/lib cannot be set properly and as a result Cache Manager automatic launching fails. If youinstall using the -nonroot parameter, you must start the Cache Manager manually in this configuration using the command

oscmgr4 0 0 &

Also refer to the Server parameter description Restricted File DB Access, in ObjectStore Management's Chapter 2, Server Parameters if you must run the ObjectStore Server in non-root mode.

ObjectStore Installation Procedure

Follow the instructions below to install ObjectStore.

On the system on which you plan to run the ObjectStore Server, log in as root unless you intend to install using the -nonroot option.
If it is not already mounted, mount the CDROM.

To access the ObjectStore CDROM from a local CDROM, follow the instructions in Using a Local CDROM to Access the ObjectStore CDROM. Then return here.
To access the ObjectStore CDROM from a remote CDROM, follow the instructions in Using a Remote CDROM to Access the ObjectStore CDROM. (The instructions tell you to change directories to the correct directory on the CDROM.) Then return here.
Enter the following to run the installation utility:
```
      ./osinstal 
```

The installation utility is interactive and you are prompted for the information you must select. You can view a sample dialog at /TDB/osinst.htm.

osinstal Dialog

The osinstal utility prompts you to accept the default installation location, or enter your choice. It also prompts you to specify which components of ObjectStore you want to install.

Run-time and development

You can install either the run-time or development environment. When you choose to install the development environment, the run-time environment is automatically installed.

The osinstal dialog varies according to your input.

Defaults and
user input

Where a single value appears in brackets in the dialog, it is a default that you can accept by pressing Enter.

For instructions on running osconfig, see Running the Configuration Utility.

Setting the Top-Level ObjectStore Directory

Before you can configure ObjectStore, you must set the OS_ROOTDIR and LD_LIBRARY_PATH environment variables to point to the newly installed ObjectStore product. The OS_ROOTDIR variable must be set to point to the directory where you installed the product. The default setting is /opt/ODI/ostore. The shared library path environment variable LD_LIBRARY_PATH must include $OS_ROOTDIR/lib in its path.

Setting OS_ROOTDIR

setenv OS_ROOTDIR R5.0-install-directory

For sh and ksh:

OS_ROOTDIR=R5.0-install-directory ; export OS_ROOTDIR

Setting LD_LIBRARY_PATH

setenv LD_LIBRARY_PATH $OS_ROOTDIR/lib:$LD_LIBRARY_PATH

For sh and ksh:

LD_LIBRARY_PATH=$OS_ROOTDIR/lib:$LD_LIBRARY_PATH ; export LD_
LIBRARY_PATH

Running the Configuration Utility

Before you run Release 5.1, you must configure the installation on each machine that will run this release.

The ObjectStore configuration utility is $OS_ROOTDIR/bin/osconfig. You must run osconfig as root.

Configuring Servers

On each machine you intend to use as an ObjectStore Server, invoke osconfig in one of the following ways:

For file databases:

      $OS_ROOTDIR/bin/osconfig server

For file databases and rawfs databases:

      $OS_ROOTDIR/bin/osconfig rawfs

The osconfig rawfs utility does everything that the osconfig server utility does and also configures the rawfs.

Configuring Clients

On each machine you intend to use only as an ObjectStore client, you invoke osconfig as follows:

$OS_ROOTDIR/bin/osconfig client

osconfig client establishes symbolic links to shared libraries in /usr/local/lib. If an ObjectStore client machine shares this directory with a machine that has already been configured, or if you want to ensure the use of LD_LIBRARY_PATH, you need not run osconfig on it.

The configuration dialog for clients is similar to the dialog for Servers.

Configuring a Host to Be Both a Server and a Client

If you plan to use a host as both a Server and a client, run osconfig server or osconfig rawfs on that host. This configures the host to be both an ObjectStore Server and an ObjectStore client.

Checking the Configuration

After you configure ObjectStore on a host, you can run the osconfig check utility to verify a successful configuration. This utility checks that

The Server is running.
The Cache Manager is available as setuid root. Note restrictions on a non-root installation in Configuring ObjectStore to Start Automatically.
The library schemas are available.

Configuring ObjectStore to Start Automatically

Object Design recommends that you configure your ObjectStore installation to start the Release 5 Server automatically on reboot. The osconfig script asks whether you want the Server to be started automatically. Accepting the default (yes) ensures that the Server starts automatically.

However, when you set the Restricted File DB Access Server parameter to yes and the account that starts the Server does not have root permission, then

ObjectStore does not allow access to rawfs databases.
ObjectStore allows access to file databases but only by clients that belong to the same group as the account from which the Server was started. All access is under the account from which the Server was started.

The default is that the Restricted File DB Access parameter is set to no. This means that if an account with non-root permission starts the Server, ObjectStore allows access to rawfs databases but does not allow access to file databases.

Configuring User Environments

After you configure ObjectStore, there are a few steps you must perform to allow user access to ObjectStore.

Telling users to set OS_ROOTDIR

Tell all users of ObjectStore to set the environment variable OS_ROOTDIR.

Tell users to set OS_ROOTDIR to the directory in which you installed it. Then tell them to add $OS_ROOTDIR/bin to their paths.

Setting Up Links to Shared Libraries

C shell users

If you did not make symbolic links in /usr/local/lib to the ObjectStore shared libraries, and you use the C shell, put this in your .cshrc, and have users at your site add it to theirs:

setenv LD_LIBRARY_PATH $OS_ROOTDIR/lib:$LD_LIBRARY_PATH

Bourne and Korn shell users

If you did not make symbolic links in /usr/local/lib to the ObjectStore shared libraries, and you use the Bourne or Korn shell, put this in your .profile:

LD_LIBRARY_PATH=$OS_ROOTDIR/lib:$LD_LIBRARY_PATH

export LD_LIBRARY_PATH

Installing the On-line Documentation

To install the ObjectStore full-text-searchable documentation. Unpack the documentation distribution by doing one of the following:

For root installation

If ObjectStore has been installed as root, $OS_ROOTDIR is write-protected. Therefore, you must complete the following steps.

# chmod +w $OS_ROOTDIR
# cd $OS_ROOTDIR/..
# uncompress -c /cdrom/packages/ostore/doc_sol2.tar.Z | tar xvf -
# chmod -w $OS_ROOTDIR

For non-root installation

If ObjectStore has been installed using the nonroot option, the owner/installer has write permission in $OS_ROOTDIR (and all subdirectories) so the chmod command is unnecessary. In this case, do the following steps.

# cd $OS_ROOTDIR/..
uncompress -c /cdrom/packages/ostore/doc_sol2.tar.Z | tar xf -

osji note

Do not install the Java documentation until you have completed the ObjectStore documentation installation.

When you run the ossearch command the first time, you will be asked whether to install it. After it installs, and on future invocations of ossearch, it will launch the configured browser on the root of the documentation tree.

When you run the ossearch command the first time, you will be asked whether to install it. After it installs, and on future invocations of ossearch, it will launch the configured browser on the root of the documentation tree.

Browser warnings

When you invoke the search application, you might see a stream of warnings before the browser actually appears. These complaints are associated to the release of X11 the application expects. If you are running X11 R6, no such warnings appear.

Viewing the On-line Documentation

The documentation for ObjectStore Release 5.1 is distributed in machine-readable HTML format and PDF. The HTML format uses HTML frames, so JavaScript must be enabled. To view the documentation from a browser, in the $OS_ROOTDIR/ODI directory, run the ossearch utility. This displays the catalog of ObjectStore documentation components.

You can search the entire ObjectStore Release 5.1 documentation set from the top level bookshelf search button for each interface (for example, 5.1.0.0.0/ostore/doc/index.htm). Once you have selected a book, you can search the rest of its documentation set by selecting the search button in the navigation bar above the book text frame.

Search by entering a word or series of words separated by commas in the query box and pressing return key. If you are uncertain about how to enter a query, you can refer to an online search query guide by clicking on the string to learn additional query methods that appears in the search form.

Installing the Java Interface to ObjectStore

To install the Java interface to ObjectStore from the CD, change to the osji subdirectory and execute the osjinst program as shown:

      cd osji
      ./osjinst

[previous]

Copyright © 1998 Object Design, Inc. All rights reserved.

Updated: 04/15/98 15:17:34