This chapter describes the configuration steps that are necessary to get an Oracle Unified Directory proxy instance up and running. The chapter provides an overview of the tested Oracle Unified Directory proxy deployments. Other deployments are possible, but might not have been tested extensively. For a description of the tested deployments, see Example Deployments Using the Proxy Server, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
To set up the proxy, you must have one or more remote LDAPv3-compliant directory servers. Oracle Unified Directory proxy has been tested with Oracle Unified Directory and Oracle Directory Server Enterprise Edition 11g Release 1 (11.1.1).
Before you start to set up the proxy, determine the type of deployment architecture that you want to implement from the following list:
Simple load balancing
Simple distribution
Distribution with load balancing
Failover between data centers
Distribution with failover between data centers
A global index catalog can be incorporated into any scenario that uses distribution. For information about creating a global index catalog, see Configuring Global Indexes By Using the Command Line in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
You can set up the proxy in two ways:
Graphical user interface (GUI). The GUI setup is a Java-based graphical installer that enables you to configure all the elements required for specific Oracle Unified Directory proxy deployments.
You can use the GUI setup only once per instance. If you want to modify an installation after you have run the GUI setup, you must use the dsconfig command.
Command-line interface (CLI). The interactive command-line setup prompts you for the first few steps of the Oracle Unified Directory proxy installation. To complete the deployment, you must configure a number of additional elements (such as distribution and/or load balancing) using the dsconfig command.
This chapter covers the following topics:
The following topics present a step by step installation using the oud-proxy-setup graphical interface, including configuration examples for simple deployments.
Before you run the command, make sure that you have determined the best deployment architecture, using the deployment scenarios that are described in Example Deployments Using the Proxy Server, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
The GUI setup wizard is organized as follows:
The left hand pane lists the steps of the setup process. The deployment sub-steps change, according to the type of deployment that you select.
The arrow in the left hand pane indicates the current step.
The main area on the right is the action pane, where you define your deployment.
At the bottom of the window you have the option to go back and forth (or quit) to modify and complete your installation.
The remaining tasks in this section walk you through the various types of proxy deployments that can be set up.
When you have installed the software, change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).
Run the oud-proxy-setup command to configure the proxy server installation.
(UNIX, Linux) $ oud-proxy-setup (Windows) C:\> oud-proxy-setup.bat
The utility launches the graphical installer and creates the Oracle Unified Directory proxy instance in OUD-base-location/instance-dir.
The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
The instance is created directly under OUD-base-location by default. To change the instance path, include the path relative to OUD-base-location when you set the INSTANCE_NAME variable. For example:
$ export INSTANCE_NAME=../../local/my-oud-proxy-instance
On the Welcome panel, click Next.
On the Server Settings panel, enter the following information:
Host Name: Enter the proxy server's host name or IP address.
The default is the local host name.
LDAP Listener Port: Enter the LDAP port for the proxy server.
The default port that is proposed is the first available port that ends with 389. On UNIX platforms, if you run the installer as a non-root user, the default is 1389, if available.
LDAP Secure Access: If you want to configure SSL, StartTLS, or both, click Configure.
Complete the following information:
SSL Access: Select Enable SSL and enter a valid port for secure LDAP operations.
The default secure port that is proposed is the first available port that ends with 636. On UNIX platforms, if you run the installer as a non-root user, the default is 1636, if available.
StartTLS Access: Select Enable StartTLS for LDAP.
Certificate: If you are in a testing environment, select Generate Self-Signed Certificate.
For production servers, select Use an Existing Certificate, and then select the Keystore Type. Enter the Keystore Path, and Keystore PIN if necessary.
Click OK to continue.
Administration Port: Enter the port that will be used for administration traffic.
The default administration port is 4444. For more information, see Managing Administration Traffic to the Server in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Root User DN: Enter the Root User DN, or keep the default, cn=Directory Manager.
Password: Enter the root user bind password.
Password (confirm): Re-enter the root user bind password.
Click Next.
The Deployment Options screen is displayed.
Select Use load balancing on a replicated data set from the Configuration Option drop-down menu.
Note:
If you select Configure later, only the server settings that you specified in the previous step are configured. You must then use the dsconfig command, or the ODSM interface, to configure your deployment.
Click Next.
The Back-End Servers screen is displayed.
Select the remote LDAP servers that hold the corresponding replicated data.
If your remote LDAP servers are Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Oracle Servers.
For Oracle Unified Directory servers:
Select Connect to a replicated Oracle Unified Directory server.
Enter the hostname, administration port, administration bind DN and password for the remote Oracle Unified Directory server.
Click Connect.
Accept the certificate.
Check the servers that should be part of the load balanced topology.
When you have entered the details of one directory server in a replicated topology, the setup wizard displays all other replicated servers in that topology.
Click OK.
For Oracle Directory Server Enterprise Edition servers:
Select Connect to a DSCC registry.
Enter the DSCC host name, DSCC port, protocol, and the Directory Service Manager credentials for the DSCC registry.
Check the servers that should be part of the load balanced topology.
The setup wizard displays all the Oracle Directory Server Enterprise Edition server instances that are registered in the DSCC registry.
Click OK.
If your remote LDAP servers are not Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Server.
Enter the server name, port and security settings.
The security settings you set here will determine the security between the Oracle Unified Directory proxy and remote LDAP servers. For more information about setting security options, see Configuring Security Between the Proxy and the Data Source, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Click Add.
Click Close when you have added all the remote LDAP servers for the load balanced topology.
Click Next.
The Load Balancing Options screen is displayed.
Choose a load balancing algorithm.
For information about the various load balancing algorithms, see Load Balancing Using the Proxy in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Set the load balancing algorithm properties or select Default Values.
When you have completed the installation, the properties can be modified. For more information, see Modifying Load Balancing Properties in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For proportional, set the weight. Requests are distributed between the remote LDAP servers based on the weight indicated.
For example, if you leave the default value of 1, then all servers will receive the same number of requests.
For failover, indicate the order in which the servers are used.
The server with a value of 0 is the highest priority server. The other servers are used only if there is a failure on the main server.
For saturation, set the order in which the servers are used as well as the saturation threshold of each server.
Requests are sent to the server with the highest priority (1) until it reaches the threshold indicated. The saturation threshold is the rate at which the server is considered saturated, or full. Typically this limit should be set lower than 100%.
For optimal, no additional configuration is required.
The active server is selected based on the saturation index, which is calculated automatically.
Enter the naming context, or suffix.
If the remote LDAP servers are online, the setup connects to them and displays the naming contexts that are available on the servers.
If no naming contexts are proposed, enter the DN of the naming context that you want to use, for example, dc=example,dc=com.
Click Next.
The Runtime options screen is displayed.
Click Change to configure any specific JVM settings, or click Next to run the server with the default JVM settings.
The Review screen is displayed.
Review the installation configuration.
If you need to make any modifications, use the Previous button.
To display the commands that will be launched for this installation, select Show Command from the drop down menu.
These commands are saved in a log file, in the logs folder. You can use these commands to run additional installations with similar deployment options later.
Click Finish to complete the installation.
When the installation is complete, you can use the dsconfig command to modify the installation. For more information, see Managing the Server Configuration With dsconfig in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
When you have installed the software, change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).
Run the oud-proxy-setup command to configure the proxy server installation.
(UNIX, Linux) $ oud-proxy-setup (Windows) C:\> oud-proxy-setup.bat
The utility launches the graphical installer and creates the Oracle Unified Directory proxy instance in OUD-base-location/instance-dir.
The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
The instance is created directly under OUD-base-location by default. To change the instance path, include the path relative to OUD-base-location when you set the INSTANCE_NAME variable. For example:
$ export INSTANCE_NAME=../../local/my-oud-proxy-instance
On the Welcome panel, click Next.
On the Server Settings screen, enter the following information:
Host Name: Enter the proxy server's host name or IP address.
The default is the local host name.
LDAP Listener Port: Enter the LDAP port for the proxy server.
The default port that is proposed is the first available port that ends with 389. On UNIX platforms, if you run the installer as a non-root user, the default is 1389, if available.
LDAP Secure Access: If you want to configure SSL, StartTLS, or both, click Configure.
Complete the following information:
SSL Access: Select Enable SSL and enter a valid port for secure LDAP operations.
The default secure port that is proposed is the first available port that ends with 636. On UNIX platforms, if you run the installer as a non-root user, the default is 1636, if available.
StartTLS Access: Click Enable StartTLS for LDAP.
Certificate: If you are in a testing environment, select Generate Self-Signed Certificate.
For production servers, click Use an Existing Certificate, and then click the Keystore Type. Enter the Keystore Path, and Keystore PIN if necessary.
Click OK.
Administration Port: Enter the port that will be used for administration traffic.
The default administration port is 4444. For more information, see Managing Administration Traffic to the Server in the Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Root User DN: Enter the Root User DN, or keep the default, cn=Directory Manager.
Password: Enter the root user bind password.
Password (confirm): Retype the root user bind password.
Click Next.
In the Deployment Options panel, select Use distribution on a partitioned data set from the Configuration Option drop-down menu.
If you select Configure later, only the server settings that you specified in the previous step are configured. You must then use the dsconfig command or the ODSM interface to configure your deployment.
Drag the sliding arrow to specify the number of partitions on which the data is separated.
For the example distribution scenario, select two partitions.
Click Next.
Define how the data will be partitioned across the LDAP servers.
Select the Partitioning Algorithm from the drop-down list.
For information about the various partitioning algorithms, see Data Distribution Using the Proxy in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Enter the naming context.
For example, dc=example,dc=com.
Enter the distribution base DN.
For example, ou=people. The distribution base DN is the level after which the distribution requests apply.
If you have selected a Lexico or Numeric algorithm, enter the distribution attribute.
For example,uid.
Depending on the distribution algorithm, define the partition capacities, DN patterns, or boundaries for each partition.
If you use the Set Default button, the installation wizard sets defaults that might not correspond to your deployment. This feature can, however, be useful for testing purposes.
For capacity, set the maximum number of entries for each partition.
For example, if you set maximum entries to 1000, only 1000 Add requests will be sent to the LDAP server associated with that partition. If you set maximum entries to 1000 for partition 1 and 2000 for partition 2, the proxy will send twice the number of requests to partition 2.
Note:
If you select the capacity algorithm, you must create a global index, as described in the next step.
For DN pattern, set the DN pattern string for each partition.
For example, cn=[a].* means that requests with a uid that starts with a will be sent to partition 1. For more information about DN pattern strings, see DN Pattern String Syntax in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For lexico, set the alphabetic boundaries for each partition.
For example, for partition 1, From=A, To=K. This means that uids with values between A and K will be sent to partition 1.
For numeric, set numeric boundaries for each partition.
For example, for partition 1, From=0, To=1000. This means that uids between 0 and 1000 will be sent to partition 1.
Note:
The upper boundary is exclusive. That is, if you set the upper boundary to 1000, only entries up to 999 will be distributed to that partition.
If you leave one of the boundaries blank, this will be considered as unlimited. In other words, if you set the lower boundary to 1000 and the upper boundary to blank, the partition will include everything after 1000.
Click Next.
Configure the global index.
Select Enable Global Indexes.
If you have selected a capacity algorithm, this option will already be selected because Global indexes are mandatory for the capacity algorithm.
Add attributes to be indexed:
Select Index the DNs if you want the DNs included in the global index.
Select Index other attributes if you want attributes other than the DNs included.
Select attributes from the Available Attributes list and click Add to include those attributes in the global index.
All available attributes are listed. Choose only those attributes that contain unique values.
If necessary, use the split-ldif command to divide LDIF files into files containing the expected data for global indexes. For more information, see To Create a Global Index Catalog Containing Global Indexes in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
The installation wizard creates a global index catalog, named gi-catalog by default, and populates the global index catalog with global indexes of the selected attributes. All global indexes are associated with the same global index catalog (gi-catalog). The installation wizard also creates a global index replication administrator with the same password as the directory manager.
For information about configuring and using global indexes, see Configuring Global Indexes By Using the Command Line in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For each partition, select the remote LDAP server that holds the corresponding partitioned data.
Note:
If you add two servers for one partition, you must configure load balancing between these servers. This use case is explained in the example To Configure Distribution with Load Balancing.
If your remote LDAP servers are Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Oracle Servers.
For Oracle Unified Directory servers:
Select Connect to a replicated Oracle Unified Directory server.
Enter the hostname, administration port, administration bind DN and password for the remote Oracle Unified Directory server.
Click Connect.
Accept the certificate.
Check the servers that should be part of the load balanced topology.
When you have entered the details of one directory server in a replicated topology, the setup wizard displays all other replicated servers in that topology.
Click OK.
For Oracle Directory Server Enterprise Edition servers:
Select Connect to a DSCC registry.
Enter the DSCC host name, DSCC port, protocol, and the Directory Service Manager credentials for the DSCC registry.
Check the servers that should be part of the load balanced topology.
The setup wizard displays all the Oracle Directory Server Enterprise Edition server instances that are registered in the DSCC registry.
Click OK.
If your remote LDAP servers are not Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Server.
Enter the server name, port and security settings.
The security settings that you set here determine the security between the Oracle Unified Directory proxy and remote LDAP servers. For more information about setting security options, see Configuring Security Between the Proxy and the Data Source, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Click Add.
Click Close when you have added all the remote LDAP servers for the distributed topology.
On the Runtime options panel, click Change to configure any specific JVM setting, or click Next to run the server with the default JVM settings.
Review the installation configuration.
If you need to make any modifications, use the Previous button.
To display the commands that will be launched for this installation, select Show Command from the drop down menu.
These commands are saved in a log file, in the logs folder. You can use these commands to run additional installations with similar deployment options later.
Click Finish to complete the installation.
When the installation is complete, you can use the dsconfig command to modify the installation. For more information, see Managing the Server Configuration With dsconfig in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
When you have installed the software, change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).
Run the oud-proxy-setup command to configure the proxy server installation.
(UNIX, Linux) $ oud-proxy-setup (Windows) C:\> oud-proxy-setup.bat
The utility launches the graphical installer and creates the Oracle Unified Directory proxy instance in OUD-base-location/instance-dir.
The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
The instance is created directly under OUD-base-location by default. To change the instance path, include the path relative to OUD-base-location when you set the INSTANCE_NAME variable. For example:
$ export INSTANCE_NAME=../../local/my-oud-proxy-instance
On the Welcome panel, click Next.
On the Server Settings panel, enter the following information:
Host Name: Enter the proxy server's host name or IP address.
The default is the local host name.
LDAP Listener Port: Enter the LDAP port for the proxy server.
The default port that is proposed is the first available port that ends with 389. On UNIX platforms, if you run the installer as a non-root user, the default is 1389, if available.
LDAP Secure Access: If you want to configure SSL, StartTLS, or both, click Configure.
Complete the following information:
SSL Access: Select Enable SSL and enter a valid port for secure LDAP operations.
The default secure port that is proposed is the first available port that ends with 636. On UNIX platforms, if you run the installer as a non-root user, the default is 1636, if available.
StartTLS Access: Click Enable StartTLS for LDAP.
Certificate: If you are in a testing environment, select Generate Self-Signed Certificate.
For production servers, click Use an Existing Certificate, and then select the Keystore Type. Enter the Keystore Path, and Keystore PIN if necessary.
Click OK.
Administration Port: Enter the port that will be used for administration traffic.
The default administration port is 4444. For more information, see Managing Administration Traffic to the Server in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Root User DN: Enter the Root User DN, or keep the default, cn=Directory Manager.
Password: Enter the root user bind password.
Password (confirm): Retype the root user bind password.
Click Next to continue.
The Deployment Options screen is displayed.
Select Use distribution on a partitioned data set from the Configuration Option drop-down menu.
If you select Configure later, only the server settings that you specified in the previous step are configured. You must then use the dsconfig command or the ODSM interface to configure your deployment.
Drag the sliding arrow to specify the number of partitions on which the data is separated.
For the example distribution scenario, select two partitions.
Click Next.
Define how the data will be partitioned across the LDAP servers.
Select the Partitioning Algorithm from the drop-down list.
For information about the various partitioning algorithms, see Data Distribution Using the Proxy in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Enter the naming context.
For example, dc=example,dc=com.
Enter the distribution base DN.
For example, ou=people. The distribution base DN is the level after which the distribution requests apply.
If you have selected a Lexico or Numeric algorithm, enter the distribution attribute.
For example,uid.
Depending on the distribution algorithm, define the partition capacities, DN patterns, or boundaries for each partition.
If you use the Set Default button, the installation wizard sets defaults, that might not correspond to your deployment. This feature can, however, be useful for testing purposes.
For capacity, set the maximum number of entries for each partition.
For example, if you set maximum entries to 1000, only 1000 Add requests will be sent to the LDAP server associated with that partition. If you set maximum entries to 1000 for partition 1 and 2000 for partition 2, the proxy will send twice the number of requests to partition 2.
If you select the capacity algorithm, you must create a global index, as described in the next step.
For DN pattern, set the DN pattern string for each partition.
For example, cn=[a].* means that requests with a uid that starts with a will be sent to partition 1. For more information about DN pattern strings, see DN Pattern String Syntax in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For lexico, set the alphabetic boundaries for each partition.
For example, for partition 1, From=A, To=K. This means that uids with values between A and K will be sent to partition 1.
For numeric, set numeric boundaries for each partition.
For example, for partition 1, From=0, To=1000. This means that uids between 0 and 1000 will be sent to partition 1.
The upper boundary is exclusive. That is, if you set the upper boundary to 1000, only entries up to 999 will be distributed to that partition.
If you leave one of the boundaries blank, this will be considered as unlimited. In other words, if you set the lower boundary to 1000 and the upper boundary to blank, the partition will include everything after 1000.
Click Next.
Configure the global index.
Select Enable Global Indexes.
If you have selected a capacity algorithm, this option will already be selected because Global indexes are mandatory for the capacity algorithm.
Add attributes to be indexed:
Select Index the DNs if you want the DNs included in the global index.
Select Index other attributes if you want attributes other than the DNs included.
Select attributes from the Available Attributes list and click Add to include those attributes in the global index.
All available attributes are listed. Choose only those attributes that contain unique values.
If necessary, use the split-ldif command to divide LDIF files into files containing the expected data for global indexes. For more information, see To Create a Global Index Catalog Containing Global Indexes in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
The installation wizard creates a global index catalog, named gi-catalog by default, and populates the global index catalog with global indexes of the selected attributes. All global indexes are associated with the same global index catalog (gi-catalog). The installation wizard also creates a global index replication administrator with the same password as the directory manager.
For information about configuring and using global indexes, see Configuring Global Indexes By Using the Command Line in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For each partition, select the remote LDAP server that holds the corresponding partitioned data.
You must select at least two remote LDAP servers per partition to deploy distribution with load balancing.
If your remote LDAP servers are Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Oracle Servers.
For Oracle Unified Directory servers:
Select Connect to a replicated Oracle Unified Directory server.
Enter the hostname, administration port, administration bind DN and password for the remote Oracle Unified Directory server.
Click Connect.
Accept the certificate.
Check the servers that should be part of the load balanced topology.
When you have entered the details of one directory server in a replicated topology, the setup wizard displays all other replicated servers in that topology.
Click OK.
For Oracle Directory Server Enterprise Edition servers:
Select Connect to a DSCC registry.
Enter the DSCC host name, DSCC port, protocol, and the Directory Service Manager credentials for the DSCC registry.
Check the servers that should be part of the load balanced topology.
The setup wizard displays all the Oracle Directory Server Enterprise Edition server instances that are registered in the DSCC registry.
Click OK.
If your remote LDAP servers are not Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Server.
Enter the server name, port and security settings.
The security settings you set here will determine the security between the Oracle Unified Directory proxy and remote LDAP servers. For more information about setting security options, see Configuring Security Between the Proxy and the Data Source, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Click Add.
Click Close when you have added all the remote LDAP servers for the distributed topology.
For each partition, set load balancing.
Choose the load balancing algorithm.
For example, select Proportional with default values.
Set the load balancing algorithm properties or select Default Values.
When you have completed the installation, the properties can be modified. For more information, see Modifying Load Balancing Properties in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For proportional load balancing, set the weight. Requests are distributed between the remote LDAP servers based on the weight indicated.
For example, if you leave the default value of 1, all servers will receive the same number of requests.
For failover, indicate the order in which the servers are used.
The server with a value of 1 will be the main server. The other servers will only be used if there is a failure on the server with a priority of 1.
For saturation, set the order in which the servers are used as well as the saturation threshold of each server.
Requests are sent to the server with the highest priority (1) until it reaches the threshold indicated. The saturation threshold is the rate at which the server is considered saturated, or full. Typically this limit should be set lower than 100%.
For optimal, no additional configuration is required.
The active server is selected based on the saturation index, which is calculated automatically.
On the Runtime options panel, click Change to configure any specific JVM setting, or click Next to run the server with the default JVM settings.
For more information, see Configuring the Java Runtime Settings During Installation.
The Review screen is displayed.
Review the installation configuration.
If you need to make any modifications, use the Previous button.
To display the commands that will be launched for this installation, select Show Command from the drop down menu.
These commands are saved in a log file, in the logs folder. You can use these commands to run additional installations with similar deployment options later.
Click Finish to complete the installation.
When the installation is complete, you can use the dsconfig command to modify the installation. For more information, see Managing the Server Configuration With dsconfig in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
When you have installed the software, change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).
Run the oud-proxy-setup command to configure the proxy server installation.
(UNIX, Linux) $ oud-proxy-setup (Windows) C:\> oud-proxy-setup.bat
The utility launches the graphical installer and creates the Oracle Unified Directory proxy instance in OUD-base-location/instance-dir.
The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
The instance is created directly under OUD-base-location by default. To change the instance path, include the path relative to OUD-base-location when you set the INSTANCE_NAME variable. For example:
$ export INSTANCE_NAME=../../local/my-oud-proxy-instance
On the Welcome panel, click Next.
The Server Settings screen is displayed.
Enter the following information:
Host Name: Enter the proxy server's host name or IP address.
The default is the local host name.
LDAP Listener Port: Enter the LDAP port for the proxy server.
The default port that is proposed is the first available port that ends with 389. On UNIX platforms, if you run the installer as a non-root user, the default is 1389, if available.
LDAP Secure Access: Click Configure, to configure SSL.
Complete the following information:
SSL Access: Select Enable SSL and enter a valid port for secure LDAP operations.
The default secure port that is proposed is the first available port that ends with 636. On UNIX platforms, if you run the installer as a non-root user, the default is 1636, if available.
Certificate: If you are in a testing environment, select Generate Self-Signed Certificate.
For production servers, select Use an Existing Certificate, and then select the Keystore Type. Enter the Keystore Path, and Keystore PIN if necessary.
Click OK.
Administration Port: Enter the port that will be used for administration traffic.
The default administration port is 4444. For more information, see "Managing Administration Traffic to the Server" in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Root User DN: Enter the Root User DN or keep the default, cn=Directory Manager.
Password: Enter the root user bind password.
Password (confirm): Re-enter the root user bind password.
Click Next to continue.
The Deployment Options screen is deployed.
Select Configure EUS from the Configuration Option drop-down menu.
Note:
If you select Configure later, only the server settings that you specified in the previous step are configured. You must then use the dsconfig command, or the ODSM interface, to configure your deployment.
Click Next.
The Back-End Server Type screen is displayed.
Select the type of LDAP server storing the user identities.
Click Next.
The Back-End Server screen is displayed.
Select the remote LDAP servers that hold the corresponding replicated data.
If your remote LDAP servers are Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Oracle Servers.
For Oracle Unified Directory servers:
Select Connect to a replicated Oracle Unified Directory server.
Enter the hostname, administration port, administration bind DN and password for the remote Oracle Unified Directory server.
Click Connect.
Accept the certificate.
Check the servers that should be part of the replicated topology.
When you have entered the details of one directory server in a replicated topology, the setup wizard displays all other replicated servers in that topology.
Click OK.
For Oracle Directory Server Enterprise Edition servers:
Select Connect to a DSCC registry.
Enter the DSCC host name, DSCC port, protocol, and the Directory Service Manager credentials for the DSCC registry.
Check the servers that should be part of the replicated topology.
The setup wizard displays all the Oracle Directory Server Enterprise Edition server instances that are registered in the DSCC registry.
Click OK.
If your remote LDAP servers are not Oracle Unified Directory servers or Oracle Directory Server Enterprise Edition servers, click Add Server.
Enter the server name, port and security settings.
The security settings you set here will determine the security between the Oracle Unified Directory proxy and remote LDAP servers. For more information about setting security options, see Configuring Security Between the Proxy and the Data Source, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
Click Add.
Click Close when you have added all the remote LDAP servers for the load balanced topology.
Click Next.
The Load Balancing Options screen is displayed.
This screen appears only if you have selected multiple LDAP servers.
Set the load balancing algorithm properties or select default values.
When you have completed the installation, the properties can be modified. For more information, see Modifying Load Balancing Properties in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
For proportional, set the weight. Requests are distributed between the remote LDAP servers based on the weight indicated.
For example, if you leave the default value of 1, then all servers will receive the same number of requests.
For failover, indicate the order in which the servers are used.
The server with a value of 0 is the highest priority server. The other servers are used only if there is a failure on the main server.
For saturation, set the order in which the servers are used as well as the saturation threshold of each server.
Requests are sent to the server with the highest priority (1) until it reaches the threshold indicated. The saturation threshold is the rate at which the server is considered saturated, or full. Typically this limit should be set lower than 100%.
For optimal, no additional configuration is required.
The active server is selected based on the saturation index, which is calculated automatically.
For information about the various load balancing algorithms, see Load Balancing Using the Proxy in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
The Naming Contexts screen is displayed.
Enter the naming context, or suffix.
If the remote LDAP servers are online, the setup connects to them and displays the naming contexts that are available on the servers.
If no naming contexts are proposed, enter the DN of the naming context that you want to use, for example, dc=example,dc=com. Click Add.
Click Next.
The Runtime options screen is displayed.
On the Runtime options panel, click Change to configure any specific JVM settings, or click Next to run the server with the default JVM settings.
Review the installation configuration.
If you need to make any modifications, use the Previous button.
To display the commands that will be launched for this installation, select Show Command from the drop down menu.
These commands are saved in a log file, in the logs folder. You can use these commands to run additional installations with similar deployment options later.
Click Finish to complete the installation.
When the installation is complete, you can use the dsconfig command to modify the installation. For more information, see Managing the Server Configuration With dsconfig in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
You must configure the EUS context for each EUS suffix that you have defined as follows:
Create a copy of eusData.ldif file located at OUD_INSTALL_ROOT\OracleUnifiedDirectory\config\EUS\ (Windows) or OUD_INSTALL_ROOT/OracleUnifiedDirectory/config/EUS/ (Unix).
For example, the Root User DN is cn=directory manager and the following EUS suffixes are created:
dc=eus A
dc=eus B
The file /tmp/password.txt contains the password of the Root User DN and 4444 is the default administration port of the OUD instance.
Create two copies of eusData.ldif file as follows:
/tmp/eusDataA.ldif
/tmp/eusDataB.ldif
Open the eusData.ldif file in a text editor and do the following:
Replace the occurrence of dc=example and dc=com by the DN of the EUS suffix.
Replace the occurrence of cn=orcladmin by the Root User DN that you provided during the setup.
For example, you must do the following:
Replace cn=orcladmin with cn=directory manager in eusDataA.ldif and eusDataB.ldif files.
In the eusDataA.ldif file replace dc=example and dc=com with dc=eus A.
In the eusDataB.ldif file replace dc=example and dc=com with dc=eus B.
You must import the content of the files by running the following command:
Windows:
OUD_INSTANCE_ROOT\OUD\bin\import-ldif -n oraclecontextSUFFIX_NUMBER -l \ PATH_OF_THE_EDITED_FILE -F --hostname OUD_HOST_NAME --port OUD_ADMINISTRATION_PORT \ --bindDN OUD_ROOT_USER_DN --bindPasswordFile PATH_OF_FILE_WITH_OUD_ROOT_USER_PASSWORD
Unix:
OUD_INSTANCE_ROOT/OUD/bin/import-ldif -n oraclecontextSUFFIX_NUMBER -l / PATH_OF_THE_EDITED_FILE -F --hostname OUD_HOST_NAME --port OUD_ADMINISTRATION_PORT / --bindDN OUD_ROOT_USER_DN --bindPasswordFile PATH_OF_FILE_WITH_OUD_ROOT_USER_PASSWORD
For example, import the content of eusDataA.ldif file as follows:
Note:
The backend ID is 1. For example, oraclecontext1.
Windows:
<OUD_INSTANCE_ROOT>\OUD\bin\import-ldif -n oraclecontext1 -l \tmp\eusDataA.ldif -F --hostname localhost --port 4444 --bindDN "cn=directory @ manager" --bindPasswordFile \tmp\password.txt
Unix:
<OUD_INSTANCE_ROOT>/OUD/bin/import-ldif -n oraclecontext1 -l /tmp/eusDataA.ldif -F --hostname localhost --port 4444 --bindDN "cn=directory @ manager" --bindPasswordFile /tmp/password.txt
Import the content of eusDataB.ldif file as follows:
Note:
The backend ID is 2. For example, oraclecontext2.
Windows:
<OUD_INSTANCE_ROOT>\OUD\bin\import-ldif -n oraclecontext2 -l \tmp\eusDataB.ldif -F --hostname localhost --port 4444 --bindDN "cn=directory @ manager" --bindPasswordFile \tmp\password.txt
Unix:
<OUD_INSTANCE_ROOT>/OUD/bin/import-ldif -n oraclecontext2 -l /tmp/eusDataB.ldif -F --hostname localhost --port 4444 --bindDN "cn=directory @ manager" --bindPasswordFile /tmp/password.txt
Running the oud-proxy-setup in command-line mode defines the proxy port, host name, and security configuration.
To complete the deployment and to configure load balancing or distribution, you must use dsconfig, as described in Managing the Proxy Configuration With dsconfig in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory, or the ODSM interface, as described in Managing the Proxy Configuration With ODSM in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
You can also use a common properties file to provide default values for options. For more information, see Using a Properties File With Server Commands in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
If you have previously used the graphical wizard to set up the proxy, you can copy the commands that are launched by the wizard prior to completing the installation. The commands displayed by the install wizard are a good starting point for scripting an installation. For information about how to do this, see Section 4.3, "Duplicating a Proxy Installation,".
When you have installed the software, change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).
Type oud-proxy-setup with the --cli option, specifying the server details as follows:
Unix, Linux $ oud-proxy-setup --cli -p 1389 --adminConnectorPort 4444 -D "cn=Directory Manager" -j pwd-file Windows C:\> oud-proxy-setup.bat -cli -p 1389 --adminConnectorPort 4444 -D "cn=Directory Manager" -j pwd-file
In the preceding example, -p is the proxy LDAP port that is used to send data between the client and the proxy, --adminConnectorPort is the proxy administration port, -D is the bind DN, and -j is the file containing the proxy LDAP bind password.
The utility launches the command—line installer and creates the Oracle Unified Directory proxy instance in OUD-base-location/instance-dir.
The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
The instance is created directly under OUD-base-location by default. To change the instance path, include the path relative to OUD-base-location when you set the INSTANCE_NAME variable. For example:
$ export INSTANCE_NAME=../../local/my-oud-proxy-instance
Note:
You can configure EUS in cli mode, by specifying the following option while launching the installer:
oud-proxy-setup --eusContext {namingContext}
For example:
oud-proxy-setup --eusContext dc=example,dc=com
To complete the proxy deployment, you must configure workflow elements, workflows, network group and so on.
The list of components to be configured will depend on your deployment architecture. For examples based on the supported use cases, see Example Proxy Configurations, in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.
To set up a replicated Oracle Unified Directory proxy, you must duplicate your Oracle Unified Directory proxy installation.
If you are using the graphical install wizard to set up Oracle Unified Directory proxy, you can copy the commands that are launched by the wizard prior to completing the installation. The commands displayed by the install wizard are a good starting point for scripting an installation.
Using the graphical install wizard, define the proxy installation but do not click Finish.
On the Review page, select the Show Commands button from the top right.
Copy the commands that are displayed.
Paste them into a text file.
You can now complete your first installation by clicking Finish.
Edit the commands to modify the port, the hostname, and the password.
Replace the generic asinst variable with the appropriate instance name, either by anticipating the instance name, or by setting the INSTANCE_NAME variable. You might also need to quote certain arguments, depending on your shell scripting language.
Save the updated file as a script.
On the machine where you want to host the next Oracle Unified Directory proxy instance, install the Oracle Unified Directory software, as described in Installing Oracle Unified Directory.
Change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Run the script that you saved in Step 5.
When you have completed a proxy installation, a log file named oud-setup saves the commands of the installation. You can use this file to duplicate an Oracle Unified Directory proxy instance.
Change to the logs directory.
$ cd OUD-base-location/instance-name/OUD/logs
Open the file oud-setup.
Edit the commands to modify the port, the hostname, and the password file of the new proxy instance.
Replace the generic asinst variable with the appropriate instance name, either by anticipating the instance name, or by setting the INSTANCE_NAME variable. You might also need to quote certain arguments, depending on your shell scripting language.
Save the updated file as a script.
On the machine where you want to host the next Oracle Unified Directory proxy instance, install the Oracle Unified Directory software, as described in Installing Oracle Unified Directory.
Change to the ORACLE_HOME subdirectory.
(UNIX, Linux) $ cd OUD-base-location/ORACLE_HOME (Windows) C:\> cd OUD-base-location\ORACLE_HOME
Run the script that you saved in Step 4.
To avoid a single point of failure in your deployment, the proxy should be redundant. You can ensure redundancy by using multiple replicated proxy server instances. For more information, see Multiple Replicated Proxies in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.