The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
In CPS, reference data is considered information that is needed to operate the policy engine, but not used for evaluating policies. For example, in the Reference Data tab in Cisco Policy Builder, are the forms used to define systems, clusters, and instances, and to set times and dates used for tariff switching. The policy engine needs to refer to this data only to process policies correctly. However, the data does not define the policy itself.
Cisco Policy Builder provides core plug-ins for customizing and optimizing your installation.
Configurations set at the system level are system-wide except as noted in the bullet items below.
Configurations set at the cluster level apply to that cluster and the instances in it. A value set here overrides the same value set at the system level.
Configurations set at the instance level apply to the instance only and override the same value set at the cluster or system level.
Select the Create Child action in a Plug-in Configuration node in the Systems tree to define them. You can change any of the variables from the default, or choose not to use a plug-in, as necessary.
When you create a system from the example, the following configuration stubs appear at the cluster and instance level:
A threading configuration utility is provided for advanced users.
Click Threading Configuration in the right pane to add the threading configuration to the system. If you are planning to run the system with higher TPS, then you need to configure Threading Configuration. For further information, contact your Cisco Technical Representative.
The Threading Plug-in is for Mobility. The only value to set is rules. It controls the total number of threads in the Policy Engine that are executing at any given time. The default value is 50.
Cisco recommends not to configure the value below 50, but it can be set higher to help increase performance in certain situations.
The following parameters can be configured under Threading Configuration:
Parameter |
Description |
---|---|
Thread Pool Name |
Name of the Cisco thread pool. |
Threads |
Threads to set in the thread pool. You can set Rules Thread to 50/100 depending on call flow (based on number of lookup and per transaction round trip time). |
Queue Size |
Size of the queue before they are rejected. |
Scale By Cpu Core |
Select this check box to scale the maximum number of threads by the processor cores. |
Click Portal Configuration from right pane to add the configuration in the system.
Parameter |
Description |
---|---|
Primary Database Host/IP Address |
IP address or a host name of the sessionmgr database. |
Secondary Database Host/IP Address |
Optional, this field is the IP address or a host name of a secondary, backup, or failover sessionmgr database. |
Database Port |
This is required. This is the port the Balance database uses, that is, the port of sessionmgr. |
Click Async Threading Configuration in the right pane to add the configuration in the system.
Use the default values for the Async Threading Plug-in. Similar to the Threading Plug-in, the Async configuration controls the number of asynchronous threads operating in the Policy Engine. The Policy Engine handles two basic types of messages - synchronous and asynchronous. Synchronous messages block and expect a response.
Asynchronous messages are sent into the Policy Engine but do not expect a response. Therefore, the Policy Engine can defer those to worker threads that operate along side the main Policy Engine threading execution without causing too much traffic for performance.
Note | Always select the link for Async Threading Configuration to configure your CPS system. |
The following parameters can be configured under Async Threading Configuration.
Parameter |
Description |
---|---|
Default Processing Threads |
The number of threads that are allocated to process actions based on priority. |
Default Action Priority |
The priority assigned to an action if it is not specified in the Action Configurations table. |
Default Action Threads |
The number of threads assigned to process the action if it is not specified in the Action Configurations table. |
Default Action Queue Size |
The number of actions that can be queued up for an action if it is not specified in the Action Configurations table. |
Default Action Drop Oldest When Full |
When checked, the oldest queued action is dropped from the queue when a new action is added to a full queue. Otherwise, the new action to add is ignored. This check box applies to all the threads specified. To drop a specific thread, leave this unchecked and use the Action Configurations table. |
Action Configurations Table |
|
Action Name |
The name of the action. This must match the implementation class name. |
Action Priority |
The priority of the action. Used by the default processing threads to determine which action to execute first. |
Action Threads |
The number of threads dedicated to processing this specific action. |
Action Queue Size |
The number of actions that can be queued up. |
Action Drop Oldest When Full |
For the specified action only: When checked, the oldest queued action is dropped from the queue when a new action is added to a full queue. Otherwise, the new action to add is ignored. |
Before you can create a custom reference data table, configure your system to use the Custom Reference Data Table plug-in configuration.
You only have to do this one time for each system, cluster, or instance. Then you can create as many tables as needed.
Click Custom Reference Data Configuration from right pane to add the configuration in the system.
Here is an example for HA and AIO setups:
The following parameters can be configured under Custom Reference Data Configuration.
Parameter |
Description |
---|---|
Primary Database Host/IP Address |
IP address or a host name of the sessionmgr database. |
Secondary Database Host/IP Address |
Optional, this field is the IP address or a host name of a secondary, backup, or failover sessionmgr database. |
Database Port |
Port number of the sessionmgr. It should be the same for both the primary and secondary databases. |
Db Read Preference |
Read preference describes how sessionmgr clients route read operations to members of a replica set. You can select from the following drop-down list:
For more information, refer to http://docs.mongodb.org/manual/core/read-preference/. |
Connection Per Host |
Number of connections that are allowed per DB Host. Default value is 100. |
Avp Persists |
This table provides CPS with the ability to configure certain AVPs that need to be stored in the session database. AVPs that are not configured as part of this table, are not persisted.
To retrieve these stored AVPs from the session, Customer Reference Data Debug AVPs retriever can be used. This retriever is used in the PolicyState/Session data to Custom AVP Mapping under Custom AVP Profiles, to send the stored AVPs in any diameter message. When configuring the AVP Persists table in the Policy Builder, for each AVP, its corresponding AVP Name and Name is expected to be configured. If either is found to be empty, then the particular AVP is not added to the Gx session. Thus the concerned AVP is not available to send in any custom AVP as well. |
For more information on Custom Reference Data API Usage, refer to the CPS Operations Guide for this release.
Click Balance Configuration in the right pane to add the configuration in the system.
The following parameters can be configured under Balance Configuration:
Parameter |
Description |
||||||
---|---|---|---|---|---|---|---|
Primary Database Host/IP Address |
IP address or a host name of the sessionmgr database. |
||||||
Secondary Database Host/IP Address |
Optional, this field is the IP address or a host name of a secondary, backup, or failover sessionmgr database. |
||||||
Database Port |
This is required. This is the port the Balance database uses, that is, the port of sessionmgr. |
||||||
Db Write Concern |
Controls the write behavior of sessionmgr and for what errors exceptions are raised. Default option is OneInstanceSafe. |
||||||
Db Read Preference |
Read preference describes how sessionmgr clients route read operations to members of a replica set. You can select from the following drop-down list: For more information, refer to http://docs.mongodb.org/manual/core/read-preference/. |
||||||
Failover Sla Ms |
This parameter is used to enter the amount of time to wait before starting failover database handling. The time is in milliseconds. |
||||||
Max Replication Wait Time Ms |
This option specifies a time limit, in milliseconds, for the write concern. This parameter is applicable only if you select TwoInstanceSafe in Db Write Concern. This parameter causes write operations to return with an error after the specified limit, even if the required write concern eventually succeeds. When these write operations return, MongoDB does not undo successful data modifications performed before the write concern exceeded the replication wait time limit. This time is in milliseconds. |
||||||
Default Minimum Dosage Time Based |
This field is optional but recommended. This is the minimum amount of time that is granted for a reservation, assuming quota is not exhausted. If you want to manage subscriber balances on the basis of time used, check with the network device administrator and configure this value to be slightly larger than the minimum amount of time the network device such as an SCE or ISG accepts for a reservation. Minimum value is 2 seconds. |
||||||
Default Minimum Dosage Volume Based |
This field is optional but recommended. This is the minimum amount of volume that is granted for a reservation, assuming quota is not exhausted. If you try to make a reservation for 1 KB, and your minimum is 10 KB, the router rejects it because it is too small an amount to bother with. |
||||||
Expired Reservations Purge Time (minutes) |
The amount of time a record of expired reservations is retained and Cisco MsBM attempts to charge them. Expired reservations are charged only if sufficient quota is still available; that is, expired reservations do not retain the lock on quota that current reservations do. Default value is 0. |
||||||
Recurring Refresh Max Delay (minutes) |
The amount of time refreshing of recurring quotas are staggered across randomly, for sessions that are not actively using quota but are still established. This parameter is used in cases where subscribers always have a session, but is not using their quota actively. This allows staggering of recurring refreshes where you have set all their subscribers to refresh at the same time, say midnight. It avoids spiking the CPU. Default value is 0. To calculate the Recurring Refresh Max Delay, use the following: Recurring Refresh Max Delay = (Number of sessions / Max Timer TPS) * 2 For example: If 30 million sessions are present on the system, and Max Timer TPS is configured to 2000, then
In case you want to configure a lesser time for the Recurring Refresh Max Delay, then the Max Timer TPS needs to be increased accordingly.
|
||||||
Remote Database Lookup Filter Type |
This drop-down list is used to do a lookup in remote databases bases on selected filter type. This is similar to Filter Type drop-down under API Router Configuration. By default, NetworkId is selected.
|
||||||
Reduce Dosage on Threshold |
When checked, reservation dosages are reduced as a Cisco MsBM threshold is approached. This way, a dosage does not pass a threshold by a large amount before notification of the breach is sent out. When unchecked, normal dosage is granted. Recall that when enabled, messaging becomes much more chatty, but threshold breach accuracy is enhanced. |
||||||
Submit Balance Events To Reporting |
Submits balance transaction to the policy engine, and these can be reflected in reporting. |
||||||
Enable Crd Balance Template Lookups |
When checked, CPS is enabled to lookup CRD defined balance templates. If the CRD tables are not defined, this feature is disabled.
|
||||||
Remote Database |
|||||||
Name |
String - Name of the remote database. |
||||||
Key Prefix |
Key prefix to be match for the remote database to be selected for lookup. |
||||||
Connections Per Host |
Number of connections that can be created per host. Default value is 5. |
||||||
Db Read Preference |
Read preference describes how sessionmgr clients route read operations to members of a replica set. You can select from the following drop-down list: For more information, refer to http://docs.mongodb.org/manual/core/read-preference/. |
||||||
Primary Database Host/IP address |
IP address or a host name of the sessionmgr database. |
||||||
Secondary Database Host/IP address |
Optional, this field is the IP address or a host name of a secondary, backup, or failover sessionmgr database. |
||||||
Port |
Port number of the remote sessionmgr database. It must be the same for both the primary and secondary databases. |
||||||
Backup Db Host On Local Site |
String - The host name of backup database for remote balance for current site. Default value is sessionmgr01. |
||||||
Backup Db Port on Local Site |
The port number of backup database for remote balance for current site. Default value is 27719. |
If you have a Geo-Redundancy setup, click Backup Db Configuration. It stores back up of entire balance records. If the primary balance database goes down, CPS will check the balance record on both secondary and backup databases, and take the latest version for processing.
The following parameters can be configured under Backup Db Configuration:
Parameter |
Description |
---|---|
Backup Db Host |
Default value is sessionmgr01. |
Backup Db Port |
Default value is 27719. |
Backup Db Monitor Interval In Sec |
Used in thread which updates the primary balance DB (when primary balanceDB is available after fail over) with 'BackupBalance' db records. Default value is 3 seconds. |
Rate Limit |
Used to control the TPS (with how much TPS reconciliation should happen once primary balance db is up). |
Click Diameter Configuration in the right pane to add the configuration in the system.
Click Voucher Configuration in the right pane to add the configuration in the system.
The voucher plug-in uses the following defaults:
The following parameters can be configured under Voucher Configuration:
Parameter |
Description |
---|---|
Primary Database Host/IP Address |
The IP address or a host name of the Session Manager database that holds voucher information for Cisco Policy Builder and Cisco Policy Server. |
Secondary Database Host/IP Address |
The IP address or a host name of the database that provides fail over support for the primary database. This is the mirror of the database specified in the Primary Database IP Address field. |
Database Port |
Port number of the sessionmgr. It must be the same for both the primary and secondary databases. |
Disable Vouchers |
Select the check box to disable voucher configuration. |
Click Unified API Configuration in right pane to add the configuration in the system.
The following parameters can be configured under Unified API Configuration:
Parameter |
Description |
---|---|
Fields To Wrap With Cdata Tags |
This is a CSV separated string. The Unified API can handle CDATA fields. Use the Plug-in configuration in Policy Builder to set CDATA fields for the main Unified API. The property ua.cdata.fields is used to set the fields that must be wrapped in CDATA tags for the client CommFactory to properly send and receive API requests. -Dua.cdata.fields=networkId,password,data,oldNetworkId,oldPassword,newPassword is the default. |
Submit Requests To Audit Log |
Select the check box to log requests to API in audit log. Default value is True (checked). |
Submit Read Requests To Audit Log |
Select this check box to log read requests in audit log. Default value is False (unchecked). |
Notification in Cisco Policy Builder relates to pushing messages from Cisco Policy Builder to subscribers. The messages are used to alert the subscriber of issues as well as opportunities on their network. Not only can you alert subscribers, but you can also send messages to any address, for example, system monitoring addresses.
Currently, Cisco Policy Builder offers following notification types for Mobile:
Apple iOS devices/iPhone® push (iOS devices)
Email (IMAP only)
SMS notification (SMPP v 3.4)
Realtime Notification
The following parameters can be configured under Notification Configuration. For more information about these parameters, see the Notification Services chapter.
Parameter |
Description |
---|---|
Apple Push Notification Configuration |
Select this check box to configure the connection for a push to an Apple iOS device or iPhone. |
Email Notification Configuration |
Select this check box to configure the connection for an email notification. |
SMS Notification Configuration |
Select this check box to configure the connection for a SMS notification. |
Realtime Notification Configuration |
Select this check box to configure the connection for a realtime notification. |
Click Audit Configuration in the right pane to add the configuration in the system.
The following parameters can be configured in the General Configuration pane under Audit Configuration:
Parameter |
Description |
---|---|
Capped Collection check box |
Select this check box to activate capped collection function. |
Capped Collection Size |
By default, the Audit History uses a 1 GB capped collection in MongoDB. The capped collection automatically removes documents when the size restriction threshold is hit. Configuration in Policy Builder is done in GB increments. It is possible to enter decimals, for example, 9.5 will set the capped collection to 9.5 GB. |
Log Read Requests check box |
Select this check box if you want read requests to be logged. |
Include Read Requests In Query Results check box |
Select this check box only if you want to include read requests to be displayed in query results. |
Disable Regex Search check box |
If you select this check box, the use of regular expressions for queries is turned off in the Policy Builder configuration. |
Search Query Results Limit |
This parameter limits the search results. |
For more information related to other parameters like Queue Submission Configuration, Database Configuration, Shard Configuration under Audit Configuration, refer to the CPS Operations Guide for this release.
Click USuM Configuration from right pane to add the configuration in the system.
The following parameters can be configured in the Spr Configuration pane under USuM Configuration:
Parameter |
Description |
||
---|---|---|---|
Spr Configuration |
|||
Disable Regex Search |
For SP Wi-Fi, you can use email ID which has realm, username, and so on, as key of SPR. So, part of the string needs to match for regex support.
|
||
Enable Avp Regex Search |
For regex search on values for AVP for SPR. |
||
Exclude Suspended Subscribers From Policy |
If the subscriber state is Suspended, SPR does not validate IMSI. |
||
Search Query Results Limit |
Used to limit search if you are not passing any IMSI/MSISDN (NetworkID) in control center to list subscriber. Default value is 1000. |
||
Max Number Of Locations To Store In History |
It is used to track subscriber last location to maintain history. Maximum “n” last locations are stored as location history. |
||
Last Visited Date Threshold |
This parameter is used to identify if the subscriber is visiting same location again (based on the location history). If the subscriber is vising the same location, then it will change the last visited date if current visited date is more than last visited date + “n” days defined here. |
The following parameters can be configured in the Policy Engine Submission Configuration pane under USuM Configuration:
Parameter |
Description |
---|---|
Enable check box |
Keep it default. |
Message Queue Size |
Queue to hold data to generate internal SPR Refresh events for policy engine during Create, Update, Delete of subscriber. |
Message Queue Sleep |
Sleep before popping next batch for generating SPR Refresh events for policy engine for RAR processing. |
Message Queue Batch Size |
Batch size for fetching number of subscriberIds in one go for generating SPR Refresh events for policy engine for RAR processing. |
Message Queue Pool Size |
Message queue pool size to consume the data from queue and generate SPR Refresh events. |
Notification Rate Limit |
Rate limiting for generating SPR Refresh events. SPR Refresh events is used to generate RAR for active session where subscriber data has been change. |
The following parameters can be configured in Database Configuration pane under USuM Configuration:
Parameter |
Description |
---|---|
Database Configuration |
|
Use Minimum Indexes |
It is used to decide what all indexes need to be created on SPR collection by default. You need all the indexes to be created (You can select this check box when number of subscribers are low, for example, less than 50K). Default value is unchecked. |
Db Write Concern |
Controls the write behavior of sessionmgr and for what errors exceptions are raised. Default option is OneInstanceSafe. |
Db Read Preference |
Read preference describes how sessionmgr clients route read operations to members of a replica set. You can select from the following drop-down list: For more information, refer to http://docs.mongodb.org/manual/core/read-preference/. |
Failover Sla Ms |
This parameter is used to enter the amount of time to wait before starting failover database handling. The time is in milliseconds. |
Max Replication Wait Time Ms |
This option specifies a time limit, in milliseconds, for the write concern. This parameter is applicable only if you select TwoInstanceSafe in Db Write Concern. This parameter causes write operations to return with an error after the specified limit, even if the required write concern eventually succeeds. When these write operations return, MongoDB does not undo successful data modifications performed before the write concern exceeded the replication wait time limit. This time is in milliseconds. |
Shard Configuration |
|
Primary Database Host/IP Address |
String - Primary Host Address. |
Secondary Database Host/IP Address |
String - Secondary Host Address. |
Port |
Default value is 27720. |
Click Add to add a new row in the Remote Database Configuration pane. The following parameters can be configured in the Remote Database Configuration pane under USuM Configuration:
Parameter |
Description |
---|---|
Name |
String - Name of the remote database. |
Key Prefix |
Key prefix to be match for the remote database to be selected for lookup. |
Connections Per Host |
Number of connections that can be created per host. Default value is 5. |
Db Read Preference |
Read preference describes how sessionmgr clients route read operations to members of a replica set. You can select from the following drop-down list: |
Primary Host/IP Address |
IP address or a host name of the remote sessionmgr database. |
Secondary Host/IP Address |
(Optional) This field is the IP address or a host name of a secondary, backup, or failover sessionmgr database. |
Port |
Port number of the remote sessionmgr database. It must be the same for both the primary and secondary databases. Default value is 27720. |
The Scheduled Events plug-in is configured in the Policy Builder to implement offline notifications and SPR cleanup. Offline notifications send an SMS notification to an off-line subscriber indicating that their quota is about to expire. SPR cleanup allows you to delete subscriber data that is no longer needed or valid. For example, a subscriber account no longer has any services assigned to it, and therefore should be deleted from the database.
To enable the scheduled events framework, this feature has to be enabled in the feature set of Policy Server and Policy Builder. The following packages, when added to the respective servers, deploy the functionality of scheduledEvents during a session:
In the Policy Builder – com.broadhop.client.feature.scheduledevents package is added.
In the Policy Server – com.broadhop.scheduledevents.service.feature package is added.
To add Scheduled Events Configuration, perform the following steps:
Step 1 | Click Scheduled Events Configuration in the right pane. | ||||||||||||||||||||||||||||||||
Step 2 | In the
Scheduled Event Configuration pane and enter the
values for the fields provided.
The following table describes the parameters that can be configured under Scheduled Events Configuration.
|
CPS has capability to access subscriber profile data either from internal or external database. LDAP/Ud feature fetches subscriber profile data from the external database.
In this section, LDAP plug-in configuration is used an example.
LDAP plugin queries the LDAP server to fetch attributes depending on the configuration. This feature has capability to refresh the profile and fetch the latest updated attribute from the LDAP server. CPS connects to multiple LDAP severs and queries them depending on the LDAP server priority.
Note | Refer to CPS Installation Guide for VMware to configure this plugin. |
Click LDAP Configuration from the right pane to add the configuration in the system.
Click Ldap Server Configuration.
The following parameters can be configured under LDAP Server Configuration:
Parameter |
Description |
||
---|---|---|---|
Ldap Server |
Assign this to the LDAP Server Set. |
||
Search User Dn |
The user DN for connecting to the LDAP server; for example, cn=managerou=accountso=profile. |
||
Search User Password |
The password for connecting to the LDAP server.
|
||
Auth Type |
The LDAP authorization type required by the LDAP server. Default: SIMPLE |
||
Initial Connections |
Set the initial connections to “50.” This represents the number of connections from a Policy Director (load balancer) to the LDAP server(s). |
||
Retry Count |
The total number of tries the system executes for a given LDAP query. For example, a value of 2 indicates one try and then one more attempt when the query times out. |
||
Retry Time Ms |
The time period when the policy engine retries to a second Policy Director (load balancer) to send the request.
|
||
Max Failover Connection Age Ms |
The time in milliseconds a secondary connection is used before checking to determine if the original primary server is available. This is the time to fall back from a failover connection. CPS returns the connection to the LDAP connection pool and gets another connection. Default: 60000 milliseconds (1 minute) |
||
Binds Per Second |
The maximum rate at which to connect to the LDAP server. Setting this to a high value may result in extra load on the peer LDAP server. |
||
Health Check Interval Ms |
The time in milliseconds to generate a health check message; for example, 5000 milliseconds (5 seconds). |
||
Health Check Dn |
The health check DN that is sent on the health check LDAP query. |
||
Health Check Filter |
The filter that is sent on the health check LDAP query. |
||
Health Check Attrs |
A comma-delimited list of attributes to retrieve in the LDAP health check query. |
||
Health Check |
Select this check box to enable the health check. |
||
Number Consecutive Timeouts For Bad Connection |
The number of timeouts that trigger a bad connection and force a reconnection. A value of -1 disables this function, preventing CPS from marking any connection bad. Default: -1 |
Add entries to the LDAP Servers to represent the primary and secondary connections from the CPS system to the LDAP servers.
You can configure the following parameters under LDAP Servers:
Parameter |
Description |
---|---|
Priority |
The priority of the server when sending requests. Higher number is equal to higher priority. |
Address |
The IP address of the server to send requests. |
Port |
The port address of the LDAP Server. |
Connection Rule |
This setting is not currently used. |
Auto Reconnect |
This setting is not currently used. |
Timeout Ms |
The SLA for queries for the LDAP server. Cisco recommends a value of 5000 milliseconds. |
Bind Timeout Ms |
The SLA for binds to the LDAP server. |
Note | Refer to the section Subscriber Lookup Feature Installation in CPS Installation Guide for VMware to configure this plugin. |
You can configure CPS to act as an LDAP server to support LDAP search queries that use framedIp/msisdn/imsi/framedIpv6Prefix key to get subscriber details.
In case multiple sessions are found for matching the same LDAP query, CPS responds with details of all the sessions to LDAP client.
The search query can come to any clusters in the deployment. For configuring cluster peer, refer to Cluster Peer Configuration. The cluster that receives the request forwards the request to all other clusters based on Cluster Peer Configuration.
In Policy Builder, click Subscriber Lookup Server Configuration from the right pane to add the configuration in the system.
The following parameters can be configured under Subscriber Lookup Server Configuration:
Parameter |
Description |
---|---|
Bind DN/Bind DN (Admin) Password |
Used to authenticate the LDAP search request before getting processed. Default: admin/password |
Ldap Server Port |
Used to configure the port where you want to start the LDAP server. Default: 1399 |
Request Timeout (ms.) |
Used to configure the time LDAP server waits to get response. Default: 5 millisec |
Health check Filter Name |
Used to add the attribute name to identify a health-check request. |
Health check Filter Value |
Used to add the filter value to identify a health-check request. |
Session update Time in ms. |
If checked, returns the session update time in milliseconds in the query response. If unchecked, session update time is returned in seconds. Default: unchecked |
Input Mapping |
Used to map Filter Id received from LDAP client to one of the internal CPS lookup keys. Is Unique Key: Indicates the key is unique for the sessions and only one session would exist for the key. If selected for non unique key, only single active session is returned for the query. Default: unchecked |
Output Mapping |
Used to define the response attributes for the client. Response attribute name can be mapped to internal CPS session attributes for added flexibility. |
Ldap Clients |
Used to configure CPS to support multiple client authentication parameters. |
Health Check Attributes |
Used to define the response attributes and values to be returned to LDAP client for Health-check requests. |
Note | "-" is not allowed in the cluster name (both local and peer). |
Local cluster must be specified with local.cluster.peer parameter in /etc/broadhop/qns.conf file. This parameter is used to find out the local cluster name and is used to create local cluster queue.
Example: -Dlocal.cluster.peer=Cluster1
All cluster peers must be specified with broadcast.cluster.peers parameter in /etc/broadhop/qns.conf file. This parameter is used to find out all other clusters and to create redisQ between local cluster and other clusters. Each cluster name must be separated with semicolon. Add all the clusters including local cluster name.
Example: -Dbroadcast.cluster.peers=Cluster1;Cluster2;Cluster3
Redis server peers must be configured in /etc/broadhop/broadcast-cluster.conf file:
This file has information about the redisQ servers. You need to provide Policy Directory (lb) VIP address if this is a HA setup. Each cluster specified in broadcast.cluster.peers must have one entry in this file to represent redis server related to that cluster.
Syntax: <ClusterName>-clusterBroadcastQ.redis.qserver=<lbvipIPadress>
where, <lbvipIPadress> is the IP address of Policy Director (LB) VIP.
ClusterName is the local cluster peer (configured for local.cluster.peer parameter in qns.conf file) of every cluster.
Example:
[root@lb02 broadhop]# cat /etc/broadhop/broadcast-cluster.conf Cluster1-clusterBroadcastQ.redis.qserver=IPaddress1 Cluster2-clusterBroadcastQ.redis.qserver=IPaddress2 Cluster3-clusterBroadcastQ.redis.qserver=IPaddress3
Note |
|