wasp AC Configuration

The wasp probe is installed as a core probe with CA UIM to manage network communications. While typically no additional configuration is necessary after installation, parameters can be changed in response to specific system needs using the Admin Console portlet. These needs may include use of a secure communications protocol or loading wasp as part of a multiple-UMP installation.
uimpga-ga
wasp_AC
The wasp probe is installed as a core probe with CA UIM to manage network communications. While typically no additional configuration is necessary after installation, parameters can be changed in response to specific system needs using the Admin Console portlet. These needs may include use of a secure communications protocol or loading wasp as part of a multiple-UMP installation.
: The parameters described in the following sections should only be modified by experienced personnel. Mistaken changes to wasp configuration can make UMP or some of its portlets inaccessible.
Verify Prerequisites
Details on UMP dependencies that affect wasp installation and use can be viewed at Install Unified Management Portal in the documentation for CA UIM.
Configuration Overview
Configuration of wasp defines network communications parameters. You may need to reconfigure the wasp probe or web applications running under wasp in response to system configuration changes: for instance, if you are configuring a secondary UMP server.
Configuration of wasp is completed in three areas:
  •  
    wasp
     
  •  
    Loggers
     
  •  
    Web Applications
     
 The following diagram shows the tasks you complete to configure wasp communication parameters.
waspConfig
waspConfig
 
 
2
 
 
Configure wasp
Default values for wasp parameters are loaded at installation. These can be changed as necessary.
 You should be familiar with wasp functionality before making any changes to settings.
 
Follow these steps:
 
  1. Open the Admin Console portlet.
  2. Select the hub where it is installed.
  3. Scroll through the list of probes installed on the hub to find wasp.
  4. Click on the button to the left of the probe name and selecting the Configure option.
Probe information gives the installation settings for wasp. These fields are not editable.
As display conventions, required configuration fields are indicated with an asterisk (*) and scroll arrows at the right side of fields indicate menu options or value increases or decreases.
Change Logging Parameters
You may wish to change the logging level in order to capture more information on wasp processes. Log levels define the threshold of events to include in the log file.
Log size defines the size of the returned list: when the maximum size is reached, older entries are deleted in order to accommodate more recent ones. If the threshold for inclusion is reduced, you may wish to increase the log file to capture the more important entries.
 
Follow these steps:
 
  1. Click anywhere in the Log Level field to see a drop-down list of severities.
  2. Click on a severity rating to select it, with 5 (Tracing) the least severe and 0 (Fatal) the most severe.
  3. Click in the Log Size field to enter a new value or click on the up and down arrows to the right to increase or decrease the current value.
Set Up Connector Handlers
One communication port is set for UMP communications at installation, typically through the HTTP port displayed in wasp. To allow wasp to handle a greater number of concurrent requests, or to optimize response times, you can configure several parameters in wasp. Or you may want to add a secure HTTPS port in order to encrypt certain types of requests.
 
Follow these steps:
 
  1. In the 
    Protocol Configuration
     section, assign an HTTPS port.
  2. Replace the self-signed certificate.
  3. Enter a new password.
  4. Set other parameters.
Details on these procedures can be found in Implement HTTPS in UMP in the documentation for UIM for complete procedures.
 For security reasons, you can remove the HTTP port if you do not wish to allow HTTP connections. However, there are additional steps required to configure UMP to use an HTTPS connection. The AJP protocol allows an Apache web server to connect to wasp to provide load balancing or for a DMZ configuration. See the article Set up Access to UMP through a DMZ for more information.
In addition to the parameters accessed through the wasp configuration screen, the following are optional parameters accessed through the Raw Configuration option for wasp.
  •  
    http_protocol, https_protocol, 
    and
     ajp_protocol 
    specify the protocol handlers wasp uses for incoming traffic. The default value is HTTP/1.1, and configures the org.apache.coyote.http11.Http11Protocol. This is the blocking Java connector.
    The possible values for this parameter are as follows:
    • org.apache.coyote.http11.Http11Protocol--this value is the same as HTTP/1.1.
    • org.apache.coyote.http11.Http11NioProtocol--this value is for the non-blocking Java connector.
    • org.apache.coyote.http11.Http11AprProtocol--this is the value for the APR connector.
 To use the APR connector, you must set 
