Administration guide > Monitor the environment > Monitoring with the web console



Connect the web console to catalog servers

To start viewing statistics in the web console, first connect to catalog servers that to monitor. Additional steps are required if the catalog servers have security enabled.


Before you begin


Procedure

  1. If the catalog servers have SSL enabled, configure a keystore, truststore, and client properties file. You enable SSL for a catalog server by setting the transportType attribute to SSL-Required in the Server properties file.

    1. Configure a keystore and truststore , and then exchange, or cross-import the public certificates. For example, you might copy the truststore and keystore to a location on the server that is running the web console.

    2. Edit the client properties file on the web console server to include the properties for SSL configuration. For example, you might edit the wxs_install_root/ObjectGridProperties/sampleclient.properties file. The following properties are required for outbound SSL connections from the web console:

          #------------------------------------------------------------------------------
          # SSL Configuration
          #
          # - alias               (alias name in the key store)
          # - contextProvider     (IBMJSSE2, IBMJSSE, IBMJSSEFIPS, etc.)
          # - protocol            (SSL, SSLv2, SSLv3, TLS, TLSv1, etc.)
          # - keyStoreType        (JKS, JCEK, PKCS12, etc.)
          # - trustStoreType      (JKS, JCEK, PKCS12, etc.)
          # - keyStore            (fully qualified path to key store file)
          # - trustStore          (fully qualified path to trust store file)
          # - alias               (string specifying ssl certificate alias to use from keyStore)
          # - keyStorePassword    (string specifying password to the key store - encoded or not)
          # - trustStorePassword  (string specifying password to the trust store - encoded or not)
          #
          # Uncomment these properties to set the SSL configuration.
          #------------------------------------------------------------------------------
          #alias=clientprivate
          #contextProvider=IBMJSSE
          #protocol=SSL
          #keyStoreType=JKS
          #keyStore=etc/test/security/client.private
          #keyStorePassword={xor}PDM2OjErLyg\=
          #trustStoreType=JKS
          #trustStore=etc/test/security/server.public
          #trustStorePassword={xor}Lyo9MzY8
      

      [Windows] If you are using Windows, you must escape any backslash ( \ ) characters in the path. For example, if using the path C:\opt\ibm, enter C:\\opt\\ibm in the properties file.

  2. Establish and maintain connections to catalog servers that to monitor. Repeat the following steps to add each catalog server to the configuration.

    1. Click Settings > eXtreme Scale Catalog Servers.

    2. Add a new catalog server.

      1. Click the plus sign to display a dialog for registering an existing catalog server.

      2. Provide information, such as the host name, JMX port, and listener port.

      3. Click OK.

      4. Verify that the catalog server has been added to the navigation tree.

  3. Group the catalog servers that you created into a catalog service domain. You must create a catalog service domain when security is enabled in the catalog servers because

    1. Click Settings > eXtreme Scale Domains page.

    2. Add a new catalog service domain.

      1. Click the add icon (plus sign) to display a dialog for registering a catalog service domain.

      2. Provide catalog service domain properties:

        Name

        Displays the host name of the domain, as assigned by the administrator.

        Catalog servers

        Lists one or more catalog servers that belong to the selected domain. You can add the catalog servers that you created in the previous step.

        Generator class

        Name of the class that implements the CredentialGenerator interface. This class is used to get credentials for clients.

        Generator properties

        Specifies the properties for the CredentialGenerator implementation class. The properties are set to the object with the setProperties(String) method. The credentialGeneratorprops value is used only if the value of the credentialGeneratorClass property is not null.

        [Fix 1 and later] eXtreme Scale client properties path

        Specifies the path to the client properties file that you edited to include SSL properties in a previous step. For example, you might indicate the c:\ObjectGridProperties\sampleclient.properties file. To stop the console from trying to use SSL connections, you can delete the value in this field, setting the value to an empty string. After you set the path, the console uses an unsecured connection.

      3. Click OK.

      4. Verify that the domain has been added to the navigation tree.
    To view information about an existing catalog service domain, click the name of the catalog service domain in the navigation tree on the Settings > eXtreme Scale Domains page.

  4. View the connection status.

    1. Go to the welcome page by clicking the Home link in the toolbar.

    2. On the right side of the toolbar, locate the drop-down list that shows the domain to which the console server is connected. To the right of the drop-down list is a connection status indicator.


Parent topic:

Monitor with the web console


Previous topic:

Start and logging in to the web console


Next topic:

View statistics with the web console