How it Works

This section describes how this feature works.

To configure multiple entitlement tags, use the GET service added in NF’s (cnSGW-C/SMF) rest-ep pod on the internal port 8000. The REST service name is 'entitlements'.

Note

As localhost:8000 is already occupied by entitlements service, it’s recommended not to create a new service on port 8000 and localhost inside REST-EP.

Ops Center’s values.yaml registers this service as a part of product configuration.

The following is a sample configuration:

ops-center:
  product:
    id: <product_id>, e.g. SMF
    softwareID: <s/w id>, e.g. regid.2020-04.com.cisco.SMF,1.0_37ffdc21-3e95-4192-bcda-d3225b6590ce
    entitlementsURL: http://entitlements:8000/entitlements.json 

After values.yaml is populated with entitlementsURL, Ops Center installs all the available licenses received from entitlements service.

The entitlements service looks up for entitlements in rest-ep-entitlements-cm configmap and returns all the available entitlements back as a JSON response.

Entitlements in rest-ep-entitlements-cm are registered based on the following flags:

  • restep.smfProfile

  • restep.sgwProfile

Note

The flags are configured in cn-ops-center > confd_init > render > rest-ep > pod.yaml.

If entitlements service has no entitlement information, Ops Center doesn't send any request to the smart license server or doesn't install any license.

SNMP Traps

If the product is not in compliance with the contract (the product has used too many licenses/entitlements or not authorized to use a particular entitlement tag), a notification is sent to all the applications using the entitlement tag. An SNMP trap is sent indicating the entitlements that are not in compliance. This SNMP trap is seen in smart agent syslogs, with the trap name as SMART_LIC-3-OUT_OF_COMPLIANCE.