MOG Installation, Configuration, and Upgrade

Transcription

1 MOG Installation, page 1 Plugin Configuration, page 2 vpas Configuration, page 5 CDR Filter Configuration, page 9 Service Configuration, page 10 Administrator Database Configuration, page 14 Geographic Redundancy Configuration, page 15 Logback.xml Configuration to Log All CDRs, page 18 Logback.xml Configuration to Log Specific CDRs, page 18 MOG Upgrade, page 20 MOG Installation You can install MOG by selecting the mog option when you install Cisco Policy Suite. For a HA setup, select mog when prompted for the Install Type. For more information, see the CPS MOG Installation Guide for OpenStack. In the Big-Bang or customer-specific installation, update the yaml file or env file with the MOG details as shown in the following samples. Ensure that you import the CSV files in the Cluster Manager and run the import_deploy.sh script. When installing All-in-One (AIO) MOG or in a HA setup, select mog when prompted for the Install Type. For more information, see the CPS MOG Installation Guide for OpenStack. Enter the API network details when you are prompted as shown in the following example: Please enter install type [mobile wifi mog pats arbiter dra andsf]: --- Select mog. Please enter mog api network names ( : separated):: Network details:mog_api_1:mog_api_2 1

2 Plugin Configuration Plugin Configuration Use the plugin configuration parameters in the Policy Builder to configure MOG. Note If you do not configure the plugin, the system uses the default values for super tenant user and super tenant password. 1 Log in to Policy Builder. You can access Policy Builder at the following URLs: HA: AIO: For more information about Policy Builder, see the CPS Mobile Configuration Guide. 2 Select Reference Data tab. 3 From the left pane, select Systems. 4 Select and expand your system name. 5 Select and expand your cluster name. 6 Select Plugin Configurations. 7 Select MOG Configuration. The following table describes the plugin configuration parameters: Table 1: MOG Plugin Configuration Parameters Parameter Name Super Admin User Id Super Admin Password Max Allowed APN Auth System Id Message Response Timeout Default Value ciscoadmin Contact your Cisco representative for the default password. 5 CSB_AUTH_ID 20 Username for super tenant that is used for onboarding tenant or subscriber. Password for super tenant that is used for onboarding tenant or subscriber. Maximum number of APNs allowed for the tenant and the QoS request. Authentication System ID used for generating authentication token. Diameter message timeout 2

3 Plugin Configuration Parameter Name Reporting DB Configuration Primary Database IP Address Secondary Database IP Address Database Port Default Value sessionmgr01 sessionmgr This configuration takes required details to connect the MongoDB for logging the CDR Logs. The Request and Callback CDR logs are written in configured database. The IP Address/Hostname of the primary Session Manager VM for the MongoDB where CDR logs need to be written. The IP Address/Hostname of the secondary Session Manager VM for the MongoDB where CDR logs need to be written. The mongo port number on Session Manager VMs. ACRS Configuration (Optional Configuration) Authentication Token Expiry ACRS Server address Server Polling Interval User Id Password Tenant QoS Policy Tenant Name Sponsor ID Token expiry time in seconds. Default value is 24 hours. URL for the ACRS server used for fetching the Decryption keys. Interval for polling of decryption keys in seconds. User ID used for ACRS server authentication. Password used for ACRS server authentication. Name of the tenant. Sponsor ID configured for the tenant. This entry can be empty or take a valid sponsor ID value. 3

4 Plugin Configuration Parameter Name Validity Time QCI Requested Bandwidth U L Requested Bandwidth D L Sponsor Id Validation Rules Tenant Name Default Sponsor Id Use default if missing Default Value Validity Time in seconds for sessions created for the tenant and sponsor Id. This value overwrites duration supplied during create or update session. QCI value for session created for the tenant and sponsor Id pair. This value overwrites QCI supplied during create or update session. The maximum requested uplink bandwidth for sessions in the tenant and sponsor Id pair. This value overwrites Max Requested Bandwidth UL supplied during create or update session. The maximum requested downlink bandwidth for sessions in the tenant and sponsor Id pair. This value overwrites Max Requested Bandwidth DL supplied during create or update session. Name of the tenant. Default sponsor Id to be used for the tenant when Use default if missing is enabled or when validation rule value is "Use Default Sponsor Id". Indicates whether to use the default sponsor Id for the tenant if create or put request does not contain the sponsor Id field. 4

