1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2020 Nordix
5 .. |nbsp| unicode:: 0xA0
8 .. |nbh| unicode:: 0x2011
13 ############################
14 A1 Policy Management Service
15 ############################
18 *******************************************
19 A1 Policy Management Service - Introduction
20 *******************************************
22 The A1 Policy Management Service ("Policy Agent") is an SMO/NONRTRIC service above the NONRTRIC A1 Adaptor/Controller
25 * Unified REST & DMAAP APIs for managing A1 Policies in all Near |nbh| RT |nbsp| RICs
26 * Synchronized view of registered "services" (e.g. R-APP, GUI, etc)
27 * Synchronized view of policy instances for each "service"
28 * Synchronized view of policy instances in all Near |nbh| RT |nbsp| RICs
29 * Synchronized view of policy types in all Near |nbh| RT |nbsp| RICs
30 * Policy Query API (e.g. per Near |nbh| RT |nbsp| RIC, per "service", per policy type)
31 * An initial interface for unified Near |nbh| RT |nbsp| RIC ID to Near |nbh| RT |nbsp| RIC address mapping.
32 (Note: may also later act as adaptor to A&AI, CMDBs etc. to "find" Near |nbh| RT |nbsp| RICs - TBC)
33 * An Initial "O1 ManagedElement" mapping database & interface to find appropriate Near |nbh| RT |nbsp| RIC for RAN elements.
34 (Note: may also later act as adaptor to A&AI, RuntimeDB, other CMDBs etc. - TBC)
35 * Monitors all Near |nbh| RT |nbsp| RICs and recovers from inconsistencies (Note: e.g. Near |nbh| RT |nbsp| RIC restarts)
36 * Support for different Southbound connectors on a per Near |nbh| RT |nbsp| RIC basis. (Note: e.g. different A1
37 versions, different Near |nbh| RT |nbsp| RIC versions, different A1 adapters, different or proprietary A1
40 ***************************************
41 A1 Policy Management Service - REST NBI
42 ***************************************
44 This is the north bound API of the A1 Policy Management Service ("Policy Agent"). This API allows *services* to interact
45 with the Policy Agent using REST.
47 By registering with the Policy Agent, the Policy Agent takes responsibility for synchronizing the policies created by
48 the service in the Near |nbh| RT |nbsp| RICs. This means that if a Near |nbh| RT |nbsp| RIC restarts, the Policy Agent
49 will try to recreate all the policies residing in the Near |nbh| RT |nbsp| RIC once it is started again. If this is not
50 possible, it will remove all policies belonging to the Near |nbh| RT |nbsp| RIC.
52 The Policy Agent also keeps an updated view of the policy types available, and which Near |nbh| RT |nbsp| RICs that
53 support which types. Also, the Policy Agent can tell if a Managed Element is managed by a certain
54 Near |nbh| RT |nbsp| RIC.
56 The Policy Agent NBI has four distinct parts, described in the sections below:
60 * Near-RT RIC Repository
66 A service can register itself in the Policy Agent.
68 By providing a callback URL the service can get notifications from the Policy Agent.
70 A service can also register a "*Keep Alive Interval*", in seconds. By doing this the service promises to call the
71 Policy Agent's "*Keep Alive*" method, or else create or delete policies, more often than the "*Keep Alive Interval*"
72 measured in seconds. If the service, for some reason, is not able to do this, the Policy Agent will consider that the
73 service has died or vanished and will then delete all its policies, both in the internal repository and in the
74 Near |nbh| RT |nbsp| RICs where they were earlier created. **Note!** |nbsp| If the service does not provide a value for
75 "*Keep Alive Interval*", then the service maintains full responsibility to delete all of its policies when they are no
78 Service Management Operations
79 -----------------------------
95 **Body:** (*Required*)
96 A JSON object (ServiceRegistrationInfo): ::
99 "callbackUrl": "string", (An empty string means the service will never get any callbacks.)
100 "keepAliveIntervalSeconds": 0, (0 means the service will always be considered alive.)
101 "serviceName": "string" (Required, must be unique.)
110 The ServiceRegistrationInfo is not accepted.
115 curl -X PUT "http://localhost:8081/service" -H "Content-Type: application/json" -d '{
116 "callbackUrl": "URL",
117 "keepAliveIntervalSeconds": 0,
118 "serviceName": "existing"
128 curl -X PUT "http://localhost:8081/service" -H "Content-Type: application/json" -d "{}"
133 Missing mandatory parameter 'serviceName'
141 Query service information.
144 /services?name=<service-name>
148 The name of the service.
152 Array of JSON objects (ServiceStatus). ::
155 "callbackUrl": "string", (Callback URL)
156 "keepAliveIntervalSeconds": 0, (Policy keep alive interval)
157 "serviceName": "string", (Identity of the service)
158 "timeSinceLastActivitySeconds": 0 (Time since last invocation by the service)
161 Service is not found.
166 curl -X GET "http://localhost:8081/services?name=existing"
173 "serviceName":"existing",
174 "keepAliveIntervalSeconds":0,
175 "timeSinceLastActivitySeconds":7224,
182 curl -X GET "http://localhost:8081/services?name=nonexistent"
195 /services?name=<service-name>
199 The name of the service.
210 curl -X DELETE "http://localhost:8081/services?name=existing"
219 curl -X DELETE "http://localhost:8081/services?name=nonexistent"
224 Could not find service: nonexistent
232 Heart beat from a service.
235 /services/keepalive?name=<service-name>
239 The name of the service.
245 Service is not found.
250 curl -X PUT "http://localhost:8081/services/keepalive?name=existing"
259 curl -X PUT "http://localhost:8081/services/keepalive?name=nonexistent"
264 Could not find service: nonexistent
266 .. _policy-management:
271 Policies are based on types. The set of available policy types is determined by the set of policy types supported by
272 Near |nbh| RT |nbsp| RICs. At startup, the Policy Agent queries all Near |nbh| RT |nbsp| RICs for their supported types
273 and stores them in its internal repository. It then checks this at regular intervals to keep the repository of types up
274 to date. Policy types cannot be created, updated or deleted using this interface since this must be done via the
275 Near |nbh| RT |nbsp| RICs.
277 Policies can be queried, created, updated, and deleted. A policy is always created in a specific
278 Near |nbh| RT |nbsp| RIC.
280 When a policy is created, the Policy Agent stores information about it in its internal repository. At regular intervals,
281 it then checks with all Near |nbh| RT |nbsp| RICs that this repository is synchronized. If, for some reason, there is an
282 inconsistency, the Policy Agent will start a synchronization job and try to reflect the status of the
283 Near |nbh| RT |nbsp| RIC. If this fails, the Policy Agent will delete all policies for the specific
284 Near |nbh| RT |nbsp| RIC in the internal repository and set its state to *UNKNOWN*. This means that no interaction with
285 the Near |nbh| RT |nbsp| RIC is possible until the Policy Agent has been able to contact it again and re-synchronize its
286 state in the repository.
291 A policy type defines a name and a JSON schema that constrains the content of a policy of that type.
299 Query policy type names.
302 /policy_types?ric=<name-of-ric>
306 The name of the Near |nbh| RT |nbsp| RIC to get types for.
311 Array of policy type names.
313 Near |nbh| RT |nbsp| RIC is not found.
318 curl -X GET "http://localhost:8081/policy_types"
324 "STD_PolicyModelUnconstrained_0.2.0",
325 "Example_QoETarget_1.0.0",
326 "ERIC_QoSNudging_0.2.0"
331 curl -X GET "http://localhost:8081/policy_types?ric=nonexistent"
336 org.oransc.policyagent.exceptions.ServiceException: Could not find ric: nonexistent
344 Returns one policy type schema definition.
347 /policy_schema?id=<name-of-type>
351 The ID of the policy type to get the definition for.
355 Policy schema as JSON schema.
357 Policy type is not found.
362 curl -X GET "http://localhost:8081/policy_schema?id=STD_PolicyModelUnconstrained_0.2.0"
368 "$schema": "http://json-schema.org/draft-07/schema#",
369 "title": "STD_PolicyModelUnconstrained_0.2.0",
370 "description": "Standard model of a policy with unconstrained scope id combinations",
376 "ueId": {"type": "string"},
377 "groupId": {"type": "string"}
380 "additionalProperties": false
385 "gfbr": {"type": "number"},
386 "mfbr": {"type": "number"}
388 "additionalProperties": false
403 "additionalProperties": false,
404 "required": ["cellIdList"]
409 "additionalProperties": false,
410 "required": ["scope"]
415 curl -X GET "http://localhost:8081/policy_schema?id=nonexistent"
420 org.oransc.policyagent.exceptions.ServiceException: Could not find type: nonexistent
428 Returns policy type schema definitions.
431 /policy_schemas?ric=<name-of-ric>
435 The name of the Near |nbh| RT |nbsp| RIC to get the definitions for.
439 An array of policy schemas as JSON schemas.
441 Near |nbh| RT |nbsp| RIC is not found.
446 curl -X GET "http://localhost:8081/policy_schemas"
452 "$schema": "http://json-schema.org/draft-07/schema#",
453 "title": "STD_PolicyModelUnconstrained_0.2.0",
454 "description": "Standard model of a policy with unconstrained scope id combinations",
462 "additionalProperties": false,
463 "required": ["scope"]
469 "$schema": "http://json-schema.org/draft-07/schema#",
470 "title": "Example_QoETarget_1.0.0",
471 "description": "Example QoE Target policy type",
479 "additionalProperties": false,
480 "required": ["scope"]
485 curl -X GET "http://localhost:8081/policy_schemas?ric=nonexistent"
490 org.oransc.policyagent.exceptions.ServiceException: Could not find ric: nonexistent
495 A policy is defined by its type schema.
497 Once a service has created a policy, it is the service's responsibility to maintain its life cycle. Since policies are
498 transient, they will not survive a restart of a Near |nbh| RT |nbsp| RIC. But this is handled by the Policy Agent. When
499 a Near |nbh| RT |nbsp| RIC has been restarted, the Policy Agent will try to recreate the policies in the
500 Near |nbh| RT |nbsp| RIC that are stored in its local repository. This means that the service always must delete any
501 policy it has created. There are only two exceptions, see below:
503 - The service has registered a "*Keep Alive Interval*", then its policies will be deleted if it fails to notify the
504 Policy Agent in due time.
505 - The Policy Agent completely fails to synchronize with a Near |nbh| RT |nbsp| RIC.
516 /policies?ric=<name-of-ric>&service=<name-of-service>&type=<name-of-type>
520 The name of the Near |nbh| RT |nbsp| RIC to get policies for.
521 service: (*Optional*)
522 The name of the service to get policies for.
524 The name of the policy type to get policies for.
528 Array of JSON objects (PolicyInfo). ::
531 "id": "string", (Identity of the policy)
532 "json": "object", (The configuration of the policy)
533 "lastModified": "string", (Timestamp, last modification time)
534 "ric": "string", (Identity of the target Near |nbh| RT |nbsp| RIC)
535 "service": "string", (The name of the service owning the policy)
536 "type": "string" (Name of the policy type)
539 Near |nbh| RT |nbsp| RIC or policy type not found.
544 curl -X GET "http://localhost:8081/policies?ric=existing"
563 "lastModified": "Wed, 01 Apr 2020 07:45:45 GMT",
565 "service": "Service 1",
566 "type": "STD_PolicyModelUnconstrained_0.2.0"
575 "lastModified": "Wed, 01 Apr 2020 07:45:45 GMT",
577 "service": "Service 2",
578 "type": "Example_QoETarget_1.0.0"
584 curl -X GET "http://localhost:8081/policies?type=nonexistent"
589 Policy type not found
597 Returns a policy configuration.
600 /policy?id=<policy-id>
604 The ID of the policy instance.
608 JSON object containing policy information. ::
611 "id": "string", (ID of policy)
612 "json": "object", (JSON with policy data speified by the type)
613 "ownerServiceName": "string", (Name of the service that created the policy)
614 "ric": "string", (Name of the Near |nbh| RT |nbsp| RIC where the policy resides)
615 "type": "string", (Name of the policy type of the policy)
616 "lastModified" (Timestamp, last modification time)
624 curl -X GET "http://localhost:8081/policy?id=Policy 1"
639 "priorityLevel": 268.5,
644 "initialBuffering": 27.75,
650 "ownerServiceName": "Service 1",
652 "type": "STD_PolicyModelUnconstrained_0.2.0",
653 "lastModified": "Wed, 01 Apr 2020 07:45:45 GMT"
658 curl -X GET "http://localhost:8081/policy?id=nonexistent"
668 Create/Update a policy. **Note!** Calls to this method will also trigger "*Keep Alive*" for a service which has a
669 "*Keep Alive Interval*" registered.
672 /policy?id=<policy-id>&ric=<name-of-ric>&service=<name-of-service>&type=<name-of-policy-type>
676 The ID of the policy instance.
678 The name of the Near |nbh| RT |nbsp| RIC where the policy will be created.
679 service: (*Required*)
680 The name of the service creating the policy.
682 The name of the policy type.
684 **Body:** (*Required*)
685 A JSON object containing the data specified by the type.
693 Near |nbh| RT |nbsp| RIC or policy type is not found.
695 Near |nbh| RT |nbsp| RIC is not operational.
700 curl -X PUT "http://localhost:8081/policy?id=Policy%201&ric=ric1&service=Service%201&type=STD_PolicyModelUnconstrained_0.2.0"
701 -H "Content-Type: application/json"
710 "priorityLevel": 268.5,
715 "initialBuffering": 27.75,
728 Deletes a policy. **Note!** Calls to this method will also trigger "*Keep Alive*" for a service which has a
729 "*Keep Alive Interval*" registered.
732 /policy?id=<policy-id>
736 The ID of the policy instance.
744 Near |nbh| RT |nbsp| RIC is not operational.
749 curl -X DELETE "http://localhost:8081/policy?id=Policy 1"
760 Query policy type IDs.
763 /policy_ids?ric=<name-of-ric>&service=<name-of-service>&type=<name-of-policy-type>
767 The name of the Near |nbh| RT |nbsp| RIC to get policies for.
768 service: (*Optional*)
769 The name of the service to get policies for.
771 The name of the policy type to get policies for.
775 Array of policy type names.
777 RIC or policy type not found.
782 curl -X GET "http://localhost:8081/policy_ids"
795 curl -X GET "http://localhost:8081/policy_ids?ric=nonexistent"
808 Returns the status of a policy.
811 /policy_status?id=<policy-id>
815 The ID of the policy.
819 JSON object with policy status.
823 Near-RT RIC Repository
824 ======================
826 The Policy Agent keeps an updated view of the Near |nbh| RT |nbsp| RICs that are available in the system. A service can
827 find out which Near |nbh| RT |nbsp| RIC that manages a specific element in the network or which
828 Near |nbh| RT |nbsp| RICs that support a specific policy type.
839 Returns the name of a Near |nbh| RT |nbsp| RIC managing a specific Mananged Element.
842 /ric?managedElementId=<id-of-managed-element>
845 managedElementId: (*Required*)
846 The ID of the Managed Element.
850 Name of the Near |nbh| RT |nbsp| RIC managing the Managed Element.
852 No Near |nbh| RT |nbsp| RIC manages the given Managed Element.
857 curl -X GET "http://localhost:8081/ric?managedElementId=Node 1"
866 curl -X GET "http://localhost:8081/ric?managedElementId=notmanaged"
877 Query Near |nbh| RT |nbsp| RIC information.
880 /rics?policyType=<name-of-policy-type>
883 policyType: (*Optional*)
884 The name of the policy type.
888 Array of JSON objects containing Near |nbh| RT |nbsp| RIC information. ::
892 "managedElementIds": [
903 Policy type is not found.
908 curl -X GET "http://localhost:8081/rics?policyType=STD_PolicyModelUnconstrained_0.2.0"
915 "managedElementIds": [
920 "STD_PolicyModelUnconstrained_0.2.0",
921 "Example_QoETarget_1.0.0",
922 "ERIC_QoSNudging_0.2.0"
931 "managedElementIds": [
935 "STD_PolicyModelUnconstrained_0.2.0"
938 "state": "UNAVAILABLE"
944 curl -X GET "http://localhost:8081/rics?policyType=nonexistent"
949 Policy type not found
954 The status of the Policy Agent.
965 Returns the status of the Policy Agent.
980 curl -X GET "http://localhost:8081/status"
989 The Policy Agent also provides the possibility to use DMaap to handle policies according to the A1 specification. The
990 Policy Agent polls the DMaaP Message Router regularly and processes any messages targeted to it. The response is then
991 published back to the DMaaP Message Router with the result of the call.
996 The message to send is a JSON like the one below. The "*url*" is one of the URLs described under
997 :ref:`policy-management`. The "*target*" must always be "*policy-agent*" for the message to be processed by the Policy
998 Agent. The "*operation*" can be one of the following: "*GET | PUT | POST | DELETE*". ::
1002 "correlationId": "string",
1004 "timestamp": "timestamp",
1005 "apiVersion": "string",
1006 "originatorId": "string",
1007 "requestId": "string",
1008 "operation": "string",
1015 To get all policy types for a specific Near |nbh| RT |nbsp| RIC the following message should be sent to DMaaP Message
1020 "correlationId":"c09ac7d1-de62-0016-2000-e63701125557-201",
1021 "target":"policy-agent",
1022 "timestamp":"2019-05-14T11:44:51.36Z",
1024 "originatorId":"849e6c6b420",
1025 "requestId":"23343221",
1027 "url":"/policy_schemas?ric=ric_ric-simulator_1"
1033 The message the Policy Agent sends back to the DMaaP Message Router is a JSON like the one below. The "*requestId*"
1034 "*correlationId*", and "*originatorId*" are the same as in the message sent to DMaaP MR. ::
1037 "requestId": "string",
1038 "correlationId": "string",
1039 "originatorId": "string",
1041 "message": "string",
1043 "timestamp": "string",
1050 The response containing all policy types for a specific Near |nbh| RT |nbsp| RIC sent to the DMaaP Message Router from
1051 the Policy Agent: ::
1054 \"requestId\":\"23343221\",
1055 \"correlationId\":\"c09ac7d1-de62-0016-2000-e63701125557-201\",
1056 \"originatorId\":\"849e6c6b420\",
1057 \"type\":\"response\",
1060 \\\"$schema\\\":\\\"http://json-schema.org/draft-07/schema#\\\",
1061 \\\"description\\\":\\\"QoS policy type\\\",
1062 \\\"title\\\":\\\"STD_QoSNudging_0.2.0\\\",
1063 \\\"type\\\":\\\"object\\\",
1064 \\\"properties\\\":{\\\"scope\\\":{\\\"additionalProperties\\\":true,
1065 \\\"type\\\":\\\"object\\\",
1066 \\\"properties\\\":{\\\"qosId\\\":{\\\"type\\\":\\\"string\\\"},
1067 \\\"ueId\\\":{\\\"type\\\":\\\"string\\\"}},
1068 \\\"required\\\":[\\\"ueId\\\",
1070 \\\"statement\\\":{\\\"additionalProperties\\\":false,
1071 \\\"type\\\":\\\"object\\\",
1072 \\\"properties\\\":{\\\"priorityLevel\\\":{\\\"type\\\":\\\"number\\\"}},
1073 \\\"required\\\":[\\\"priorityLevel\\\"]}}
1076 \"timestamp\":\"2019-05-14T11:44:51.36Z\",
1077 \"status\":\"200 OK\"