Connecting the web console to catalog servers

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

1. If your catalog servers have Secure Sockets Layer (SSL) enabled, you must configure a keystore and a truststore in the client properties file.
   You can enable SSL for a catalog server by setting the transportType attribute to SSL-Required or SSL-Supported in the server properties file. For more information about the SSL properties you can set on the server, see 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 more information about the SSL properties you can set for the client, see the Client properties file.
      For example, you can make a copy of the client properties file located in the wxs_install_root/ObjectGridProperties/sampleclient.properties and edit that file. The following properties are required for outbound SSL connections from the web console:

      	#------------------------------------------------------------------------------
      	# SSL Configuration
      	#
      	# - contextProvider     (IBMJSSE2, IBMJSSE, IBMJSSEFIPS, etc.)
      	# - protocol            (SSL,  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

      Important: If you are using Windows, you must escape any backslash ( \ ) characters in the path. For example, if you want to use the path C:\opt\ibm, enter C:\\opt\\ibm in the properties file. Windows directories with spaces are not supported.
2. Establish and maintain connections to catalog servers that you want to monitor. Repeat the following steps to add each catalog server to the configuration.
   1. Click Settings > Catalog Servers.
   2. Add a new catalog server.
      1. Click the add icon () to register an existing catalog server.
      2. Provide information, such as the host name and listener port. See Planning for network ports for more information about port configuration and defaults.
      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 your catalog servers because security settings are configured in the catalog service domain.
   1. Click Settings > Catalog Service Domains page.
   2. Add a new catalog service domain.
      1. Click the add icon () to register a catalog service domain. Enter a name for the catalog service domain.
      2. After you create the catalog service domain, you can edit the properties. The catalog service domain properties follow:

         Name

         Indicates 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

         Specifies the name of the class that implements the CredentialGenerator interface. This class is used to get credentials for clients. If you specify a value in this field, the value overrides the crendentialGeneratorClass property in the client.properties file.

         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. If you specify a value in this field, the value overrides the credentialGeneratorProps property in the client.properties file.

         eXtreme Scale client properties path

         Specifies the path to the client properties file that you edited to include SSL properties. For example, you might indicate the /ObjectGridProperties/sampleclient.properties file. If you want to stop the console from trying to use SSL connections, you can delete the value in this field. 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 > Catalog Service Domains page.
4. View the connection status.
   The Current domain field indicates the name of the catalog service domain that is currently being used to display information in the web console. The connection status displays next to the name of the catalog service domain.