5 vpas Configuration Parameter Name Validation Rule Default Value The following options are displayed under Validation Rule: Ignore Validation Error: Ignore validation error that is returned if the tenant and sponsor Id pair in create or update request is missing in Tenant QoS Policy. Use Default Sponsor Id: Use default sponsor Id for the tenant if the tenant and sponsor Id pair in create or update request is missing in Tenant QoS Policy. Return Validation Error: Return validation error if the Tenant name and Sponsor Id pair in create or update request is missing in the Tenant QoS Policy Table. vpas Configuration You can use the vpas configuration to configure with vpas. Step 1 Log in to Policy Builder. You can access Policy Builder at the following URLs: HA: AIO: For more information about Policy Builder, see the CPS Mobile Configuration Guide. Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Select Reference Data. From the left pane, select Systems. Select and expand your system name. Select and expand your cluster name. Select Plugin Configurations. Select vpas Configuration. The following table describes the vpas configuration parameters: 5

6 vpas Configuration Table 2: vpas Configuration Parameters Parameter Server Url Fallback Server Url UserId Password Used by MOG to query the vpas to get APNs. Used by MOG to query the vpas to get APNs when "Server Url" query fails. vpas server userid. vpas server password. Tenant Details for V P A S Tenant Allowed Apns Blocked Apns Duration In minutes Polling Interval In minutes Name of the tenant. List of APNs which MOG has queried from vpas and are permitted to create sessions. List of APNs which MOG has queried from vpas and are not permitted to create any session. MOG uses this value as duration in case POST request does not have any duration. Default value is 10 minutes. MOG uses polling interval to query vpas on regular intervals. After each query to vpas MOG compares the previous list of APNs with new APNs to find out which APN is removed and which APN is added newly and takes corresponding action. Default value is 30 minutes. 6

7 vpas Configuration Parameter Lower Bound For Timer Attribute In Minutes Indicates the time taken before the "starttime". MOG has to accept the POST request if POST request comes with "starttime" Default value is 1440 minutes(1 day). For example: starttime { year:2017, month:4, day:2, hour:10, minutes:30, seconds:10 } MOG calculates "Lower Bound Acceptable Time" based on starttime and "Lower Bound For Timer Attribute In Minutes" as follows: Lower Bound Acceptable Time : ( StartTime - 30min ) which is T10:00:00Z ( 10 Am on 4 th Apr 2017) If the client sends POST request before 10 AM, MOG does not accept the request. If the client sends POST request after 10 AM, MOG accepts the request. 7

8 vpas Query Example Parameter Elapsed Time For Timer Attribute In Percentage Indicates time taken after the "starttime". MOG has to accept the POST request if POST request comes with "starttime". Default value is 100 (100%). For Example: starttime { year:2017, month:4, day:2, hour:10, minutes:30, seconds:10 } duration : 7200 ( which is 2hrs) MOG calculates "Upper Bound Acceptable Time" based on starttime, "duration" and "Elapsed Time For Timer Attribute In Percentage" configuration as follows: Upper Bound Acceptable Time = starttime + 1hr, which is T11:30:00Z ( 11:30 Am on 4th Apr 2017) If the client sends POST request after 11:30 AM, MOG does not accept the request. If the client sends POST request before 11:30 AM, MOG accepts the request. Delta For Retry Time In Minutes Indicates after how much time MOG sends callback corresponding to "starttime". Default value is 3 minutes. vpas Query Example Supported request URLs from MOG to vpas as POST request: Example: 8

9 CDR Filter Configuration Request: Response - { "bindings": [ { "age": 42298, "apn": "mog3", "desthost": null, "destrealm": null, "evaltime": null, "gxsessionid": "", "imsi": " ", "ipv4": null, "ipv6prefix": null, "msisdn": null, "originhost": "gx-pcef", "originrealm": null, "sessionroutekey": "clusterb.dc1", "stalesessionexpirycount": 0 } ], "imsi": " " } CDR Filter Configuration CDR Filter Configuration plugin is used for configuration required for transferring CDRs to external server using REST based HTTP interface. Step 1 Log in to Policy Builder. You can access Policy Builder at the following URLs: HA: AIO: For more information about Policy Builder, see the CPS Mobile Configuration Guide. Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Select Reference Data tab. From the left pane, select Systems. Select and expand your system name. Select and expand your cluster name. Select Plugin Configurations. Select CDR Filter Configuration. The following table describes the plugin configuration parameters: Table 3: CDR Filter Configuration Parameters Parameter Name Server Default Value On selection of the checkbox the external server details can be configured. 9

