This chapter describes how to install Oracle Communications Services Gatekeeper.
Before installing Services Gatekeeper, read these chapters:
You must install Services Gatekeeper on every server in your implementation. You must install the software in a directory that resides on the server's local file system.
You install Services Gatekeeper by using a generic installer that works on any supported operating system and for both 64-bit and 32-bit platforms.
The generic installer does not include a bundled JDK. The JDK must already be installed when you use the generic installer.
You must download and install a supported JDK on the target system before installing Services Gatekeeper. See ”Installing the JDK and JCE” in Services Gatekeeper Getting Started Guide for instructions.
To create an installation log, add the following option to any of the commands that launch the installer:
-log=logfilename
where logfilename is a name that you assign to the log file.
For example, the following command runs the installer in GUI mode and creates a log file named install_log containing the installation's output.
java -jar ocsg_multitier_generic.jar -log=install_log
This section describes how to install Services Gatekeeper in GUI mode.
Important:
Installing Services Gatekeeper on Windows is supported only for development and test environments; it is not supported for production.
If you are installing on Windows, you must log in as an administrator.
After starting the installer, you can cancel the installation at any time by clicking Exit.
To install Services Gatekeeper in GUI mode:
Log in to the target system.
Download the Services Gatekeeper installer from the Oracle software delivery website:
Change to the directory where you downloaded the software.
Start the installer.
To start the installer on a system that uses a 32/64-bit hybrid JDK, enter:
java -d64 -jar ocsg_multitier_generic.jar [-log=logfilename]
To start the installer on a 32-bit system, enter:
java -jar ocsg_multitier_generic.jar [-log=logfilename]
After the installer starts, the Welcome screen appears.
Click Next.
The Installation Location screen appears.
In the Oracle Home field, enter the full path to the directory of your Middleware_home or use the Browse button to locate the directory.
The Middleware_home directory is the central directory for all Oracle products installed on the target system.
To see a list of Services Gatekeeper products that are currently installed in the directory, click View.
Click Next.
The Installation Type screen appears.
Specify the components to install on this system by doing one of the following:
To install only the Administration Server, select Administration Server and click Next.
To install only the Network Tier, select Network Tier and click Next.
To install only the Portal server:
Select Portal and click Next.
The Portal Parameters screen appears.
In the Access Tier Servers field, enter the address for each Access Tier server in your Services Gatekeeper implementation. The address uses the format IPAddress:Port. Each address must appear on its own line.
The IP address and port of the backend server must match the IP address and port of the Access Tier. To view the Access Tier server port, in the Administration Console, click Servers, then AT Server Name, and then Listen Port.
Click Next.
To install only the Access Tier, select Access Tier and click Next.
To install multiple Services Gatekeeper components:
Select Custom Installation and click Next.
The Features to Install screen appears.
Select the checkbox for each component that you want to install on this system. To install all of the components, select the Oracle Communication Services Gatekeeper checkbox.
Click Next.
The Prerequisite Checks screen appears.
The screen automatically tests your system to ensure that it meets all operating system and JDK software requirements:
A green check mark indicates that your system passed the prerequisite check.
A red circle indicates a problem. The bottom of the screen shows a short error message to help you troubleshoot the problem. Fix the error and click Rerun to perform the prerequisite checks again. To continue the installation without fixing the problem, click Skip.
Click Next.
The Installation Summary screen appears.
Ensure that the listed installation location and feature sets to install are correct.
If the list is not correct, you can use the Back button to make corrections.
To save the information to a response file so you can install the component later, click Save Response File and specify the name and location of the response file.
Click Install to start the installation.
The Installation Progress screen appears, and a progress bar indicates the status of the installation process.
Click Next.
When the Installation Complete screen appears, do one of the following:
Important:
If you plan to use Services Gatekeeper with an IPv6 network, do not configure the domain now. You must perform certain post-installation tasks first.To configure your Services Gatekeeper domain now, click Finish.
The WebLogic Server Configuration Wizard starts.
To complete installation without configuring your domain, deselect Automatically Launch the Configuration Wizard and click Finish.
The Services Gatekeeper installer exits.
After installation completes, the WebLogic Server Configuration Wizard starts by default. For information about how to configure your Services Gatekeeper domain, see "Configuring the Domain in GUI Mode".
Silent mode is a way of setting installation options once and then using those settings to duplicate the installation on many machines. The installation program reads your settings from a Response File that you create prior to beginning the installation. The installation program does not display any options during the installation process. Silent-mode installation works on Windows, Solaris, and Linux systems.
The entries in the Response File (response.rsp) correspond to the prompts that you would see if you used GUI mode.
Incorrect entries in the Response File can cause the installation to fail. To help you determine the cause of a failure, Oracle recommends that you create a log file when you start the installation.
The following is a sample version of the Response File. Your input may be slightly different, depending on your installation.
[ENGINE]
#DO NOT CHANGE THIS.
Response File Version=1.0.0.0.0
[GENERIC]
#The Oracle home location. This can be an existing Oracle Home or a new Oracle Home.
ORACLE_HOME=c:\oracle\gatekeeper
#Set this variable value to the Installation Type selected (for example, WebLogic Server, Coherence, Complete with Examples).
INSTALL_TYPE=Complete with Examples
#Provide the My Oracle Support Username. If you want to ignore Oracle Configuration Manager configuration, provide an empty string
#for the user name.
MYORACLESUPPORT_USERNAME=
#Provide the My Oracle Support Password
MYORACLESUPPORT_PASSWORD=<support_password>
#Set this to true if you want to decline the security updates. Setting this to true and providing an empty string for the My Oracle Support
#username will ignore the Oracle Configuration Manager configuration.
DECLINE_SECURITY_UPDATES=true
#Set this to true if My Oracle Support Password is specified.
SECURITY_UPDATES_VIA_MYORACLESUPPORT=false
#Provide the Proxy Host.
PROXY_HOST=
#Provide the Proxy Port.
PROXY_PORT=
#Provide the Proxy Username.
PROXY_USER=
#Provide the Proxy Password.
PROXY_PWD=<SECURE VALUE>
#Type String (URL format) Indicates the OCM Repeater URL which should be of the format [scheme[Http/Https]]://[repeater host]:[repeater port]
COLLECTOR_SUPPORTHUB_URL=
When run in silent mode, the installation program generates exit codes that indicate the success or failure of the installation. Table 5-1 describes these exit codes:
Table 5-1 Installation Program Exit Codes
| Code | Description |
|---|---|
|
0 |
Installation completed successfully. |
|
-1 |
Installation failed due to a fatal error. |
|
-2 |
Installation failed due to an internal XML parsing error. |
When you start the silent-mode installation process from a script, you can use the echo command to have these exit codes displayed to the console. The following is a sample command file that invokes the installer in silent mode and sends the exit codes to the console.
Example 5-1 Script that Returns Exit Codes
rem Execute the installer in silent mode
@echo off
java -jar ocsg_multitier_generic.jar -silent -responseFile=/home/use/bin/response.rsp -log=logfilename
@rem Return an exit code to indicate success or failure of installation
set exit_code=%ERRORLEVEL%
@echo.
@echo Exitcode=%exit_code%
@echo.
@echo Exit Code Key
@echo ---------------
@echo 0=Installation completed successfully
@echo -1=Installation failed due to a fatal error
@echo -2=Installation failed due to an internal XML parsing error
@echo.
To install Services Gatekeeper in silent mode on any supported platform:
Log in to the target system.
Download the Services Gatekeeper installer from the Oracle software delivery website:
Create a response.rsp file, as described in "About the Response File".
Change to the directory where you downloaded the software.
Start the installer by entering the following command:
java -jar ocsg_multitier_generic.jar -silent -responseFile ResponseFile
where ResponseFile is the full path and name of the Response File. For example, /home/use/bin/response.rsp.
Check whether the installer completed successfully by retrieving the exit codes, as described in "Returning Exit Codes to the Console".
If you want to install:
Services Gatekeeper Reports, see "Installing Services Gatekeeper Reports".
Services Gatekeeper Platform Test Environment (PTE), see "Installing the Platform Test Environment".
Services Gatekeeper Application Test Environment (ATE), see "Installing the Application Test Environment".
Otherwise, perform the tasks in "Services Gatekeeper Post-Installation Tasks".