Appendix A Installation and Configuration Reference
This appendix contains details about the installation of the Sun N1 Service Provisioning System 6.0 in
the following sections:
Reference Data for the Sun N1 Service Provisioning System 6.0 on Linux
and UNIX Systems
This section contains details about the installation of the Sun N1 Service Provisioning System 6.0 on
Linux and UNIX systems. The topics include the following sections:
Directory Structure of the Sun N1 Service Provisioning System 6.0 on
Linux and UNIX Systems
When installing the Sun N1 Service Provisioning System 6.0, you are prompted to select
a home directory for the software. The default directory on UNIX systems
is /opt/SUNWn1sps. The default directory on Linux
systems is /opt/sun. The installation program
creates the following directory tree within the home directory:
-
N1_Service_Provisioning_System_6.0 is the directory
created for the Master Server and CLI Client that contains the software.
-
N1_Service_Provisioning_System is the directory
created for the Local Distributor and Remote Agent that contains the
software.
The installation scripts install the Sun N1 Service Provisioning System 6.0 software
into default destination directories that are subdirectories of the
home directory for the software. All directories are created with
the permissions set to 755, rwxr-xr-x, except when
noted in the tables below. Most files are assigned with the permissions
set to 644, rw-r--r, except for executable files
and scripts, which are set to 755.
The following table lists the directories that are installed
for every Sun N1 Service Provisioning System 6.0 application, the Master Server, Local Distributor,
Remote Agent, and CLI Client.
Table A–1 Directories Common to All
Applications
|
Directory
|
Contents
|
|
/common
|
Common files for all applications
|
|
/common/jre
|
Bundled copy of platform-specific JRE
|
|
/common/lib
|
Library files common for some or all applications
|
The following table lists the directories installed for the
Master Server.
Table A–2 Directories Installed for
the Master Server
|
Directory
|
Contents
|
|
/server/config
|
Master Server configuration files
|
|
/server/custom
|
User interface customization files
|
|
/server/data
|
Master Server data files
|
|
/server/bin
|
Master Server executable files
|
|
/server/lib
|
Master Server-specific library files
|
|
/server/postgres
|
Bundled copy of Postgres
|
|
/server/tomcat
|
Bundled copy of Apache Tomcat
|
|
/server/webapp
|
Browser Interface Web Application
|
|
/server/setup
|
Miscellaneous files used to initialize the Master Server
|
|
/server/config/proxy/config
|
Command line user interface SSH proxy properties file
|
|
/server/data/tmp
|
Master Server temporary directory with permissions set to 777
|
|
/server/README
|
Text license agreement
|
The following table lists the directories installed for the
Local Distributor.
Table A–3 Directories Installed for
the Local Distributor
|
Directory
|
Contents
|
|
/ld/config
|
Local Distributor configuration files
|
|
/ld/bin
|
Local Distributor executable files
|
|
/ld/lib
|
Local Distributor library files
|
|
/ld/data
|
Local Distributor specific data
|
|
/ld/data/tmp
|
Local Distributor temporary directory with permissions set to
777
|
|
/ld/jvm/jre/bin
|
Local Distributor JRE proxy
|
|
/ld/README
|
Text license agreement
|
The following table lists the directories installed for the
Remote Agent.
Table A–4 Directories Installed for
the Remote Agent
|
Directory
|
Contents
|
|
/agent/config
|
Remote Agent configuration files
|
|
/agent/bin
|
Remote Agent executable files
|
|
/agent/bin/protect
|
Jexec directory with permissions set to 100, --x------
|
|
/agent/bin/protect/jexec
|
Jexec is used when the agent needs root permissions with permissions
set to 4110
|
|
/agent/lib
|
Remote Agent library files
|
|
/agent/data
|
Remote Agent specific data
|
|
/agent/work
|
Default directory for execution of execNatives.
|
|
/agent/data/tmp
|
Remote Agent temporary directory with permissions set to 777
|
|
/agent/jvm/jre/bin
|
Remote Agent JRE proxy
|
|
/agent/README
|
Text license agreement
|
The following table lists the directories installed for the
CLI Client.
Table A–5 Directories Installed for
the CLI Client
|
Directory
|
Contents
|
|
/cli/config
|
CLI configuration files
|
|
/cli/bin
|
CLI executable files
|
|
/cli/lib
|
CLI library files
|
|
/cli/data
|
CLI specific data
|
|
/cli/data/tmp
|
CLI temporary directory with permissions set to 777
|
|
/cli/README
|
Text license agreement
|
Database Optimization on Linux and UNIX Systems
The installation program prompts you to set up database optimization
daily. If you select to optimize the database daily, the installation
script adds the following command to the cronjob file.
You can add this command to the cronjob file
at any time to begin daily optimization of the database.
MM HH * * * N1SPS6.0-home/server/bin/roxdbcmd vacuumdb -d rox > /dev/null 2> /dev/null
|
N1SPS6.0-home is the home
directory of the Master Server.
Sample Remote Agent Parameters File for Linux
and UNIX Systems
A sample parameters file is installed on the Master Server in
the /server/bin directory, along with other
scripts, when you install the Master Server. You can use this file
to indicate configuration selections so that you can non-interactively
install the Remote Agent. The contents of the sample parameters file
are shown below.
# This is a sample file that sets the parameters required
# for the remote installation of Remote Agents.
#
# This file must be uncommented and edited with the correct
# values before it can be used.
# $Id: cr_ra_remote_params.sh,v 1.4 2005/05/19 23:52:07 echiquet Exp $
# CR_RA_INSTALLBASE - the base directory where the
# Remote Agent will be installed. If the directory
# does not exist, the installer will attempt to create it.
# Defaults to /opt/SUNWn1sps
#
CR_RA_INSTALLBASE=/opt/SUNWn1sps
# CR_RA_OWNER - The owner of the distribution. A pre-existing
# user must be specified. Defaults to 'n1sps'.
#
CR_RA_OWNER=n1sps
# CR_RA_GROUP - The group owner of the distribution. A
# pre-existing group name must be specified. Defaults to 'n1sps'.
#
CR_RA_GROUP=n1sps
# CR_RA_PORT - Port number that the Remote Agent will listen on.
# An integer value between 1024 and 65535 must be specified. Defaults
# to 1131.
#
CR_RA_PORT=1131
# CR_RA_CTYPE - Parent connection type. How the parent connects to
# this RA. One of 'raw' (unencrypted), 'ssh', or 'ssl'. There is no default.
# This parameter is required.
#
#CR_RA_CTYPE=raw
# CR_RA_CIPHER_TYPE - SSL cipher suite type. One of '1' (encryption,
# no authentication) or '2' (encryption, with authentication).
# Default is 1, but has no effect for parent connection type of raw or
# ssh.
#
CR_RA_CIPHER_TYPE=1
# CR_RA_CTYPE_CONFIRM - Selection confirmation for an insecure
# connection type, such as 'raw' or 'ssl with no authentication'. If set to
# anything else than 'true', the installation will fail for such connection
# types.
CR_RA_CTYPE_CONFIRM=false
# CR_RA_INSTALL_JRE - Directive of whether or not a JRE should be
# installed with the Remote Agent for it's use. Defaults to 'y'. Valid
# values are 'y' or 'n'.
#
CR_RA_INSTALL_JRE=y
# JRE_HOME - Directive for the location of the JRE installation. If
# the CR_RA_INSTALL_JRE directive is set to 'y', the installer will
# install the JRE. In this case, the JRE_HOME value will be
# $CR_RA_INSTALLBASE/common/jre. If the installer is not going to
# install the JRE, the JRE_HOME should point to where the pre-existing JRE
# is installed.
#
JRE_HOME=$CR_RA_INSTALLBASE/N1_Service_Provisioning_System/common/jre
# CR_RA_SUID - Directive of whether or not the RA should be installed
# with the setuid root privileges. Valid values are 'y' or 'n'. This
# only works when the remote installer is run as the root user and
# the connection type is ssh.
# There is no default. This parameter is required.
#
#CR_RA_SUID=y
# CR_RA_INSTALLER_USER - The user that should perform this install. This
# is what the remote installer will use to ssh into the remote hosts
# and run the commands as. It is highly recommended that this be set to
# root, although, it doesn't have to be. Defaults to the current user.
#
CR_RA_INSTALLER_USER=root
# CR_RA_INSTALLER_WORKDIR - The directory to use to store temporary files.
# The distribution will be copied into this directory so make sure
# that this it has enough space to store the distribution file. Defaults to
# /tmp
#
CR_RA_INSTALLER_WORKDIR=/tmp
# CR_RA_INSTALLER_LEAVEFILES - Directive of whether or not the temporary
# files should be preserved on the remote host. Defaults to 'n'.
#
CR_RA_INSTALLER_LEAVEFILES=n
# CR_RA_INSTALLER_HOSTS - List of remote hosts on which the Remote Agent is
# to be installed. This must contain at least one host name. This host list
# can also be set in the environment variable 'CR_RA_INSTALLER_HOSTS', or
# specified on the command line. Check the remote agent installer script
# usage message for exactly how this can be done.
#
# Note : The format of the list of hosts is critical. The list of hosts
# must be separated by a comma (',') and cannot have any spaces in between.
# It must be in one contiguous string.
#
CR_RA_INSTALLER_HOSTS=""
# CR_REBOOT_SCRIPT_SETUP - Directive of whether to reboot the Remote Agent
# or local distributor after the installation. Defaults to 'false'.
CR_REBOOT_SCRIPT_SETUP=false
# CR_USER_TO_RUN_AS - The owner of the Remote Agent process. Default value is
# CR_RA_OWNER, i.e. n1sps.
CR_USER_TO_RUN_AS=CR_RA_OWNER
export CR_RA_INSTALLBASE CR_RA_PORT CR_RA_GROUP CR_RA_OWNER CR_RA_INSTALL_JRE CR_RA_SUID
export CR_RA_CTYPE CR_RA_CIPHER_TYPE
export CR_RA_INSTALLER_USER CR_RA_INSTALLER_WORKDIR CR_RA_INSTALLER_LEAVEFILES
export CR_RA_INSTALLER_HOSTS JRE_HOME
export CR_REBOOT_SCRIPT_SETUP CR_USER_TO_RUN_AS
|
CR_RA_ALLOWFORWARDVERSION Parameter
If you want to install an Sun N1 Service Provisioning System 6.0 Remote Agent on a version
of an operating system that is numerically higher than the highest
version the Sun N1 Service Provisioning System 6.0 supports for that operating system, add
the following parameter to the parameters file:
CR_RA_ALLOWFORWARDVERSION=y
If you use the CR_RA_ALLOWFORWARDVERSION=y parameter,
the installation program does not verify that the operating system
on which you are installing the Remote Agent is supported. There is
no standard Sun Services support for use of the Sun N1 Service Provisioning System 6.0 on unsupported
operating systems.