10 Service Configuration Parameter Name Server URL User Id Password Cron Job Expression for CDR Polling Filter Tenant Request Callback Default Value * *? External server REST URL that is used by MOG to transfer CDRs. CDR filename is appended to the URL before using the REST method. PUT method is used to transfer the files. The content is sent as octet-stream. Username for authentication. Password for authentication. This is a cron expression used for defining the periodicity of sending the CDR files. For more information on cron expression, see 1. This table is used for configuring the filters. These filters are used for selection of CDRs to be transferred to the external server. Each row identifies a combination of filters which is applied collectively for identification of CDRs. For identification of CDRs all the columns needs to match. This column identifies the tenants whose CDRs needs to be transferred. If multiple tenant values are configured then any one value is used for matching. This column identifies the CDR with "Request" event type. The values in the columns can be POST, PUT, DELETE. If multiple values are configured then any one value is used for matching. This checkbox is used for including "Callback" CDRs as part of the selection. 1 Service Configuration Use the Policy Builder to manage the service initiators and service configuration of MOG. 10

11 Service Initiators Service Initiators Use Case Initiators are groups of conditions which indicate if the Service Configuration objects in the use case template are used or not. In Policy Builder, you can find the use case initiators at Services > Use Case Template > Use Case Initiators. MOG service initiators can be configured based on the following conditions: 1 A MOG Request Message Exists: The condition satisfies if and only if a MOG Request message exists in the policy state during device manager processing. 2 A MOG Request Message does not exist: The condition satisfies if an only if MOG request message does not exits in the policy state during device manager processing. 3 A MOG Session Exists: The condition satisfies if a MOG session is present in the policy state during network device manager processing. 4 A MOG Session Does not exists: The condition satisfies if a MOG session is not present in the policy state during network device manager processing. 5 MOG Message with QCI 9: The condition satisfies when a MOG Request message exists in policy state with QCI value equal to 9. 6 MOG Message with no QCI: The condition satisfies when a MOG Request message exists in policy state with no QCI value. The following table describes the available Input variables for the service initiator conditions: Table 4: Service Initiators Input Variables Variable Name Tag Version Enterprise SponsorId Subscriber qci DPCCParamName DPCCParamValue Variable Type Integer Identifies the value of the API tag. For example, UpdateQoS Identifies the API version for the Northbound API request. For example, 1.0 Identifies the Domain of the tenant who initiated the request. Identifies the sponsor. Identifies the subscriber. QCI of the MOG request message. DPCC Param Name in the MOG Request Message. DPCC Param Value in the MOG Request Message. 11

12 Service Configuration Objects Variable Name imsi msisdn Variable Type IMSI in the MOG Request Message MSISDN in the MOG Request Message Service Configuration Objects You can use Policy Builder to configure low-level configuration objects used by CPS to drive the MOG functionality such as default bearer QoS, etc. You can add Service Configuration objects required to configure your use case for use case templates The following service configuration objects are applicable to MOG and are found in the Services > Use Case Template > Service Configurations: DefaultBearerQos DefaultBearerQos configuration object defines the default values applicable for different AVPs in case the value is not present in the incoming API request. Table 5: DefaultBearerQos Configuration Object Parameters Parameter Name Priority Diameter Client Apn To Diameter Client List Parameter Type Integer RxClient List Indicated the priority of the Service configuration object to be used in case multiple service initiator conditions matches. Identifies the RxClient to be used for sending Diameter Rx Messages to PCRF. It is a list of ApnToDiameterClient objects, each object will have the following: 1 Apn Name 2 Diameter Client associated to that Apn Name Qci Integer (1-9) Identifies the QosClassIdentifier to be used in case not present in the API request. This QCI value is mapped to Media Type AVP in Diameter AAR requests. 12

