Various web agent properties influence the enablement of load balancing. Edit the properties that apply, according to the location of the load balancer or load balancers in your deployment, as follows:
When a load balancer is deployed in front of OpenSSO Enterprise and a web agent interacts with the load balancer, the following web agent properties must be edited:
com.sun.identity.agents.config.naming.url (accessible in the OpenSSOAgentBootstrap.properties file)
OpenSSO Login URL (Tab: OpenSSO Services, Name: com.sun.identity.agents.config.login.url)
Load Balancer Setup (Tab: Advanced, Name: com.sun.identity.agents.config.load.balancer.enable)
This example illustrates the web agent property settings that can be used to enable load balancing:
Property (name or label) |
Setting |
---|---|
com.sun.identity.agents.config.naming.url (accessible in the OpenSSOAgentBootstrap.properties file) |
LB-url /amserver/namingservice |
OpenSSO Login URL |
LB-url /amserver/UI/Login |
Load Balancer Setup |
Enabled |
where LB-url represents the load balancer URL. The following example is a conceivable load balancer URL:
http://LBhost.example.com:8080
In many cases, when a load balancer is deployed in front of the web agent only the property labeled FQDN Virtual Host Map (Tab: Global, Name: com.sun.identity.agents.config.fqdn.mapping) is required.
Assign the following value to the FQDN Virtual Host Map property:
valid|LB-hostname
where LB-hostname represents the name of the machine on which the load balancer is located.
However, if SSL-termination or a proxy server is used in the deployment, all the following web agent properties should be set in addition to the preceding property:
Override Request URL Protocol (Tab: Advanced, Name: com.sun.identity.agents.config.override.protocol)
Override Request URL Host (Tab: Advanced, Name: com.sun.identity.agents.config.override.host)
Override Request URL Port (Tab: Advanced, Name: com.sun.identity.agents.config.override.port)
Override Notification URL (Tab: Advanced, Name: com.sun.identity.agents.config.agenturi.prefix)
This example illustrates how properties can be set to enable load balancing when the protocol, hostname, and port number of the load balancer differ from that of the web agent. However, if the load balancer and the web agent share one of these characteristics, such as the protocol or hostname, then the respective property would not be enabled.
Property (name or label) |
Setting |
---|---|
Override Request URL Protocol |
true |
Override Request URL Host |
(Enabled) |
Override Request URL Port |
(Enabled) |
Override Notification URL |
LB-url/amagent |
This scenario is simply a combination of the scenarios described in the preceding sections. See Load Balancer in Front of OpenSSO Enterprise and Load Balancer in Front of the Web Agent.