Skip Headers
Oracle® Exalogic Elastic Cloud Enterprise Deployment Guide for Oracle Identity Management
Release EL X2-2 and EL X3-2

Part Number E35832-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

13 Setting Up Node Manager for an Enterprise Deployment

This chapter describes how to configure Node Manager in accordance with Oracle best practice recommendations.

This chapter contains the following sections:

13.1 Overview of the Node Manager

Node Manager enables you to start and stop the Administration Server and the Managed Servers.

Process

The procedures described in this chapter must be performed on IDMHOST1 and IDMHOST2 for various components of the enterprise deployment topologies outlined in Chapter 2.

Note that the procedures in this chapter must be performed multiple times for each VIP-and-IP pair using the information provided in the component-specific chapters.

Recommendations

Oracle provides two main recommendations for Node Manager configuration in enterprise deployment topologies:

  1. Oracle recommends placing the Node Manager log file in a location different from the default one (which is inside the Middleware Home where Node Manager resides). See Section 13.2, "Setting Up Node Manager" for further details.

  2. Oracle also recommends using host name verification for the communication between Node Manager and the servers in the domain. This requires the use of certificates for the different addresses used in the domain. This chapter explains the steps for configuring certificates in the hosts for host name verification. See Section 13.3, "Enabling Host Name Verification Certificates for Node Manager" for further details.

Note:

The passwords used in this guide are used only as examples. Use secure passwords in a production environment. For example, use passwords that consist of random sequences of both uppercase and lowercase characters as well as numbers.

13.2 Setting Up Node Manager

This section describes how to set up Node Manager for an enterprise deployment.

This section contains the following topics:

13.2.1 Changing the Location of Node Manager Configuration Files

Create a new directory for Node Manager configuration and log files outside the MW_HOME directory, and perform all Node Manager configuration tasks from this directory.

To create the new directory:

  1. Run the following commands on IDMHOST1 and IDMHOST2:

    mkdir -p /u02/private/oracle/config/nodemanager
    
  2. Copy the nodemanager.properties file in the following directory:

    /u01/oracle/products/access/wlserver_10.3/common/nodemanager
    

    To the new nodemanager folders you created on IDMHOST1 and IDMHOST2.

  3. Copy the startNodeManager.sh file in the following directory:

    /u01/oracle/products access/wlserver_10.3/server/bin
    

    And the nodemanager.domains files located in the following folder:

    /u01/oracle/products/access/wlserver_10.3/common/nodemanager
    

    To the new nodemanager folders you created on IDMHOST1 and IDMHOST2.

  4. Open startNodeManager.sh for IDMHOST1 and IDMHOST2 located in the new nodemanager folder in IDMHOST1 and IDMHOST2) using a text editor, and make the following change:

    On IDMHOST1 and IDNMHOST2:

    NODEMGR_HOME="/u02/private/oracle/config/nodemanager
    

13.2.2 Editing the Node Manager Property File

Update the nodemanager.properties file located in the following directory on IDMHOST1 and IDMHOST2:

/u02/private/oracle/config/nodemanager

On IDMHOST1 edit the file as follows:

NodeManagerHome: /u02/private/oracle/config/nodemanager
 ListenAddress= 192.168.10.1
 LogFile= /u02/private/oracle/config/nodemanager/nodemanager.log
Properties Value
SecureListener Set the value to "false".
StartScriptEnabled Set the value to "true",
StopScriptEnabled Set the value to "true",
StopScriptName Specify a name for the stop script, for example stopWebLogic.sh.
DomainsFile /u02/private/oracle/config/nodemanager/nodemanager.domains

On IDMHOST2:

NodeManagerHome: /u02/private/oracle/config/nodemanager
 ListenAddress= 192.168.10.2
 LogFile= /u02/private/oracle/config/nodemanager/nodemanager.log
Properties Value
SecureListener Set the value to "false".
StartScriptEnabled Set the value to "true",
StopScriptEnabled Set the value to "true",
StopScriptName Specify a name for the stop script, for example stopWebLogic.sh.
DomainsFile /u02/private/oracle/config/nodemanager/nodemanager.domains

13.2.3 Starting Node Manager

Start Node Manager on IDMHOST1 and IDMHOST 2 using startNodeManager.sh located in the following directory:

/u02/private/oracle/config/nodemanager

For example run the following command on IDMHOST1 and IDMHOST2:

./startNodeManager.sh

13.3 Enabling Host Name Verification Certificates for Node Manager

This section describes how to set up host name verification certificates for communication between Node Manager and the Administration Server. It consists of the following steps:

13.3.1 Generating Self-Signed Certificates Using the utils.CertGen Utility

