Page History

...

Issue Notes Decision

1

Uplift Ericsson source code (need permission)

CPS not allowed to lift // proprietary codes, we need to use pseudo code Gergely/team to support CPS with these codes

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

2

Implement in REST or Service Layer ?

This is currently implemented as an in the Service layer in //

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

3

Publish public

NCMP shall own and document.

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

4

Could we make this more generic to suit non-conflict-management use i.e. tbac...

Agreed to make it more generic to suit ALL the use cases

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

5

Private properties are used to get FDN at the moment.

Will // provide us with registered Alternatid? Opensource does not support private property Peter Turcsanyi to revert TBC 20 Jun 2024 .

// Confirmed they will implement all

https://eteamproject.internal.ericsson.com/browse/IDUN-105467

20 Jun 2024

6

CPS-1992 - NCMP to Support New 3GPP sync single FDN request to support Conflict mgt

CPS-1992 - When delivered, this should also support conflict management

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

7

Legacy and ongoing bulk/batch interface (dataJobs CPS-1964) are not in scope

Bulk/batch operation

Datajobs bulk write op. ..... out-of-scope
single write operation -In-scope

20 Jun 2024Kolawole Adebisi-Adeolokun Gergely Molnar

8

Name for more generic interface

Suggestion: External Validation AP Kolawole Adebisi-Adeolokun to inform other stakeholders

20 Jun 2024 New Interface name shall be PolicyExecution as agreed with stakeholders Kolawole Adebisi-Adeolokun kieran mccarthy Gergely Molnar

9

External Validation Request format

POST operation, all parameters in body, URL ?

AP Toine Siebelink to create a page & collaborate with Gergely/Brian ( on initial proposal)

20 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

10

Enable/service name discovery

config parameter with service name/address.
Blank to disable ?

AP Toine Siebelink to create a page & collaborate with Gergely/Brian ( on initial proposal)

20 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

11

case sensitivity of parameters (payloadType, decision etc.)

following existing conventions in CPS/NCMP all parameter values are case sensitive and use lower snake e.g. accept 'allow', 'Allow', 'ALLOW' or only accept only on well defined case sensitive variation and anything else is a error scenario?!

To be discussed during proposal;

AP Toine Siebelink to create a page & collaborate with Gergely/Brian ( on initial proposal)

20 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

cm_create, deny

20 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

12

Delivery

12

Delivery Artefact

The new OpenAPI Interface definition wil be published on CPS Public Documentation Page. and through ONAP Gerrit.
Will it need to be delivered somewhere else (as snapshot for every build and/or release process)?
(I dont think this was done for DMI interface either)

01 Jul 2024 Brian Folan, Toine Siebelink agreed to use same as DMI ie. just 'deliver' to Doc and Repo

13

Specify cmChangeRequest in more detail

Code Block

language	xml
title	Detailed Definition Suggestion
collapse	true

{
  "moType": [
    {
      "id": "<mo Type Id>",
      "attributes": {
        "<key>": "<value>",
        "<key>": ["<value>", "<value>"]
        ...
      }
    }
  ]
}

Toine Siebelink I am concerned this wil reduce the flexibility of this interface. Also, NCMP itself is NOT interested in eth actual change details so why enforce them in this interface...

Csaba Kocsis 'id' and 'attributes' are a 3GPP conventions only

01 Jul 2024 Zoltán Szabó Toine Siebelink Validation need on IMplImpl. side but for flexibility this is not required in CPS/NCMP so we agreed to pass it as 'an object'

14

How to feed back result of CM change to Policy Execution/Executor?

Consider the following scenario (from Brian Folan).

There is an active policy for time based lock against an attribute on a specific cmHandle.

A change is made to the attribute, triggering the time-based lock for x minutes, but the CM change fails after letting it through to the DMI due to any reason and it's not actually rolled out to the network. The policy engine would apply the lock and no subsequent changes are allowed for the duration of the lock, however no changes were made to the network.

Should we feed back the result of a CM change to the Policy Engine?

01 Jul 2024 Brian Folan Toine Siebelink agreed this is out of scope for this epic but can be considered later. Interface propsosal is flexible enough to extend for something like this in the future

15

Choose URL format

Gergely Molnar prefers alternative a (with an 'action'): <server-address>/policy-executor/api/v1/<action>/All data (payload and decision-type, payload etc) goes in the body as detailed below

01 Jul 2024 Zoltán Szabó Toine Siebelink agreed on Alt.a. a simple URL, all data in body

16