13 Service Configuration Objects Parameter Name Max Req Bandwidth U L Max Req Bandwidth D L ARP Service Info Status Media Component Number Flow Number Validity Time Volume Parameter Type Long Long Integer (0-1) Long Long Long Long Indicates the Max Bitrate (Kbits/sec) to be applied for Upload. Indicates the Max Bitrate (Kbits/sec) to be applied for Download. Allocation retention priority. PRELIMINARY_SERVICE_INFORMATION indicates apply QoS of default bearer, FINAL_SERVICE_INFORMATION indicates apply QoS as determined by PCEF Indicates the value of Media-Component-Number AVP in AAR request. The value is used only if configured greater than 0, otherwise AVP value is defaulted to 1. Indicates the value of Flow-Number AVP in AAR request. The value is used only if configured greater than 0, otherwise AVP value is defaulted to 1. Indicates the session duration if duration attribute is not passed in API request. The value is used only if configured greater than 0. Indicates the maximum amount of data in kilobytes for which the QoS change should be maintained, when the volume attribute is not passed in API request. 13

14 Administrator Database Configuration RestCallbackConfiguration RestCallbackConfiguration defines the default value for the callback in case the value is not present in the incoming API request. Table 6: RestCallbackConfiguration Configuration Object Parameters Parameter Name URL PortChange Parameter Type Enumeration The URI of the callback server. The value is appended to the client s IP address and Port calculated based on the port change Configuration. For example: port>/url Note: In case the Port Change is configured as None, the URL value is used as is configured instead of calculating the value from client s IP and PORT. Indicates if the PORT Value needs to be incremented or decremented for calculating the callback URL. Increment: Client Port will be decrement by 1 to form the callback URL. Decrement: Client Port will be incremented by 1 to form the callback URL. None: The URL value is used as is configured instead of calculating the value from client s IP and PORT. Administrator Database Configuration Use the Policy Builder to configure the administrator database that is used to store the onboarding data. In the Policy Builder, navigate to the REFERENCE DATA > systems configuration > cluster configuration page. Enter the details as described in the following table: 14

15 Geographic Redundancy Configuration Table 7: Cluster Configuration Parameters Parameter Name Primary database IP address Secondary database IP address Database port Parameter Type Integer IP address or hostname of the session manager 01. IP address or hostname of the session manager 02. Enter the port number or the port on which the Mongo instance for the administrator replica set is running. Geographic Redundancy Configuration You can set up MOG for geographic redundancy in the Active/Active HA model. For more information, see the "Active/Active Geo HA - Multi-Session Cache Port Support" in the CPS Geographic Redundancy Guide. In addition to the configuration described in CPS Geographic Redundancy Guide, you must configure the lookup value and callback response as described in the following sections. Configure MOG Lookup Value Note Configure CPS in the Active/Active HA model as described in the "Active/Active Geo HA - Multi-Session Cache Port Support" in the CPS Geographic Redundancy Guide. Make the following modifications for lookup value as described in this section. Step 1 Step 2 In the Cluster Manager VM, verify that the lookup type is set to realm in /etc/broadhop/qns.conf file as shown: -DGeoHASessionLookupType=realm Configure lookup in MOG HA on the Cluster Manager as described below: If you are using the client IP address as lookup, configure the following attribute in /etc/broadhop/qns.conf file: -DsessionLookupAttribute=client.ipAddress Where: client.ipaddress is the host IP address from where MOG receives the API request. When configuring the addsitelookup value as described in "Active/Active Geo HA - Multi-Session Cache Port Support" in CPS Geographic Redundancy Guide, provide the client.ipaddress as lookupvalue, as shown in the following command: addsitelookup <site name> <client ipaaddress as lookup value> 15