The certificates added in this chapter (as an example) address a configuration where Node Manager listens on a physical host name (HOST.mycompany.com) and a WebLogic Managed Server listens on a virtual host name (VIP.mycompany.com). Whenever a server is using a virtual host name, it is implied that the server can be migrated from one node to another. Consequently, the directory where keystores and trust keystores are maintained ideally must reside on a shared storage that is accessible from the failover. If additional host names are used in the same or different nodes, the steps in this example must be extended to:

  1. Add the required host names to the certificate stores (if they are different from HOST.mycompany.com and VIP.mycompany.com).

  2. Change the identity and trust store location information for Node Manager (if the additional host names are used by Node Manager) or for the servers (if the additional host names are used by Managed Servers).

Follow these steps to create self-signed certificates on HOST. These certificates should be created using the network name or alias. For information on using trust CA certificates instead, see "Configuring Identity and Trust" in Oracle Fusion Middleware Securing Oracle WebLogic Server. The following examples configure certificates for HOST.mycompany.com and VIP.mycompany.com; that is, it is assumed that both a physical host name (HOST) and a virtual host name (VIP) are used in HOST. It is also assumed that HOST.mycompany.com is the address used by Node Manager and VIP.mycompany.com is the address used by a Managed Server or the Administration Server. This is the common situation for nodes hosting an Administration Server and a Fusion Middleware component, or for nodes where two Managed Servers coexist with one server listening on the physical host name and one server using a virtual host name (which is the case for servers that use migration servers).

  1. Set up your environment by running the WL_HOME/server/bin/setWLSEnv.sh script. In the Bourne shell, run the following commands:

    cd WL_HOME/server/bin
    . ./setWLSEnv.sh
    

    Verify that the CLASSPATH environment variable is set:

    echo $CLASSPATH
    
  2. Create a user-defined directory for the certificates. For example, create a directory called 'certs' under the ORACLE_BASE/admin/domain_name/aserver/domain_name directory. Note that certificates can be shared across WebLogic domains.

    cd ORACLE_BASE/admin/domain_name/aserver/domain_name
    mkdir certs
    

    Note:

    The directory where keystores and trust keystores are maintained must be on shared storage that is accessible from all nodes so that when the servers fail over (manually or with server migration), the appropriate certificates can be accessed from the failover node. Oracle recommends using central or shared stores for the certificates used for different purposes (like SSL set up for HTTP invocations, for example).

  3. Change directory to the directory that you just created:

    cd certs
    
  4. Run the utils.CertGen tool from the user-defined directory to create the certificates for both HOST. mycompany.com and VIP. mycompany.com.

    Syntax (all on a single line):

    java utils.CertGen Key_Passphrase Cert_File_Name Key_File_Name 
    
    [export | domestic] [Host_Name]
    

    Examples:

    java utils.CertGen Key_Passphrase IDMHOST1.mycompany.com_cert IDMHOST1.mycompany.com_key domestic IDMHOST1.mycompany.com
    
    java utils.CertGen Key_Passphrase IDMHOST2.mycompany.com_cert IDMHOST2.mycompany.com_key domestic IDMHOST2.mycompany.com
    
    java utils.CertGen Key_Passphrase ADMINVHN.mycompany.com_cert ADMINVHN.mycompany.com_key domestic ADMINVHN.mycompany.com
    
    java utils.CertGen Key_Passphrase OUDADMINVHN.mycompany.com_cert OUDADMINVHN.mycompany.com_key domestic OUDADMINVHN.mycompany.com
    

13.3.2 Creating an Identity Keystore Using the utils.ImportPrivateKey Utility