apr_enabled
 to 
true
 and have the Tomcat Native library installed. Be advised that the APR connector has different settings for HTTPS than for the default Java connector.
  •  
    http_connector, https_connector, ajp_connector
     keys add the corresponding connector section for advanced fine-tuning options. All keys specified in connector sections are passed through to the corresponding connector.
  •  
    apr_enabled
     configures the AprLifecycleListener and load the Apache Tomcat Native library tcnative-1. By default, this parameter is set to false.
 This is an advanced option, and is not recommended unless you absolutely must use the Apache Tomcat Native library. You must have the correct version of the library for your platform, and it must be present in the Nimsoft/lib folder of the UMP installation. The Apache Tomcat Native library is not included with wasp; download and install it according to the instructions.
To implement HTTPS in UMP or Admin Console, you must first assign an HTTPS port in wasp, replace the self-signed certificate, enter a new password, and set other parameters. Details on these procedures can be found in Implement HTTPS in UMP in the documentation for UIM.
  •  
    apr_ssl_engine
    . If APR is enabled, you can use this parameter to enable ssl_engine. The default value is true.
 
Follow these steps:
 
  1. Open the Admin Console portlet.
  2. Select the hub where it is installed.
  3. Scroll through the list of probes installed on the hub to find wasp.
  4. Click on the button to the left of the probe name and selecting the Raw Configure option.
  5. Click on the Setup folder in the left pane.
  6. Click on the Add key option and enter the parameter name and value.
The following is an example configuration that uses the NIO connector to handle HTTP requests on port 80, as the parameters would be viewed in the wasp configuration file. Some parameters for the connector's behavior are fine-tuned in this example:
<setup>
...
http_port = 80
http_max_threads = 200
http_protocol = org.apache.coyote.http11.Http11NioProtocol
<http_connector>
minSpareThreads = 200
acceptorThreadCount = 1
processorCache = 200
maxKeepAliveRequests = 1
acceptCount = 300
connectionTimeout = 60000
</http_connector>
...
</setup>
You can verify that the updated configuration is applied by setting the com.nimsoft.nimbus.probe.service.wasp.Probe logger to level 3 and then restarting wasp. If your changes took effect, the log file will show the values you configured.
Configure Database Connections
You can add or edit several dbcp parameters in the Raw Configure screens to configure the behavior of the wasp database connection pool.
 
Example: Connection Validation 
 
The following is an example that configures the database connection pool to run the SQL query 
SELECT 1 
before the web application borrows the connection, as the parameters would be viewed in the wasp configuration file. If the test query fails, the pool will try to find another working connection.
<setup>
<dbcp>
validationQuery = SELECT 1
testOnBorrow = true
</dbcp>
</setup>
 
Example: Web Application-Specific Connection Pool
 
You can also use the dbcp parameters section in the Raw Configure option under individual web applications. In the following example, the initialSize parameter specifies the number of connections that the connection pool creates upon startup, as the parameters would be viewed in the wasp configuration file.
<webapps>
<ROOT>
<jdbc>
<1>
name = jdbc/LiferayPool
<dbcp>
initialSize = 20
</dbcp>
</1>
</jdbc>
</ROOT>
Configure wasp for Multiple UMP Servers
Configure wasp for communications between multiple UMP servers. For details, see the article Configure Multiple UMP Servers 
.
 
Configure Loggers
Wasp is installed with several internal loggers, such as Apache Tomcat loggers, to help debug portlet issues, such as portlet definitions. You can add loggers to extend logging capabilities and set them to different log levels from this tab or set existing loggers to another message severity.
 
Follow these steps:
 
  1. Click on 
    New 
    in the header to enter a new logger or select the existing logger to be edited.
  2. Enter details in the box below the list.
The default log size is 100 KB but can be increased. When you are configuring log size, be aware that both the internal wasp logger and all of the web application loggers write to the same log file.
Configure Web Applications
Web applications are typically installed on the same hub as wasp. Loggers can be assigned to any of the applications, as well as specific database connections and custom properties.
Individual applications can be turned on or off in the configuration page, but they also can be set to start automatically on wasp startup or by manual startup only. To configure web applications, select any of the web applications in the left-hand pane to view its configuration settings in the right-hand pane.
 
