8 Extending the Domain with Oracle Directory Integration Platform and ODSM

Oracle Directory Integration Platform is a Java EE application that enables you to integrate your applications and directories, including third-party LDAP directories, with Oracle Internet Directory.

Oracle Directory Integration Platform includes services and interfaces that allow you to deploy synchronization solutions with other enterprise repositories. It can also be used to provide Oracle Internet Directory interoperability with third party metadirectory solutions.

Oracle Directory Services Manager is a unified graphical user interface (GUI) for managing instances of Oracle Internet Directory and Oracle Virtual Directory. Oracle Directory Services Manager enables you to configure the structure of the directory, define objects in the directory, add and configure users, groups, and other entries.

This chapter describes how to install and configure Oracle Directory Integration Platform (DIP) and Oracle Directory Services Manager (ODSM).

Oracle Directory Integration Platform is an optional product. If it is not required in your environment, do not configure it.

This chapter includes the following topics:

8.1 Extending the Oracle WebLogic Domain with Oracle Directory Integration Platform and ODSM

The application tier consists of multiple computers hosting the Oracle Directory Integration Platform, Oracle Directory Services Manager, and Oracle Access Manager instances. In the complete configuration, requests are balanced among the instances on the application tier computers to create a high-performing, fault tolerant application environment.

Note:

Oracle Directory Integration Platform uses Quartz to maintain its jobs and schedules in the database. For the Quartz jobs to be run on different Oracle Directory Integration Platform nodes in a cluster, it is recommended that the system clocks on the cluster nodes be synchronized.