Caution –
Installing the Sun N1 Service Provisioning System 6.0 on unsupported operating
systems might result in undefined and unexpected behavior. Install
the Sun N1 Service Provisioning System 6.0 on unsupported operating systems only for testing
purposes. Do not use the Sun N1 Service Provisioning System 6.0 on unsupported operating systems
in a production environment.
Reference Data for the Sun N1 Service Provisioning System 6.0 on Windows
This section contains details about the installation of the Sun N1 Service Provisioning System 6.0 on
Windows in the following sections:
Directory Structure of the Sun N1 Service Provisioning System 6.0 on
Windows
When installing the Sun N1 Service Provisioning System 6.0, you are prompted to select
a home directory for the software. The default directory is one of
the following.
-
C:\Program Files\N1 Service Provisioning
System\6.0 is the directory created for the Master
Server and CLI Client that contains the software.
-
C:\Program Files\N1 Service Provisioning
System is the directory created for the Local Distributor
and Remote Agent that contains the software.
The installation scripts install the Sun N1 Service Provisioning System 6.0 software
into default destination directories that are subdirectories of the
home directory for the software. The following table lists the directories
that are installed for every Sun N1 Service Provisioning System 6.0 application, the Master
Server, Local Distributor, Remote Agent, and CLI Client.
Table A–6 Directories Common to All
Applications
|
Directory
|
Contents
|
|
\common
|
Common files for all applications
|
|
\common\jre
|
Bundled copy of the JRE for Windows
|
|
\common\lib
|
Library files common for some or all applications
|
The following table lists the directories installed for the
Master Server.
Table A–7 Directories Installed for
the Master Server
|
Directory
|
Contents
|
|
\server\config
|
Master Server Configuration files
|
|
\server\data
|
Master Server data files
|
|
\server\bin
|
Master Server Executable files
|
|
\server\lib
|
Master Server-specific library files
|
|
\server\postgres
|
Bundled copy of Postgres
|
|
\server\cygwin
|
Bundled subset of Red Hat cygwin
|
|
\server\tomcat
|
Bundled copy of Apache Tomcat
|
|
\server\webapp
|
Browser Interface Web Application
|
|
\server\setup
|
Miscellaneous files used to initialize the Master Server
|
|
\server\data\tmp
|
Master Server temporary directory with permissions set to 777
|
|
\server\README
|
Text license agreement
|
The following table lists the directories installed for the
Local Distributor.
Table A–8 Directories Installed for
the Local Distributor
|
Directory
|
Contents
|
|
\ld\config
|
Local Distributor configuration files
|
|
\ld\bin
|
Local Distributor executable files
|
|
\ld\lib
|
Local Distributor library files
|
|
\ld\data
|
Local Distributor-specific data
|
|
\ld\data\tmp
|
Local Distributor temporary directory
|
|
\ld\jvm\jre\bin
|
Local Distributor JRE proxy
|
|
\ld\README
|
Text license agreement
|
The following table lists the directories installed for the
Remote Agent.
Table A–9 Directories Installed for
the Remote Agent
|
Directory
|
Contents
|
|
\agent\config
|
Remote Agent configuration files
|
|
\agent\bin
|
Remote Agent executable files
|
|
\agent\lib
|
Remote Agent library files
|
|
\agent\data
|
Remote Agent-specific data
|
|
\agent\work
|
Default directory for execution of execNatives
|
|
\agent\data\tmp
|
Remote Agent temporary directory
|
|
\agent\jvm\jre\bin
|
Remote Agent JRE proxy
|
|
\agent\README
|
Text license agreement
|
The following table lists the directories installed for the
CLI Client.
Table A–10 Directories Installed for
the CLI Client
|
Directory
|
Contents
|
|
\cli\config
|
CLI configuration files
|
|
\cli\bin
|
CLI executable files
|
|
\cli\lib
|
CLI library files
|
|
\cli\data
|
CLI specific data
|
|
\cli\data\tmp
|
CLI temporary directory with permissions set to 777
|
|
\cli\README
|
Text license agreement
|
Cygwin
To facilitate interoperability with applications running on
UNIX and Linux systems, the Windows version of the software includes
a subset of the Red Hat cygwin UNIX environment.
The following description of cygwin comes from
the official Cygwin web site at http://www.cygwin.com.
Cygwin is a UNIX environment, developed by Red Hat,
for Windows. It consists of two parts: - A DLL (cygwin1.dll) which
acts as a UNIX emulation layer providing substantial UNIX API functionality.
- A collection of tools, ported from UNIX, which provide UNIX/Linux
look and feel. The Cygwin DLL works with all non-beta, non “release
candidate”, ix86 versions of Windows since Windows 95, with
the exception of Windows CE.
Actions Performed by the Windows Installation
Scripts
The Windows Master Server installation script performs the following
actions:
-
Copies all installation contents to the directories
you specified.
-
Sets up the registry entries for the proper mount
points for cygwin.
-
Registers the cygipc service.
-
Registers the postmaster service with a dependency
on the cygipc service.
-
Registers the Master Server service with a dependency
on the postmaster service.
-
Creates a Start menu shortcut.
-
If you selected SSL as a communications protocol,
it runs scripts to generate the configuration files that are needed
for SSL.
The Windows Local Distributor installation script performs the
following actions:
-
Copies the installation contents to the directories
you specified.
-
If you selected SSL as a communications protocol,
it runs scripts to generate the configuration files that are needed
for SSL.
-
Registers the Local Distributor service.
-
Creates a Start menu shortcut.
-
If you requested that the installation script start
the Local Distributor, it starts the Local Distributor.
The Windows Remote Agent installation script performs the following
actions:
-
Copies the installation contents to the directories
you specified.
-
If you selected SSL as a communications protocol,
it runs scripts to generate the configuration files that are needed
for SSL.
-
Registers the Remote Agent service.
-
Creates a Start menu shortcut.
The Windows CLI Client installation script performs the following
actions:
-
Copies the installation contents to the directories
you specified.
-
If you selected SSL as a communications protocol,
it runs scripts to generate the configuration files that are needed
for SSL.
-
Creates a Start menu shortcut.