Standard
edition

Configuring Aggregated Search automatically

To automatically configure Aggregated Search, complete the following steps.

Before you begin

Create a topology before you start. To specify the topology, create a JSON file with the required parameters. For more information about these parameters, see Topology file for Aggregated Search.

Use plain passwords in the topology. The aggregationConfigUtil.sh script encrypts these passwords when it copies the topology to the nodes. The password is optional. If you do not specify it, users are required to enter the password when they run the script.

About this task

You use the <HOME>/IBM®/LogAnalysis/utilities/aggregation/aggregationConfigUtil.sh script to configure Aggregated Search. For more information, see aggregationConfigUtil.sh.

Procedure

  1. Go to the <HOME>/IBM/LogAnalysis/utilities/aggregation directory.
  2. To copy the topology file and enable Aggregated Search in the unitysetup.properties file, enter the following command:
    ./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all 
    -o setuptopology
    where <topology_file_name> is the name of the topology file. For example, example.json.
  3. To set up the Java™ certificates, enter the following command:
    ./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all 
    -o setupjavakeystores
  4. You can also configure Lightweight Directory Access Protocol (LDAP) for user authentication. This step is optional and is only required if you want to use LDAP. To configure LDAP, enter the following command:
    ./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all 
    -o configldap -lp ~/ldapRegistryHelper.properties
  5. You can also configure single sign-on (SSO) to facilitate the drill-down feature. To configure SSO, you must set up LDAP as described in step 2. This step is optional and is only required if you want to use SSO when you drill down. To configure SSO and update the server.xml file with the domain name, enter the following command, specifying the path to the keys file:
    ./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all 
    -o configsso -kf ~/<path_ltpa_file>
    where <path_ltpa_file> is the path to the key file that is copied to all nodes in the cluster. For example, home/la/ltpa.keys.
  6. Restart each instance of Log Analysis. To restart Log Analysis, log in each server and enter the following command:
    <HOME>/IBM/LogAnalysis/utilities/unity.sh -restart

What to do next

To verify that SSO is configured correctly, enter the following command:
./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all -o checksso
If any certificate errors occur when you use the checksso option, enter the following command:
./aggregationConfigUtil.sh -tf ~/<topology_file_name> -n all -o prepsso
You can also configure Aggregated Search with a single command. You can omit any options that you do not want to use such as configsso. For example:
./aggregationConfigUtil.sh -o setuptopology,setupjavakeystores,configldap,configsso 
-tf ~/<topology_file_name>  -n all -lp ~/ldapRegistryHelper.properties 
-kf ~/<path_ltpa_file>

After you configure Aggregated Search, you can create an aggregation template to specify how the data is aggregated and is sent from the children nodes to the parent nodes. For more information, see Creating aggregation templates.