Optional CmHandleId cmHandleId and ResourceIdentifierresourceIdentifier

Brian Folan: Cm Handl e Handle ID wil mean nothing for Ericsson Impl but can be logged. Resource Identifier can be 'convention' but they don't depend on it if the target fdn contains the 'complete' fdn

01 Jul 2024 Brian Folan, Zoltán Lajos Kis Toine Siebelink CM Handle Id and Resource Identifier are optional. CPS/NCMP will add them when provided in the incoming interface

fdn contains the 'complete' fdn

01 Jul 2024 Brian Folan, Zoltán Lajos Kis Toine Siebelink CM Handle Id and Resource Identifier are optional. CPS/NCMP will add them when provided in the incoming interface

17

request accepted content type

not defined (and wrong value copied in original proposal). Now suggested: application/json
See https://gerrit.onap.org/r/c/cps/+/138401/2/docs/api/swagger/policy-executor/openapi.yaml Line #41

09 Jul 2024 Gergely Molnar Agreed (per email)

18

definition 'enum' values

defined as strings in OpenAPI to allow for flexibility and allow impl updates without having to update (and release) the OpenAPI

09 Jul 2024 Gergely Molnar Agreed (per email)

19

enum value description examples

although not specified in the OPenAPI definition (as enums) The convention in CPS/NCMP so far is that all 'enum' values are in lower (snake) case (and treated case-sensitive)
Complete list for current interface definition: 'cm_write', 'permit', 'deny', 'execute'
See https://gerrit.onap.org/r/c/cps/+/138401/2/docs/api/swagger/policy-executor/openapi.yaml

09 Jul 2024 Gergely Molnar Agreed (per email)

20

authorization header compulsory

As per the proposal the OpenAPI now defined the 'Authorization' header as 'required'. This mean omission of this header will lead to a 400 Bad Request (and NOT 401 Unauthorized) as per Swagger/Spring generated Interface.

See https://gerrit.onap.org/r/c/cps/+/138401/2/docs/api/swagger/policy-executor/openapi.yaml Lines #214-219

And Testware: https://gerrit.onap.org/r/c/cps/+/138401/2/policy-executor-stub/src/test/groovy/org/onap/cps/policyexecutor/stub/controller/PolicyExecutorStubControllerSpec.groovy

09 Jul 2024 Gergely Molnar , Toine Siebelink Agreed (per email) making the 'Authorization' header optional for more flexibility.

21

cm_write shoudl be split?

possible options "cm_create" "cm_update" "cm_patch" "cm_delete" kieran mccarthy to decide

Requirements

Functional: new generic 'PolicyExecution' REST interface

...

Interface

Requirement

Additional Information

Signoff

1

PolicyExecution

Documentation

NCMP own and clearly document interface using OpenAPI and RTD

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

2

PolicyExecution

Input Parameters:

Bearer Token (header information?)
Payloadtype
Decisiontype
Payload
- resourceIdentifier
- targetFdn
- changeRequest

Payloadtype can only be 'CM_Write' for now

Payloadtype can only be 'Allow' for now

Exact Payload to be defined during study but should be well defined and cannot depend on Java interface (even if it is the same now)

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

3

PolicyExecution

Output Parameters;

Decision (enum: "allow", "deny")
Message - Should return a 409. Standard HTTP response
Decision id (String)

This is a New Generic interface that can support 'conflict handling'.

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

Excerpt

Functional: CPS Impacts Policy Executor

Interface

Requirement

Additional Information

Signoff

1

CPS-E-05

Write operations are intercepted and validated using the new external service.
No effect on existing behavior if the result is 'Allow'

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

2

CPS-E-05

When the External validation is negative NCMP REST Response should be '409 Conflict'.  The HTTP status message should contain the message and decision id from the external validation service.

NCMP interface validation shall be done before the external validation (Conflict management)

13 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

3

CPS-E-05

NCMP to provide metrics on external validation

AP on CPS to provide the metrics (Kolawole Adebisi-Adeolokun )

20 Jun 2024 Kolawole Adebisi-Adeolokun Gergely Molnar

Error Handling

Scenario

Expected Behavior

Notes

Signoff

1

External validation service does not respond (in time) Or does not respond with 2xx (Http status code)

configurable default answer

This needs further investigation AP Gergely Molnar

Possible proposal:

Implement watchdog similar to DMI health check

2

Unrecognized response from External Validation

(Low prio)

No default behavior covered yet in //,

If not reachable - default accept/reject with specific message

20 Jun 2024Kolawole Adebisi-Adeolokun Gergely Molnar

