Skip Headers
Oracle® Configuration Manager Companion Distribution Guide
Release 10.0.1
E14501-02
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

3 Oracle Support Hub

To upload the collected configuration data to Oracle, each Oracle Configuration Manager instance needs a connection to the Internet. Oracle Configuration Manager supports connecting either directly or through a proxy server. However, these techniques may be insufficient for network topologies in which systems have access to other internal systems but not to the Internet.

The Oracle Support Hub (formerly known as Oracle Configuration Manager Repeater) is designed to address this situation. It allows many Oracle Configuration Manager instances to connect to a single internal point (the Support Hub) and upload their configuration data, eliminating the need for each individual Oracle Configuration Manager instance to access the Internet.

The Support Hub currently ships with Enterprise Manager Grid Control release 10.2.0.5. Oracle is now making the Support Hub available outside of Grid Control 10.2.0.5 in the form of the Oracle Configuration Manager Companion Distribution kit.

This chapter provides the following:

3.1 What Is the Support Hub?

The Support Hub is an HTTP tunnel that conveys the configuration payload from individual Oracle Configuration Manager instances to the repository maintained at Oracle. The Support Hub is situated inside the customer network, so that it becomes the only point of access needed between inside the network and the outside Internet.

The Support Hub is not the same as a proxy server. If a proxy server can be used to connect from Oracle Configuration Manager instances to the Internet, then the Support Hub is not required. However, some network topologies do not even provide proxy server access from internal systems to the Internet; the proxy server (if available) only connects such a machine to the local intranet. In these cases, the proxy server can be used to access the Support Hub, which in turn accesses the Internet and Oracle.

Individual Oracle Configuration Manager instances communicate with a Support Hub using HTTP, whereas all communication from the Support Hub to Oracle (and thus across the Internet) is through HTTPS. The Support Hub does not interpret data passing through it (other than destination information). The configuration details being uploaded are encrypted such that only the endpoint at Oracle can read it, not the tunnel through which it passes. Configuration uploads are immediately transmitted to Oracle; there is no storage or staging of uploads at the Support Hub for later uploading.

3.1.1 Prerequisites

The following prerequisites apply when you are working with the Support Hub.

  • Supports WebLogic Server (WLS) 10.3.0 on both the Windows and Linux platforms.

  • Supports Oracle Application Server 10.1.2 and 10.1.4 on both the Windows and Linux platforms.

3.2 Installing the Support Hub

Locate the output of the companion distribution kit installation described in Chapter 1, "Introduction". Unzip the <dist_kit>/ocm_companion/distribution/oracle_support_hub-10.3.1.1.0.zip file into an Application Server or WebLogic home (<OCM_REPEATER_HOME>). It creates the Support Hub directory structure: <OCM_REPEATER_HOME>/ocm/repeater/.

Note the following:

3.2.1 OC4J Deployment

The Support Hub is an EAR file that is located in the ocm/repeater/ears directory. This EAR file is named OCMRepeater.ear and deployed with the use of the ocm/repeater/bin/oc4j_OCMRepeaterDeploy. sh file (on Linux systems) or the ocm/repeater/bin/oc4j_OCMRepeaterDeploy.bat file (on Windows systems). If the ORACLE_HOME variable is not set, it must be specified on the command line when deploying the Support Hub.

A singular configuration file, ocmrepeater.properties, is placed in the <OCM_REPEATER_HOME>/ocm/repeater/config directory.

The deployment of the Support Hub is independent of any Oracle Management Service deployment and configuration. The deployment of the Support Hub and creation of the OC4J component through the use of the oc4j_OCMReapeterDeploy script automatically starts the Support Hub upon successful deployment.

3.2.1.1 Preparing to Deploy

The following is an example of deploying the Support Hub.

[prompt]$ ocm/repeater/bin/oc4j_OCMRepeaterDeploy.sh <ORACLE_HOME>

opmnctl: stopping opmn managed processes...
==================================================================================
opmn id=sys26:6255
   no processes matched this request 