Follow these steps to install and configure Oracle Directory Integration Platform and Oracle Directory Services Manager on IDMHOST1:

  1. Ensure that the system, patch, kernel and other requirements are met. These are listed in the Oracle Fusion Middleware Installation Guide for Oracle Identity Management manual in the Oracle Fusion Middleware documentation library for the platform and version you are using.

  2. If you plan on provisioning the Instance Home or the Managed Server domain directory on shared storage, ensure that the appropriate shared storage volumes are mounted on IDMHOST1 as described in Section 2.4, "Shared Storage and Recommended Directory Structure."

  3. Ensure that port 7006 is not in use by any service on the computer by issuing these commands for the operating system you are using. If a port is not in use, no output is returned from the command.

    On UNIX:

    netstat -an | grep "7006"
    

    If the port is in use (if the command returns output identifying the port), you must free it.

    On UNIX:

    Remove the entries for port 7006 in the /etc/services file and restart the services, as described in Section 20.1, "Starting and Stopping Oracle Identity Management Components," or restart the computer.

  4. If you plan on provisioning the Instance Home or the Managed Server domain directory on shared storage, ensure that the appropriate shared storage volumes are mounted on IDMHOST1 as described in Section 2.4, "Shared Storage and Recommended Directory Structure."

  5. Copy the staticports.ini file from the Disk1/stage/Response directory to a temporary directory.

  6. Edit the staticports.ini file that you copied to the temporary directory to assign the following custom port:

    Port Value

    ODSM Server Port No.

    7006


  7. Start the Oracle Identity Management 11g Configuration Assistant by running the config.sh script located under the IDM_ORACLE_HOME/bin directory on IDMHOST1. For example:

    /u01/app/oracle/product/fmw/idm/bin/config.sh
    
  8. On the Welcome screen, click Next.

  9. On the Select Domain screen, select Extend Existing Domain and enter the domain details:

    • Hostname: ADMINVHN.mycompany.com

    • Port: 7001

    • User Name: weblogic

    • User Password: user password

    Click Next.

  10. A dialog box with the following message appears:

    The selected domain is not a valid Identity Management domain or the installer
    cannot determine if it is a valid domain. If you created the domain using the
    Identity Management installer, you can ignore this message and continue. If
    you did not create the domain using the Identity Management installer, refer
    to the Identity Management documentation for information on how to verify the
    domain is valid.
    

    Click Yes to continue.

    This is a benign warning that you can ignore.

  11. On the Specify Installation Location screen, specify the following values (the values for the Oracle Middleware Home Location and the Oracle Home Directory fields are prefilled. The values default to the Middleware home and Oracle home previously installed on IDMHOST1 in Section 6.1, "Enabling ADMINVHN on IDMHOST1":

    • Oracle Middleware Home Location: /u01/app/oracle/product/fmw

    • Oracle Home Directory: idm

    • WebLogic Server Directory: /u01/app/oracle/product/fmw/wlserver_10.3

    • Oracle Instance Location: /u01/app/oracle/admin/ods_inst1

    • Oracle Instance Name: ods_inst1

    Click Next.

  12. On the Specify Email for Security Updates screen, specify these values:

    • Email Address: Provide the email address for your My Oracle Support account.

    • Oracle Support Password: Provide the password for your My Oracle Support account.

    • Check the check box next to the I wish to receive security updates via My Oracle Support field.

    Click Next.

  13. On the Configure Components screen, select the following components:

    • Oracle Directory Integration Platform

    • Management Components - Oracle Directory Services Manager

    Deselect all the other components.

    Select the Clustered check box.

    Click Next.

  14. On the Configure Ports screen, select Specify Ports Using Configuration File and enter the full path name to the staticports.ini file that you edited in the temporary directory

    Click Next.

  15. On the Specify OID Details screen, specify the following:

    • Hostname: oididstore.mycompany.com

    • SSL_Port: 636

    • Username: cn=orcladmin

    • Password: ******

    Click Next.

  16. On the Specify Schema Database screen, specify the following values:

    • Connect String:

      oiddbhost1-vip.mycompany.com:1521:idmdb1^oiddbhost2-vip.mycompany.com:1521:idmdb2@oidedg.mycompany.com
      

      Notes:

      • The Oracle RAC database connect string information must be provided in the format:

        host1:port1:instance1^host2:port2:instance2@servicename

      • During this installation, it is not required for all the Oracle RAC instances to be up. If one Oracle RAC instance is up, the installation can proceed.

      • It is required that the information provided is complete and accurate. Specifically, the correct host, port, and instance name must be provided for each Oracle RAC instance, and the service name provided must be configured for all the specified Oracle RAC instances.

        Any incorrect information entered in the Oracle RAC database connect string has to be corrected manually after the installation.

      • If you are using Oracle Database 11.2, replace the vip addresses and port with the 11.2 SCAN address and port.

    • User Name: ODSSM

    • Password: ******

    Click Next.

  17. On the Installation Summary screen, review the selections to ensure that they are correct (if they are not, click Back to modify selections on previous screens), and click Configure.

  18. On the Configuration Progress screen, multiple configuration assistants are launched in succession; this process can be lengthy. Wait until it completes.

  19. On the Installation Complete screen, click Finish to confirm your choice to exit.

8.2 Expanding the Oracle Directory Integration Platform and ODSM Cluster

This section includes the steps for extending the WebLogic Server Domain on IDMHOST2.

This section contains the following topics:

8.2.1 Installing and Configuring Oracle Directory Integration Platform and ODSM on IDMHOST2

Follow these steps to install and configure Oracle Directory Integration Platform and Oracle Directory Service Manager on IDMHOST2:

  1. Ensure that the system, patch, kernel and other requirements are met. These are listed in the Oracle Fusion Middleware Installation Guide for Oracle Identity Management manual in the Oracle Fusion Middleware documentation library for the platform and version you are using.

  2. If you plan on provisioning the Instance Home or the Managed Server domain directory on shared storage, ensure that the appropriate shared storage volumes are mounted on IDMHOST2 as described in Section 2.4, "Shared Storage and Recommended Directory Structure."

  3. Ensure that port number 7006 is not in use by any service on the computer by issuing this command for the operating system you are using. If a port is not in use, no output is returned from the command.

    On UNIX:

    netstat -an | grep "7006"
    

    If the port is in use (if the command returns output identifying the port), you must free it.

    On UNIX:

    Remove the entries for port 7006 in the /etc/services file if the port is in use by a service and restart the services, as described in Section 20.1, "Starting and Stopping Oracle Identity Management Components," or restart the computer.

  4. Copy the staticports.ini file from the Disk1/stage/Response directory to a temporary directory.

  5. Edit the staticports.ini file that you copied to the temporary directory to assign the following custom port:

    Port Value

    ODSM Server Port No.

    7006


  6. Start the Oracle Identity Management 11g Configuration Assistant by running the config.sh script located under the IDM_ORACLE_HOME/bin directory on IDMHOST2. For example:

    /u01/app/oracle/product/fmw/idm/bin/config.sh
    
  7. On the Welcome screen, click Next.

  8. On the Select Domain screen, select the Expand Cluster option and specify these values:

    • Hostname: ADMINVHN.mycompany.com

    • Port: 7001

    • UserName: weblogic

    • User Password: password for the webLogic user

    Click Next.

  9. A dialog box with the following message appears:

    The selected domain is not a valid Identity Management domain or the installer
    cannot determine if it is a valid domain. If you created the domain using the
    Identity Management installer, you can ignore this message and continue. If you
    did not create the domain using the Identity Management installer, refer to the
    Identity Management documentation for information on how to verify the domain
    is valid.
    

    Click YES to continue.

    This is a benign warning that you can safely ignore.

  10. On the Specify Installation Location screen, specify the following values. The values for the Oracle Middleware Home Location and the Oracle Home Directory fields are prefilled. The values default to the Middleware home and Oracle home previously installed on IDMHOST1 in Section 6.1, "Enabling ADMINVHN on IDMHOST1."

    • Oracle Middleware Home Location: /u01/app/oracle/product/fmw

    • Oracle Home Directory: idm

    • WebLogic Server Directory: /u01/app/oracle/product/fmw/wlserver_10.3

    • Oracle Instance Location: /u01/app/oracle/admin/ods_inst2

    • Oracle Instance Name: ods_inst2

    Click Next.

  11. On the Email for Security Updates screen, specify these values:

    • Email Address: Provide the email address for your My Oracle Support account.

    • Oracle Support Password: Provide the password for your My Oracle Support account.

    • Check the check box next to the I wish to receive security updates via My Oracle Support field.

    Click Next.

  12. On the Configure Components screen, de-select all the products except Oracle DIP and Management Components and then click Next.

  13. On the Configure Ports screen, select Specify Ports Using Configuration File and enter the full path name to the staticports.ini file that you edited in the temporary directory.

    Click Next.

  14. On the Installation Summary screen, review the selections to ensure that they are correct (if they are not, click Back to modify selections on previous screens), and click Configure.

  15. On the Configuration Progress screen, multiple configuration assistants are launched in succession; this process can be lengthy. Wait until it completes.

  16. On the Installation Complete screen, click Finish to confirm your choice to exit.

8.2.2 Post-Installation Step: Copying Oracle Directory Integration Platform to wls_ods2

Ignore this section if you are not using Oracle Directory Integration Platform.

In the previous section, the installer created a second Managed Server, WLS_ODS2 on IDMHOST2. However, the Oracle Directory Integration Platform application is not deployed to the WLS_ODS2 Managed Server.

To complete the installation and configuration of the Oracle Directory Integration Platform and Oracle Directory Services Manager applications on IDMHOST2, proceed as follows:

On IDMHOST1, copy the ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/config/fmwconfig/servers/wls_ods1/applications directory to the ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/config/fmwconfig/servers/wls_ods2 directory. For example:

cp -rp ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/config/fmwconfig/servers/wls_ods1/applications  ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/config/fmwconfig/servers/wls_ods2/ 

During wls_ods2 startup, the application is automatically propagated to IDMHOST2.

8.2.3 Configure the Enterprise Manager Agents

All the Oracle Fusion Middleware components deployed in this enterprise are managed by using Oracle Enterprise Manager Fusion Middleware Control. To manage DIP and ODSM with this tool, you must configure the EM agents with the correct monitoring credentials. Follow these steps to complete this task:

  1. Use a web browser to access Oracle Enterprise Manager Fusion Middleware Control at http://ADMINVHN.mycompany.com:7001/em. Log in as the weblogic user.

  2. From the Domain Home Page, navigate to the Agent-Monitored Targets page using the menu under Farm -> Agent-Monitored Targets.

    • Click the Configure link to go to the Configure Target Page.

    • On the Configure Target Page, click Change Agent and choose the correct agent for the host.

    • Update the WebLogic monitoring user name and the WebLogic monitoring password. Enter weblogic as the WebLogic monitoring user name and the password for the weblogic user as the WebLogic monitoring password.

    • Click OK to save your changes.

8.3 Provisioning the Managed Servers in the Managed Server Directory

This section provides the steps to provision the Managed Server on the local disk. Proceed as follows:

  1. Stop the ODS instances on both IDMHOST1 and IDMHOST2. Follow the steps in Section 20.1, "Starting and Stopping Oracle Identity Management Components"

  2. On IDMHOST1, pack the Managed Server domain using the pack command located under the ORACLE_COMMON_HOME/common/bin directory. Make sure to pass -managed=true flag to pack the Managed Server. Type:

    ORACLE_COMMON_HOME/common/bin/pack.sh -managed=true \
       -domain=path_to_adminServer_domain -template=templateName.jar \
       -template_name=templateName
    

    For example

    ORACLE_COMMON_HOME/common/bin/pack.sh -managed=true \
      -domain=/u01/app/oracle/admin/IDMDomain/aserver/IDMDomain \
      -template=/u01/app/oracle/product/fmw/templates/managedServer.jar \
      -template_name=ManagedServer_Template
    
  3. Unpack the Managed Server to the managed server directory on IDMHOST1 using the unpack command located under the ORACLE_COMMON_HOME /common/bin directory.

    ORACLE_COMMON_HOME/common/bin/unpack.sh -domain=path_to_domain_on_localdisk \  
       -template=templateName.jar -app_dir=path_to_appdir_on_localdisk
    

    For example:

    ORACLE_COMMON_HOME/common/bin/unpack.sh \
       -domain=/u01/app/oracle/admin/IDMDomain/mserver/IDMDomain \
       -template=/u01/app/oracle/product/fmw/templates/managedServer.jar \
       -app_dir=/u01/app/oracle/admin/IDMDomain/mserver/applications
    
  4. Copy the Managed Server template directory from IDMHOST1 to IDMHOST2. For Example:

    scp -rp /u01/app/oracle/products/fmw/templates user@IDMHOST2:/u01/app/oracle/products/fmw/templates
    
  5. Unpack the Managed Server to the managed server directory on IDMHOST2 using the unpack command located under the ORACLE_COMMON_HOME/common/bin directory.

    ORACLE_COMMON_HOME/common/bin/unpack.sh -domain=path_to_domain_on_localdisk \
       -template=templateName.jar -app_dir=path_to_appdir_on_localdisk
    

    For example:

    ORACLE_COMMON_HOME/common/bin/unpack.sh \
       -domain=/u01/app/oracle/admin/IDMDomain/mserver/IDMDomain \
       -template=/u01/app/oracle/product/fmw/templates/managedServer.jar \
       -app_dir=/u01/app/oracle/admin/IDMDomain/mserver/applications  
    
  6. Start the ODS instances on both IDMHOST1 and IDMHOST2. Follow the steps in Section 20.1, "Starting and Stopping Oracle Identity Management Components."

  7. Delete the ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/servers/wls_ods1 directory on IDMHOST1 and the ORACLE_BASE/admin/IDMDomain/aserver/IDMDomain/servers/wls_ods2 directory on IDMHOST2.

    These directories are created by the Oracle Universal Installer when the domain is originally configured and are no longer required after the provisioning the Managed Server to the managed server directory.

8.4 Configuring ODSM to work with the Oracle Web Tier

This section describes how to configure Oracle Directory Services Manager to work with the Oracle Web Tier.

This section contains the following topics:

8.4.1 Prerequisites

Before proceeding, ensure that the following tasks have been performed:

  1. Install Oracle Web Tier on WEBHOST1 and WEBHOST2.

  2. Install and configure ODSM and Oracle Directory Integration Platform on IDMHOST1 and IDMHOST2.

  3. Configure the load balancer with a virtual host name (admin.mycompany.com) pointing to web servers WEBHOST1 and WEBHOST2.

8.4.2 Configuring Oracle HTTP Servers to Access the ODSM Console

On each of the web servers on WEBHOST1 and WEBHOST2, a file called admin.conf was created in the directory ORACLE_INSTANCE/config/OHS/component/moduleconf, as described Section 6.9, "Configuring Oracle HTTP Server for the WebLogic Administration Server." Edit this file and add the following lines within the virtual host definition:

<Location /odsm>
   SetHandler weblogic-handler
   WebLogicCluster idmhost1.mycompany.com:7005,idmhost2.mycompany.com:7006
 </Location> 

After editing the file should look like this:

NameVirtualHost *:80
 
<VirtualHost *:80>
 
   ServerName admin.mycompany.com:80
   ServerAdmin you@your.address
   RewriteEngine On
   RewriteOptions inherit
 
   # Admin Server and EM
   <Location /console>
      SetHandler weblogic-handler
      WebLogicHost ADMINVHN
      WeblogicPort 7001
   </Location>
 
   <Location /consolehelp>
      SetHandler weblogic-handler
      WebLogicHost ADMINVHN
      WeblogicPort 7001
   </Location>
 
   <Location /em>
      SetHandler weblogic-handler
      WebLogicHost ADMINVHN
      WeblogicPort 7001
   </Location>
 
   <Location /odsm>
      SetHandler weblogic-handler 
      WebLogicCluster idmhost1.mycompany.com:7005,idmhost2.mycompany.com:7006
   </Location>
 
</VirtualHost>

Restart the Oracle HTTP Server, as described in Section 20.1, "Starting and Stopping Oracle Identity Management Components."

8.5 Validating the Application Tier Configuration

This section includes steps for validating Oracle Directory Services Manager and Oracle Directory Integration Platform.

This section contains the following topics:

8.5.1 Validating Oracle Directory Services Manager

Follow these steps to validate the Oracle Directory Services Manager installation:

  1. In a web browser, go to Oracle Directory Services Manager (ODSM) at:

    http://hostname.mycompany.com:port/odsm
    

    For example, on IDMHOST1, enter this URL:

    http://idmhost1.mycompany.com:7006/odsm
    

    and on IDMHOST2, enter this URL:

    http://idmhost2.mycompany.com:7006/odsm
    
  2. Access ODSM through the load balancer address: http://admin.mycompany.com/odsm

  3. Validate that Oracle Directory Services Manager can create connections to Oracle Internet Directory. Follow these steps to create connections to Oracle Internet Directory:

    To create connections to Oracle Internet Directory, create a connection to the Oracle Internet Directory on each ODSM instance separately. Even though ODSM is clustered, the connection details are local to each node. Proceed as follows:

    1. Launch Oracle Directory Services Manager from IDMHOST1:

      http://idmhost2.mycompany.com:7006/odsm
      
    2. Create a connection to the Oracle Internet Directory virtual host by providing the following information in ODSM:

      Server: oid.mycompany.com

      Port: 636

      Enable the SSL option

      User: cn=orcladmin

      Password: ldap-password

    3. Launch Oracle Directory Services Manager from IDMHOST2. Follow Step b to create a connection to Oracle Internet Directory from IDMHOST2

    Note:

    Accept the certificate when prompted.

8.5.2 Validating Oracle Directory Integration Platform

Validate the Oracle Directory Integration Platform installation by using the WLST dipStatus command. To run this command, follow these steps:

  1. Set the ORACLE_HOME environment variable to the directory where you installed the Identity Management binaries. For example:

    export ORACLE_HOME=IDM_ORACLE_HOME
    
  2. Set the WLS_HOME environment variable to the directory where you installed the WebLogic Server. For example:

    export WLS_HOME=/u01/app/oracle/product/fmw/wlserver_10.3
    
  3. Run the ORACLE_HOME/bin/dipStatus -h hostName -p port -D wlsuser command.

    For example, on IDMHOST1, the command and output look like this:

    ORACLE_HOME/bin/dipStatus -h idmhost1.mycompany.com -p 7006 -D weblogic
    [Weblogic user password]
    Connection parameters initialized.
    Connecting at idmhost1.mycompany.com:7006, with userid "weblogic"..
    Connected successfully.
    
    ODIP Application is active at this host and port.
    

    For example, on IDMHOST2, the command and output look like this:

    ORACLE_HOME/bin/dipStatus -h idmhost2.mycompany.com -p 7006 -D weblogic
    [Weblogic user password]
    Connection parameters initialized.
    Connecting at idmhost2.mycompany.com:7006, with userid "weblogic"..
    Connected successfully.
    
    ODIP Application is active at this host and port.
    

8.6 Backing Up the Application Tier Configuration

It is an Oracle best practices recommendation to create a backup after successfully completing the installation and configuration of each tier, or at another logical point. Create a backup after verifying that the installation so far is successful. This is a quick backup for the express purpose of immediate restoration in case of problems in later steps. The backup destination is the local disk. You can discard this backup when the enterprise deployment setup is complete. After the enterprise deployment setup is complete, you can initiate the regular deployment-specific Backup and Recovery process. For more details, see the Oracle Fusion Middleware Administrator's Guide.

For information on database backups, refer to the Oracle Database Backup and Recovery User's Guide.

To back up the installation to this point, follow these steps:

  1. Back up the web tier as described in Section 5.5, "Backing up the Web Tier Configuration."

  2. Back up the database. This is a full database backup, either hot or cold. The recommended tool is Oracle Recovery Manager.

  3. Back up the application tier instances by following these steps:

    1. Shut down the instance using opmnctl located under the ORACLE_INSTANCE/bin directory:

      ORACLE_INSTANCE/bin/opmnctl stopall
      
    2. Create a backup of the Middleware home on the application tier. On Linux, as the root user, type:

      tar -cvpf BACKUP_LOCATION/apptier.tar ORACLE_BASE 
      
    3. Create a backup of the Instance home on the application tier as the root user:

      tar -cvpf BACKUP_LOCATION/instance_backup.tar ORACLE_INSTANCE 
      
    4. Start up the instance using opmnctl located under the ORACLE_INSTANCE/bin directory:

      ORACLE_INSTANCE/bin/opmnctl startall
      
  4. Back up the Administration Server domain directory as described in Section 6.15, "Backing Up the WebLogic Domain."

  5. Back up the Oracle Internet Directory as described in Section 7.7, "Backing up the Oracle Internet Directory Configuration."

For information about backing up the application tier configuration, see Section 20.4, "Performing Backups and Recoveries."