Follow these steps to create an identity keystore on IDMHOST1:

  1. Create a new identity keystore called appIdentityKeyStore using the utils.ImportPrivateKey utility. Create this keystore under the same directory as the certificates (that is, ASERVER_HOME/certs.

    Note:

    The Identity Store is created (if none exists) when you import a certificate and the corresponding key into the Identity Store using the utils.ImportPrivateKey utility.

  2. Import the certificate and private key for IDMHOST1.mycompany.com, IDMHOST2.mycompany.com and ADMINVNH.mycompany.com into the Identity Store. Ensure that you use a different alias for each of the certificate/key pairs imported.

    Syntax (all on a single line):

    java utils.ImportPrivateKey Keystore_File Keystore_Password 
    
    Certificate_Alias_to_Use Private_Key_Passphrase 
    
    Certificate_File 
    
    Private_Key_File 
    
    [Keystore_Type]
    

    Examples:

    java utils.ImportPrivateKey appIdentityKeyStore.jks Key_Passphrase appIdentityIDMHOST1 Key_Passphrase ASERVER_HOME/certs/IDMHOST1.mycompany.com_cert.pem ASERVER_HOME/certs/IDMHOST1.mycompany.com_key.pem
    
    java utils.ImportPrivateKey appIdentityKeyStore.jks Key_Passphrase appIdentityIDMHOST2 Key_Passphrase ASERVER_HOME/certs/IDMHOST2.mycompany.com_cert.pem ASERVER_HOME/certs/IDMHOST2.mycompany.com_key.pem
    
    java utils.ImportPrivateKey appIdentityKeyStore.jks Key_Passphrase appIdentityADMVHN Key_Passphrase ASERVER_HOME/certs/ADMINVNH.mycompany.com_cert.pem ASERVER_HOME/certs/ADMINVNH.mycompany.com_key.pem
    

13.3.3 Creating a Trust Keystore Using the Keytool Utility

Follow these steps to create the trust keystore on each host, IDMHOST1 and IDMHOST2:

  1. Copy the standard Java keystore to create the new trust keystore since it already contains most of the root CA certificates needed. Oracle does not recommend modifying the standard Java trust keystore directly. Copy the standard Java keystore CA certificates located under the WL_HOME/server/lib directory to the same directory as the certificates. For example:

    cp WL_HOME/server/lib/cacerts ASERVER_HOME/certs/appTrustKeyStoreIDMHOST1.jks
    
  2. The default password for the standard Java keystore is changeit. Oracle recommends always changing the default password. Use the keytool utility to do this. The syntax is:

    keytool -storepasswd -new New_Password -keystore Trust_Keystore -storepass Original_Password
    

    For example:

    keytool -storepasswd -new Key_Passphrase -keystore appTrustKeyStoreIDMHOST1.jks -storepass changeit
    
  3. The CA certificate CertGenCA.der is used to sign all certificates generated by the utils.CertGen tool. It is located in the WL_HOME/server/lib directory. This CA certificate must be imported into the appTrustKeyStore using the keytool utility. The syntax is:

    keytool -import -v -noprompt -trustcacerts -alias Alias_Name 
    
    -file CA_File_Location -keystore Keystore_Location -storepass Keystore_Password
    

    For example:

    keytool -import -v -noprompt -trustcacerts -alias clientCACert -file WL_HOME/server/lib/CertGenCA.der -keystore appTrustKeyStoreIDMHOST1.jks -storepass Key_Passphrase
    

13.3.4 Configuring Node Manager to Use the Custom Keystores

Configure Node Manager to use the custom keystores by editing the nodemanager.properties file located in the following directory on IDMHOST1 and IDMHOST2:

/u02/private/oracle/config/nodemanager_directory

Add the following lines to the nodemanager.properties file:

KeyStores=CustomIdentityAndCustomTrust
CustomIdentityKeyStoreFileName=Identity_Keystore
CustomIdentityKeyStorePassPhrase=Identity_Keystore_Password
CustomIdentityAlias=Identity_Keystore_Alias
CustomIdentityPrivateKeyPassPhrase=Private_Key_Used_When_Creating_Certificate

For example:

KeyStores=CustomIdentityAndCustomTrust
CustomIdentityKeyStoreFileName=ORACLE_BASE/admin/domain_name/aserver/domain_name/certs/appIdentityKeyStore.jks
CustomIdentityKeyStorePassPhrase=Key_Passphrase
CustomIdentityAlias=appIdentityIDMHOST1
CustomIdentityPrivateKeyPassPhrase=Key_Passphrase

The passphrase entries in the nodemanager.properties file get encrypted when you start Node Manager as described in Section 16.1, "Starting and Stopping Oracle Identity Management Components." For security reasons, minimize the time the entries in the nodemanager.properties file are left unencrypted. After you edit the file, start Node Manager as soon as possible so that the entries get encrypted.

13.3.5 Using a Common or Shared Storage Installation

When using a common or shared storage installation for MW_HOME, Node Manager is started from different nodes using the same base configuration (nodemanager.properties). Add the certificate for all the nodes that share the binaries to the appIdentityKeyStore.jks identity store.by creating the certificate for the new node and import it to appIdentityKeyStore.jks, as described in Section 13.3.1, "Generating Self-Signed Certificates Using the utils.CertGen Utility.". Once the certificates are available in the store, each node manager must point to a different identity alias to send the correct certificate to the Administration Server.

To set different environment variables before starting Node Manager in the different nodes:

cd WL_HOME/server/bin
export JAVA_OPTIONS=-DCustomIdentityAlias=appIdentityIDMHOST1

cd WL_HOME/server/bin
export JAVA_OPTIONS=-DCustomIdentityAlias=appIdentityIDMHOST2

Note:

Make sure to specify the custom identity alias specifically assigned to each host, for example appIdentity1 for ...HOST1 and appIdentity2 for ...HOST2.

13.3.6 Configuring Managed WebLogic Servers to Use the Custom Keystores

Follow these steps to configure the identity and trust keystores for WLS_SERVER:

  1. Log in to Oracle WebLogic Server Administration Console at the URL listed in Section 16.2, "About Identity Management Console URLs."

  2. Click Lock and Edit.

  3. Expand the Environment node in the Domain Structure window.

  4. Click Servers. The Summary of Servers page is displayed.

  5. Click the name of the server for which you want to configure the identity and trust keystores (WLS_SERVER). The settings page for the selected server is displayed.

  6. Select Configuration, then Keystores.

  7. In the Keystores field, select the Custom Identity and Custom Trust method for storing and managing private keys/digital certificate pairs and trusted CA certificates.

  8. In the Identity section, define attributes for the identity keystore:

    • Custom Identity Keystore: The fully qualified path to the identity keystore:

      ASERVER_HOME/certs/appIdentityKeyStore.jks
      
    • Custom Identity Keystore Type: Leave blank; it defaults to JKS.

    • Custom Identity Keystore Passphrase: The password (Keystore_Password) you provided in Section 13.3.3, "Creating a Trust Keystore Using the Keytool Utility." This attribute is optional or required depending on the type of keystore. All keystores require the passphrase to write to the keystore. However, some keystores do not require the passphrase to read from the keystore. WebLogic Server only reads from the keystore, so whether you define this property depends on the requirements of the keystore.

  9. In the Trust section, define properties for the trust keystore:

    • Custom Trust Keystore: The fully qualified path to the trust keystore:

      ASERVER_HOME/certs/appTrustKeyStoreIDMHOST1.jks
      
    • Custom Trust Keystore Type: Leave blank; it defaults to JKS.

    • Custom Trust Keystore Passphrase: The password you provided as New_Password in Section 13.3.3, "Creating a Trust Keystore Using the Keytool Utility." This attribute is optional or required depending on the type of keystore. All keystores require the passphrase to write to the keystore. However, some keystores do not require the passphrase to read from the keystore. WebLogic Server only reads from the keystore, so whether you define this property depends on the requirements of the keystore.

  10. Click Save.

  11. Click Activate Changes in the Administration Console's Change Center to make the changes take effect.

  12. Select Configuration, then SSL.

  13. Click Lock and Edit.

  14. In the Private Key Alias field, enter the alias you used for the host name the Managed Server listens on, for example:

    • For wls_oam1, use appIdentityIDMHOST1.

    • For wls_oam2 use appIdentityIDMHOST2.

    • For ADMINSERVER user appIdentityADMVHN.

    In the Private Key Passphrase and the Confirm Private Key Passphrase fields, enter the password for the keystore that you created in Section 13.3.2, "Creating an Identity Keystore Using the utils.ImportPrivateKey Utility."

  15. Click Save.

  16. Click Activate Changes in the Administration Console's Change Center to make the changes take effect.

  17. Restart the server for which the changes have been applied, as described in Section 16.1, "Starting and Stopping Oracle Identity Management Components."

13.3.7 Changing the Host Name Verification Setting for the Managed Servers

Once the previous steps have been performed, set host name verification for the affected Managed Servers to Bea Hostname Verifier. To do this, perform the following steps:

  1. Log in to Oracle WebLogic Server Administration Console.

  2. Select Lock and Edit from the change center.

  3. Expand the Environment node in the Domain Structure window.

  4. Click Servers. The Summary of Servers page is displayed.

  5. Select the Managed Server in the Names column of the table. The settings page for the server is displayed.

  6. Open the SSL tab.

  7. Expand the Advanced section of the page.

  8. Set host name verification to Bea Hostname Verifier.

  9. Click Save.

  10. Click Activate Changes.

13.4 Starting Node Manager

Start Node Manager on IDMHOST1 and IDMHOST2 by running startNodeManager.sh located in the following directory:

/u02/private/oracle/config/nodemanager

To start Node manager, run the following command on IDMHOST1 and IDMHOST2:

./startNodeManager.sh

Note:

If you have not configured and started Node Manager for the first time yet, run the setNMProps.sh script as specified in section Section 10.5.4, "Starting Node Manager on IDMHOST1 and IDMHOST2." This enables the use of the start script that is required for Identity Management Components.

Note:

Verify that Node Manager is using the appropriate stores and alias from the Node Manager output. You should see the following when Node Manager starts.:

<Loading identity key store:
  FileName=ASERVER_HOME/certs/appIdentityKeyStore.jks, Type=jks, PassPhraseUsed=true>

Host name verification works if you apply a test configuration change to the servers and it succeeds without Node Manager reporting any SSL errors.