16 Configure MOG Lookup Value For example: Consider you have two sites, SITE1 and SITE2. You can use the client IP addresses as lookup as shown in the following example commands: addsitelookup SITE [0-9] addsitelookup SITE [0-9] The following sample lookup table for the above example is: osgi> listsitelookup Id PrimarySiteId SecondarySiteId LookupValues 1 SITE1 SITE [0-9] 2 SITE2 SITE [0-9] If you are using the enterprise as lookup, configure the following attribute in /etc/broadhop/qns.conf file: -DsessionLookupAttribute=enterprise Where: enterprise is the domain of the non-3gpp partner (tenant/enterprise of the MOG user who initiated the request). When configuring the addsitelookup value as described in "Active/Active Geo HA - Multi-Session Cache Port Support" in CPS Geographic Redundancy Guide, provide the enterprise as lookupvalue, as shown in the following command: addsitelookup <site name> <enterprise as lookup value> For example: Consider you have two sites, SITE1 and SITE2. You can use the enterprise names as lookup as shown in the following example commands: addsitelookup SITE1 enterprise1.com addsitelookup SITE2 enterprise2.com The following sample lookup table for the above example is: osgi> listsitelookup Id PrimarySiteId SecondarySiteId LookupValues 1 SITE1 SITE2 enterprise1.com 2 SITE2 SITE1 enterprise2.com If you are using a subscriber as lookup, configure the following attribute in /etc/broadhop/qns.conf file: -DsessionLookupAttribute=subscriber Where: subscriber is the username of the subscriber (MOG user) who initiated the API request. When configuring the addsitelookup value as described in "Active/Active Geo HA - Multi-Session Cache Port Support" in CPS Geographic Redundancy Guide, provide the subscriber as lookupvalue, as shown in the following command: addsitelookup <site name> <subscriber as lookup value> For example: Consider you have two sites, SITE1 and SITE2. You can use the subscriber names as lookup as shown in the following example commands: addsitelookup SITE1 subscriberprefix1.* addsitelookup SITE2 subscriberprefix2.* The following sample lookup table for the above example is: osgi> listsitelookup Id PrimarySiteId SecondarySiteId LookupValues 1 SITE1 SITE2 subscriberprefix1.* 2 SITE2 SITE1 subscriberprefix2.* 16

17 Manage Callback Responses Step 3 Step 4 Note Java regular expression is supported for lookup value. Copy the configuration to all the VMs. Repeat the configuration on remote site. Manage Callback Responses You must enable the Redis queue between Policy Directors (load balancers) to ensure that callbacks are sent back to the callback server in case of site failures. In case one site connection to callback server fails, you configure the Redis queue to ensure that the site can send callback responses to the other site that, in turn, will forward the callback responses to the callback server. To enable the Redis queue, add the following configuration in the /etc/broadhop/csb/csbconfig.properties file on the Cluster Manager VM: <SiteId>callback.redis.qserver=<lbvip02 IP address> Where: <SiteId> : Site ID based on the -DSiteId value that is configured in /etc/broadhop/qns.conf <lbvip02 IP address>: IP address of lbvip02 of the local site. You can also, optionally, use the alias name instead of IP address, if it is defined in /etc/hosts. The following two examples describe sample Redis queue configurations: If /etc/broadhop/qns.conf has -DSiteId=SITE1 and /etc/hosts has lbvip02 host entry, then the sample /etc/broadhop/csb/csbconfig.properties file includes the following configuration: SITE1callback.redis.qserver=lbvip02 <RemoteSiteId>callback.redis.qserver=<Remote site replication vlan IP address of VIP> Where: <RemoteSiteId> : Remote site ID based on -DRemoteSiteId value that is configured in /etc/broadhop/qns.conf <Remote site replication vlan IP address of VIP> : Replication VLAN IP address of VIP of the remote site (you can configure the alias name instead of IP address if it exists in /etc/hosts). If /etc/broadhop/qns.conf has -DRemoteSiteId=SITE2 and /etc/hosts has plbvip01(that is, the remote site lbvip01 address) host entry then the sample /etc/broadhop/csb/csbconfig.properties file includes the following configuration: SITE2callback.redis.qserver=plbvip01 17