1
Application:     OCMRepeater
Component Name:  OCMRepeater
Component Type:  OC4J
Instance:        /scratch/test/oracle.abcde.us.oracle.com

opmnctl:  starting opmn managed processes...

3.2.2 WebLogic Deployment

This section describes the deployment of the Support Hub in the WebLogic environment.

3.2.2.1 Preparing to Deploy

Deployment of the Support Hub is done to an existing WebLogic Server. No attempt is made to create and configure a Server by the deployment script. On Windows, the Support Hub install directory cannot contain spaces.

The server needs to be started with the following Java Option:

-Docm.repeater.home=<InstallRoot>

One way to add this option is to insert the following line in the setDomainEnv.sh script located under the domain directory of the Server and bouncing the Server.

JAVA_OPTIONS="${JAVA_OPTIONS} -Docm.repeater.home=/scratch/w12/ocmrepeater"

Note that the kit in the previous example is unzipped under the /scratch/w12/ocmrepeater directory.

3.2.2.2 Using the Deployment Script

The Support Hub is an EAR file that is present in the ocm/repeater/ears directory. This ear file is named OCMRepeater.ear and deployed with the use of the ocm/repeater/bin/wls_OCMRepeaterDeploy.sh file or the ocm/repeater/bin/wls_OCMRepeaterDeploy.bat file. The ear is deployed in a user-specified Server.

Usage:
wls_OCMRepeaterDeploy.{sh | bat} <Server> <DomainRoot> <AdminUrl> [<InstallRoot>]
where:
<Server>: WebLogic Server to which 'OCMRepeater' Application needs to be deployed
<DomainRoot>: Root Directory of the WLS Domain in which the Server resides
<AdminUrl>: URL of the AdminServer for the domain. [It must use t3 protocol in place of http.]
<InstallRoot>: Root directory where the kit is unzipped.

An example of the deployment follows:

> /scratch/wl2/ocmrepeater/ocm/repeater/bin/wls_OCMRepeaterDeploy.sh
 OCMRepeaterServer1 /scratch/product/wls2_10.3.0/user_projects/domains/base_
domain1 t3://example.com:7001 /scratch/wl2/ocmrepeater
########
# Note: /scratch/product/wls2_10.3.0/user_projects/domains/base_domain1/bin/setDomainEnv.sh should include:
#       JAVA_OPTIONS="${JAVA_OPTIONS} -Docm.repeater.home=/scratch/wl2/ocmrepeater"
########
Deploying OCMRepeater to OCMRepeaterServer1
Deprecated operation, activate, specified. Consider using deploy operation instead.
weblogic.Deployer invoked with options:  -adminurl t3://example.com:7001 -activate
 -name OCMRepeater -source
 /scratch/wl2/ocmrepeater/ocm/repeater/ears/OCMRepeater.ear -targets
 OCMRepeaterServer1
Please enter username:weblogic
Please enter a password for the user "weblogic":
<Jul 30, 2009 8:24:45 AM PDT> <Info> <J2EE Deployment SPI> <BEA-260121>
 <Initiating activate operation for application, OCMRepeater [archive:
 /scratch/wl2/ocmrepeater/ocm/repeater/ears/OCMRepeater.ear], to
 OCMRepeaterServer1 .>
Task 25 initiated: [Deployer:149026]activate application OCMRepeater on OCMRepeaterServer1.
Task 25 completed: [Deployer:149026]activate application OCMRepeater on OCMRepeaterServer1.
Target state: activate completed on Server OCMRepeaterServer1

Note:

If using a secure protocol (https) to connect to the AdminServer, you will need to specify additional SSL arguments in the environment.

Set JAVA_OPTIONS to the appropriate arguments to use before invoking the deployer script. Details regarding the Java Options are available at:

http://edocs.bea.com/wls/docs103/deployment/wldeployer.html

The SSL Arguments include:

[ -Dweblogic.security.TrustKeyStore=DemoTrust ]    
[ -Dweblogic.security.JavaStandardTrustKeystorePassPhrase=password ]    
[ -Dweblogic.security.CustomTrustKeyStoreFileName=filename           
  -Dweblogic.security.TrustKeystoreType=CustomTrust      
  [ -Dweblogic.security.CustomTrustKeystorePassPhrase=password ]
]    
[ -Dweblogic.security.SSL.hostnameVerifier=classname ]    
[ -Dweblogic.security.SSL.ignoreHostnameVerification=true ]

The following configuration files are placed under the <OCM_REPEATER_HOME>/ocm/repeater/config directory after a successful deployment:

  • ocmrepeater.properties required by the deployed Application

  • ocm_config.properties required by ocmrepeater.ctl

The Repeater application is Active after deployment as long as the Server to which it is deployed is running.

3.3 Managing the Support Hub

To manage the Support Hub, use the ocmrepeaterctl utility. This enables you to reconfigure or get status for the Support Hub. Prior to running this utility:

To check the status of the Support Hub, run the following command from the home where the Support Hub has been installed.

<OCM_REPEATER_HOME>/ocm/repeater/bin/ocmrepeaterctl status

This command provides useful information including any proxy settings being used by the Support Hub, the location of the log file, and whether the process is alive or not. Sample output for the OC4J environment:

[oracle@myhost oms10g]$ ocm/repeater/bin/ocmrepeaterctl status
Oracle Configuration Manager Repeater - Release: 10.3.1.1.0 - Production
Copyright (c) 2005, 2009, Oracle. All rights reserved.
Built 01/21/2009 07:14:57 PM
Install Root :/scratch/EMGC/OracleHomes/oms10g
Proxy Host :www-proxy.mycompany.com
Proxy Port :80
Proxy User :NONE
Logging Level :DEBUG, Rolling
Log File Location :/scratch/ EMGC/OracleHomes/oms10g/sysman/log/ocmrepeater.log
OCMRepeater | Alive

Sample output for the WebLogic environment:

Oracle Configuration Manager Repeater - Release: 10.3.1.1.0 - Production
Copyright (c) 2005, 2009, Oracle.  All rights reserved.
Built 07/29/2009 06:02:41 PM
 
Install Root          :/scratch/sumit/bea/ocmrepeater
Proxy Host            :NONE
Proxy Port            :NONE
Proxy User            :NONE
Logging Level         :WARN, Rolling
Log File Location     :/scratch/bea/ocmrepeater/ocm/repeater/log/ocmrepeater.log
 
 
Initializing WebLogic Scripting Tool (WLST) ...
 
Welcome to WebLogic Server Administration Scripting Shell
 
Type help() for help on available commands
 
Please enter your username [weblogic] :weblogic
Please enter your password [weblogic] :
Connecting to http://mywlshost.us.oracle.com:7001 with userid weblogic ...
Successfully connected to Admin Server 'AdminServer' that belongs to domain 'base_domain'.
 
Warning: An insecure protocol was used to connect to the
server. To ensure on-the-wire security, the SSL port or
Admin port should be used instead.
 
Current state of 'AdminServer' : RUNNING
Disconnected from weblogic server: AdminServer
 
 
Exiting WebLogic Scripting Tool.
 

This command can also be used to reconfigure the Support Hub by adding, removing, or changing any proxy server settings needed to connect to the Internet:

<OCM_REPEATER_HOME>/ocm/repeater/bin/ocmrepeaterctl configure

When using the configure parameter, you will be prompted for proxy server information. If a proxy server is not required, type NONE at the prompt. Otherwise enter the appropriate proxy server information, using the following format [username@]host:port. If a user name is specified, you will be prompted for a password.

Sample of running ocmrepeaterctl configure for OC4J follows:

> $ORACLE_HOME/ocm/repeater/bin/ocmrepeaterctl configure
Oracle Configuration Manager Repeater - Release: 10.3.1.1.0 - Production
Copyright (c) 2005, 2009, Oracle.  All rights reserved.
Built 07/25/2009 06:10:29 PM
 