3

CM Handle ID without Alternate Id (fdn)

Characteristics

	Parameter	Expectation	Notes	Signoff
1	Performance impact?		External Validation Response time depends on various response time at the moment

Out of Scope

Batch (bulk) interface methods and Execute a data operation for group of cm handle ids
Data jobs (write) operations

Description Jira
Agree, Define (and Publish) Open Source Interface for Policy Execution
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-2291
Feature toggle and addressing configuration parameters
(use logging instead of actual call to new
...
interface)
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-2311
Dummy Stub implementation (
...
to allow for integration testing)
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-2301
Use new interface in NCMP
(use Stub to allow/disallow predefined names/patterns
...
)
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-2247
Handle non-responding policy executor (using watchdog?) TBC
Metrics
Update official documentation (when feature completed from OpenSource point-of-view)

Solution Proposal

Policy Executor REST Interface

...

~~e.g. myhost:1234//policy-executor/api/v1/payload/CM_Write/decision/Allow~~

Input Parameters

...

~~Allow~~

Input Parameters

	Name	Parent	Type	Example Value	Optional/Compulsory	Notes
1	`action`	url path	String	`execute`	Required	The policy action. Currently supported value: `execute`
2	`Authorization`: Bearer	request (authorization header)	String	`Bearer edaa8e7ce30f8904`	Required	required for tracking/ (future) authentication and to identify the source source (rApp) of the request
23	payloadType`requestType`	body	String	CM`cm_`Write`create`	Required	Could be in URL, See alt. b above 'CM_Write' currently, the only support value	currently supported values: `cm_create, cm_delete, cm_update, cm_patch`
43	`decisionType`	body	String	Allow`permit`	RequiredCould be in URL, See alt. b above'Allow'	currently , the only supported value: `permit`
45	`payload`	body	Object Array		Required	No needed if payload and decision are in URL
56	`cmHandleId`	payload	String	`F811AF64F5146DFC545EC60B73DE948E`	Optional	Can be sent while cmHandle is used instead of alternateId NCMP will populate when available
67	`resourceIdentifer`	payload	String	ericsson-enm-gnbdu:`ManagedElement=Kista/GNBDUFunction=1/UECC=1`	Optional	Remainder of FDN NCMP will populate when available
78	targetFdn`targetIdentifier`	payload	String		String	`/Subnetwork=22/MeContext=Kista/ManagedElement=Kista/GNBDUFunction=1/UECC=1`MEContext=RadioNode-0001,ManagedElement=RadioNode-0001,GNBDUFunction=1,....,EUTranCell=123	Required	Complete FDN representing the cm handle and the resource identifier ie point to the target of the change to 'CM-Handle' ?!
89	`cmChangeRequest`	payload	Object	`{"Cell":[{"id":"Cell-id","attributes":{"administrativeState":"UNLOCKED"}}]}`	Required	CM Change Request

...

Code Block

language	xml
title	Sample Body
linenumbers	true
collapse	true

{
  "payloadType": "CM_Write",
  "decisionType": "Allow",
  "payload": [
    {
      "cmHandleId": "F811AF64F5146DFC545EC60B73DE948E",
      "resourceIdentifier": "some-resource-idGNBDUFunction=1/UECC=1",
      "targetFdn": "MEContext=RadioNode-K6_0001,ManagedElement=RadioNode-K6_0001/Subnetwork=22/MeContext=Kista/ManagedElement=Kista/GNBDUFunction=1/UECC=1",
      "cmChangeRequest": {
        "Cell": [
          {
            "id": "Cell-id",
            "attributes": {
              "administrativeState": "UNLOCKED"
            }
          }
        ]
      }
    }
  ]
}

...

	Name	Parent	Type	Example	Optional/Compulsory	Notes
1	`decisionId`	body	String	`550e8400-e29b-41d4-a716-446655440000`	Required	UUID
2	`decision`	body	String	Deny`deny`	Required	currently only 'Allow' and 'Deny' are supported (case sensitive ?!)supported values: `permit, deny`
3	`message`	body	String	`to many updates`	Optional

How to use the Interface in NCMP

...

Space shortcuts

Page tree

Versions Compared

Old Version 44

New Version Current

Key

Requirements

Functional: new generic 'PolicyExecution' REST interface

Functional: CPS Impacts Policy Executor

Error Handling

Characteristics

Out of Scope

Suggested User Stories

Solution Proposal

Policy Executor REST Interface

Input Parameters

Input Parameters

How to use the Interface in NCMP