18 Logback.xml Configuration to Log All CDRs Note Repeat the configuration on the remote site also. Open port 6379 (default Redis server port) on the replication network on all lb VMs on both the sites. Logback.xml Configuration to Log All CDRs You can configure logback.xml file to log all the CDRs. The following is an example configuration. You can configure logback.xml file based on your requirements. <appender name="mog_cdr" class="ch.qos.logback.core.rolling.rollingfileappender"> <file>/tmp/cdr.log</file> <rollingpolicy class="ch.qos.logback.core.rolling.fixedwindowrollingpolicy"> <filenamepattern> /tmp/cdr.%i.log.gz </filenamepattern> <minindex>1</minindex> <maxindex>5</maxindex> </rollingpolicy> <triggeringpolicy class="ch.qos.logback.core.rolling.sizebasedtriggeringpolicy"> <maxfilesize>100mb</maxfilesize> </triggeringpolicy> <encoder> <pattern>%d{hh:mm:ss.sss},%msg%n</pattern> </encoder> </appender> <logger name="mog.cdr" level="info" additivity="false"> <appender-ref ref="mog_cdr" /> <appender-ref ref="socket-blk" /> </logger> Logback.xml Configuration to Log Specific CDRs Appender When CDR Filter Configuration plugin is configured for identification of CDRs to be transferred to external server there needs to an appender configured in logback.xml file for generation of corresponding CDR files. The configuration of this appender is described in the following section: class: com.broadhop.csb.cdr.appender.cdrfileappender is the specific implementation of this appender. cdrfield: This identifies the fields from the CDRs that needs to be considered for the appender. The following fields from the CDRs can be configured. Multiple files for consideration needs to be separated by. enterprise: This is the tenant field of the CDR. subscriber: This is the subscriber field of the CDR. eventtype: This is the eventtype field of the CDR. 18

19 Logback.xml Configuration to Log Specific CDRs event: This is the event field of the CDR. filename: This is the name of the temporary file for output of the required CDRs. This field can have the cdrfield configured above. If the name has the cdrfield, then correspondingly, different files are created for different cdrfield values. For example: <cdrfield> enterprise subscriber </cdrfield> <filename> enterprise_subscriber.log</filename> In the example, multiple files are created for each unique combination of tenant and subscriber values. directory: This is the name of the folder in which the files are created. rolloverfolder: This represents the folder from which the files are transferred to the external server. rollingfilenamepattern: This is the pattern of the filenames to be generated in the rollover folder. This pattern can have the cdrfield configured as part of it. As explained in the example, the file names are generated based on the pattern and the values of the CDR fields. %i needs to be part of the pattern to index the file whenever rollover occurs. %i needs to be followed with.. %d in the pattern is used to add timestamp in the filename. This needs to be followed with the timestamp pattern. For example, %d{yyyymmddhhmm} If the pattern ends with.gz, then the generated file has the CDRs outputted in the filename field compressed. For example, <rollingfilenamepattern>enterprise_vmog_cdr%i.%d{yyyymmddhhmm}.dat.gz</rollingfilenamepattern> If %d is in the pattern then all the files generated at each polling periodicity has the same timestamp. rollingminindex: This identifies the value of the minimum index to be used in the pattern. rollingmaxindex: This identifies the value of the maximum index to be used in the pattern. When the unique files generated using the pattern reach the maximum index then the files are overwritten. triggeringmaxfilesize: This identifies the maximum size of the rollover file. Logger The appender needs to be used with the logger having name mog.cdr.reporting. Example The following is an example configuration. You can configure based on your requirements. <appender name ="CDRREPORTING" class = "com.broadhop.csb.cdr.appender.cdrfileappender"> <cdrfield>enterprise subscriber</cdrfield> <filename>enterprise.log</filename> <directory>/var/log/broadhop/cdrreporting</directory> <rolloverfolder>/var/log/broadhop/cdrreporting/rollover</rolloverfolder> <rollingfilenamepattern>enterprise_vmog_cdr%i.%d{yyyymmddhhmm}.dat.gz</rollingfilenamepattern> <rollingminindex>1</rollingminindex> <rollingmaxindex>10</rollingmaxindex> 19

20 MOG Upgrade <triggeringmaxfilesize>10gb</triggeringmaxfilesize> </appender> <logger name="mog.cdr.reporting"> <appender-ref ref="cdrreporting" /> </logger> MOG Upgrade MOG upgrade is the same as Cisco Policy Suite upgrade with Install Type as mog. For more information, see the Cisco Policy Suite Migration and Upgrade Guide. Before you upgrade MOG, ensure that the VLANs.csv and AdditionalHosts.csv files are updated with the MOG API networks. 20