Enter the proxy server details in this format:
    [<proxy-user>@]<proxy-host>[:<proxy-port>]
To specify no proxy, enter NONE
Proxy Specification:user1@www-proxy.mycompany.com:4321
Proxy Password:
Configuration saved to disk
Stopping Repeater...
opmnctl: stopping opmn managed processes...
Starting Repeater...
opmnctl: starting opmn managed processes...
 
OCMRepeater        | Alive

3.4 Configuring Oracle Configuration Manager Instances to Use the Support Hub

To use the Support Hub to upload configuration data to Oracle, those Oracle Configuration Manager instances must be a minimum version of Oracle Configuration Manager release 10.3.1. Configuring an Oracle Configuration Manager instance to use a Support Hub is done by first creating a response file using the emocmrsp utility, with the “-repeater” parameter and the URI at which the Support Hub can be accessed.

$ORACLE_HOME/ccr/bin/emocmrsp -repeater http://<hostname>[:<port>]

Specifying a port is optional; if none is selected, a default port of 80 is used. To use the Support Hub built into Enterprise Manager Grid Control, specify the same hostname and port used to access the Grid Control console in a web browser – however, make sure not to include any path information after the hostname and port (“/em/”, for instance).

Once the response file has been generated, it must be used to configure (or re-configure) the Oracle Configuration Manager instance. To do this, run the setupCCR (for initial configuration) or configCCR (for re-configuration) command with the –R parameter along with the name of the response file. For more information on using response files, see the Oracle Configuration Manager Installation and Administration Guide.

The response file is also used to re-configure an Oracle Configuration Manager instance when a Support Hub is no longer required to access the Internet. To do this, create a new response file using the emocmrsp command with the arguments -repeater NONE, and use that response file with configCCR -R to re-configure the Oracle Configuration Manager instance.

Note that if you want to reconfigure Oracle Configuration Manager to change parameters other than Support Hub usage (the My Oracle Support credentials associated with that system, for instance), you need not use a response file. Once a Support Hub is configured, it is maintained throughout any reconfiguration until it is explicitly removed.

To verify the Support Hub is being used to upload configuration data to Oracle, execute the command $ORACLE_HOME/ccr/bin/emCCR -verbose test. The results of this command will identify the Support Hub being used.

3.4.1 Restrictions

The following restrictions apply when you are working with the Support Hub.

  • You can only use one Support Hub in an OC4J installation or a WebLogic domain.

  • OCM instance must be release 10.3.1 or higher to be configured to use the Support Hub.

  • Oracle Configuration Manager instance running on IBM platforms cannot be configured to use the Support Hub.

3.5 Troubleshooting - Errors That May Occur

You may see the following errors when running Support Hub:

3.6 Common Questions

Q: Does the Support Hub support proxy servers?

A: Yes, if there is no direct connection found from the Support Hub to Oracle, you can specify proxy server details (supported authentication methods are basic or digest), just as with an individual Oracle Configuration Manager instance connecting to Oracle in the no-Support Hub case.

Q: What is the difference between the Repeater and the Support Hub?

A: The Repeater is the implementation of the Support Hub.

Q: How does configuring an Oracle Configuration Manager instance to use a Support Hub differ from configuring Oracle Configuration Manager in disconnected mode?

A: When configured to use a Support Hub, an Oracle Configuration Manager instance is running in connected mode – the difference is that the connection to Oracle is through the Support Hub rather than a direct connection or a connection using a proxy server. Systems that would have run in disconnected mode because they lacked a connection to Oracle can now run in connected mode, using the Support Hub to connect to Oracle. If an Oracle Configuration Manager instance is configured in disconnected mode, it cannot make use of a Support Hub.

Oracle Configuration Manager instance (version 10.3.1 or later) in disconnected mode can be switched to connected mode and configured to use a Support Hub by running configCCR -R with a response file. If the response file used was created by specifying a Support Hub argument in the emocmrsp command, subsequent to the re-configuration of the Oracle Configuration Manager instance, will automatically start using the Support Hub.