Follow these steps:
 
  1. Click on the triangle next to the Web Applications folder to expand the list of applications.
  2. Click on a web application.
  3. Click on the icon to the right of the name to turn the application on or off.
  4. Set the Startup Mode.
  5. Click on the New option or an existing name within any of the other sections and enter or edit information for the parameter in the values screen.
 Stopping a web application will affect only the current session. If the application is set to start automatically, the application will restart when wasp is restarted.
Configure the HTTP Connector Handlers
To allow wasp to handle a greater number of concurrent requests, or to optimize response times, you can configure several parameters in the <setup> section of the wasp configuration window. This topic provides a description of these parameters, and an example of their use.
 Do not attempt to modify the parameters described in this section unless you are proficient with Tomcat web server. Refer to other Tomcat resources for additional information.
  •  
    http_port, https_port, ajp_port
    Specifies the protocols and corresponding ports that wasp uses for incoming connections.
  •  
    http_max_threads, https_max_threads, ajp_max_threads
    These parameters set the maximum number of request processing threads to be created by this connector. This determines the maximum number of simultaneous requests that can be handled.
  •  
     http_protocol, https_protocol, ajp_protocol
    These optional parameters specify the protocol handlers that wasp uses for incoming traffic. The default value is HTTP/1.1, and configures the org.apache.coyote.http11.Http11Protocol. This is the blocking Java connector.
    The possible values for this parameter are as follows:
    • org.apache.coyote.http11.Http11Protocol--this value is the same as HTTP/1.1.
    • org.apache.coyote.http11.Http11NioProtocol--this value is for the non-blocking Java connector.
    • org.apache.coyote.http11.Http11AprProtocol--this is the value for the APR connector.
       To use the APR connector, you must set 
      apr_enabled
       to 
      true
       and have the Tomcat Native library installed. Be advised that the APR connector has different settings for HTTPS than for the default Java connector.
  •  
    apr_enabled
    Configures the AprLifecycleListener, and loads the Apache Tomcat Native library tcnative-1. By default, this parameter is set to false.
    This is an advanced option, and is not recommended unless you absolutely must use the Apache Tomcat Native library. You must have the correct version of the library for your platform, and it must be present in the Nimsoft/lib folder of the UMP installation. The Apache Tomcat Native library is not included with wasp; download and install it according to the instructions at .
  •  
    apr_ssl_engine
    If APR is enabled, you can use this parameter to enable ssl_engine. The default value is true.
  •  
    <http_connector>, <https_connector>, <ajp_connector> 
    All keys specified in connector sections are passed through to the corresponding connector. The possible configuration parameters and their behavior are described at .
 
NIO Connector Example
 
The following is an example configuration that uses the NIO connector to handle HTTP requests on port 80. Some parameters for the connector's behavior are fine-tuned in this example:
<setup>
...
http_port = 80
http_max_threads = 200
http_protocol = org.apache.coyote.http11.Http11NioProtocol
<http_connector>
minSpareThreads = 200
acceptorThreadCount = 1
processorCache = 200
maxKeepAliveRequests = 1
acceptCount = 300
connectionTimeout = 60000
</http_connector>
...
</setup>
You can verify that the updated configuration is applied by setting the com.nimsoft.nimbus.probe.service.wasp.Probe logger to level 3, and then restarting wasp. If your changes took effect, the log file will show the values you configured.
Configure the CA UIM Database Connection Pool
To configure the behavior of the wasp database connection pool, you can add or edit several parameters in the <dbcp> section, which is under the <setup> section of the wasp configuration window. This section provides examples of these parameters in use.
 
Connection Validation Example
 
The following is an example that configures the database connection pool to run the SQL query 
SELECT 1 
before the web application borrows the connection. If the test query fails, the pool will try to find another working connection.
<setup>
<dbcp>
validationQuery = SELECT 1
testOnBorrow = true
</dbcp>
</setup>
 
Web Application-Specific Connection Pool Example
 
You can also use the <dbcp> section under individual web applications. In the following example, the initialSize parameter specifies the number of connections that the connection pool creates upon startup.
<webapps>
<ROOT>
<jdbc>
<1>
name = jdbc/LiferayPool
<dbcp>
initialSize = 20
</dbcp>
</1>
</jdbc>
</ROOT>