| Table of Contents |
|---|
References
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
https://ldap.com/ldap-dns-and-rdns/
Assumptions
| Issue | Notes | Sign-off | |
|---|---|---|---|
| 1 | alternateId not used when processing 'deletedCmHandles' or 'upgradedCmHandles' | Any alternateId stored in the cache earlier will be used | |
| 2 | In case of updating, when users try to change an alternateId we should ignore it. | Ignore it a silent way (e.g: logging message), no exception should be thrown! | Kolawole Adebisi-AdeolokunYes, ignore as long as it is documented this is not supported (yaml) |
| 3 | a unique CM Handle ID (populated with hashes) will remain in place | to support duplicated alternated IDs, see also decision #5 |
Issues & Decisions
| Issue | Notes | Decision | |
|---|---|---|---|
| 1 | Is FDN optional? | Is it possible to register a cmHandle without an FDN? | Toine Siebelink Yes it is optional as not everyone will use it |
| 2 | In Hazelcast what is the key? | Is it the FDN or the cmHandleId? | Toine Siebelink create 2 maps:
|
| 3 | Check alternateId in 'updatedCmHandles' | Assuming updatedCHandle should NOT be used to correct/change the AlternateId for a CmHandleId | Alternate IDs are immutable once they are set. |
| 4 | Should we persist the alternateId? | Should we modify the registry model? | Toine Siebelink Yes, the Inventory Model should update with the AlternatId as detailed below |
| 5 | Alternative ID is NOT unique! | multiple NMs might be using same subnetwork names i the FDNs and as NCMP manage multiples NM's NCMP can encounter duplicates. | kieran mccarthy FDNs will be Unique |
| 6 | Add a cm Handle with a alternate ID that is already in use (for another CM Handle) | Error report solution will be easier if we do NOT add it and treat it like a 'normal' duplicate cm handle | kieran mccarthy do not add! Rephrase error to |
Alternate identifiers during registration
The first use case which should be handled is the storing of the new identifier ( called FDN or Fully Distinguished Name).
...
To achieve this NCMP's CmHandle registration endpoint must be changed to accept a new String parameter which proposed name is alternateId.
Extending RestInputCmHandle object
During registration an object called RestInputCmHandle contains all the information to register new entities in the database.
The object should be extended at the top level with the new optional property:
RestInputCmHandle | |
|---|---|
| Field name | Type |
| cmHandle | String |
cmHandleProperties | Object |
| publicCmHandleProperties | Object |
| moduleSetTag | String |
| trustLevel | String |
| alternateId | String |
Save the cmHandleId and the alternateId to caches
During registration the new identifier must be saved to a cache. Because it could be reused later for queries.
The new cache must implement two maps (Map<String, String>).
The first map should be structured in a way where the original CM Handle ID is the key and the alternate ID is the value.
The second map should be the other way around.
Like this we will be able to map entities back and forth during queries quickly based on what value we have in the queries.
Inventory Use cases
create (initial inventory)
This use case is described above.
update
Assuming that alternateIds will not change during update.
delete
In case of a DELETE operation only the cmHandleId provided in an array of strings.
However during removal we should check if any of the two caches containing the cmHandleId and that is the case we should remove those entries.
upgrade
Assuming that it's ignored.
upgrade
Assuming that it's ignored.
Proposed DMI Registry model
The DMI registry model should be updated as well to store the new value in the persistence layer. The proposed model was added below:
Updates
- Revision lines 11-13
- AlternateId lines 91-93
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
module dmi-registry {
yang-version 1.1;
namespace "org:onap:cps:ncmp";
prefix dmi-reg;
contact "toine.siebelink@est.tech";
revision "2023-11-27" {
description
"Added alternateId";
}
revision "2023-08-23" {
description
"Added ModuleSetTag";
}
revision "2022-05-10" {
description
"Added DataSyncEnabled, SyncState with State, LastSyncTime, DataStoreSyncState with Operational and Running syncstate";
}
revision "2022-02-10" {
description
"Added State, LockReason, LockReasonDetails to aid with cmHandle sync and timestamp to aid with retry/timeout scenarios";
}
revision "2021-12-13" {
description
"Added new list of public additional properties for a Cm-Handle which are exposed to clients of the NCMP interface";
}
revision "2021-10-20" {
description
"Added dmi-data-service-name & dmi-model-service-name to allow separate DMI instances for each responsibility";
}
revision "2021-05-20" {
description
"Initial Version";
}
grouping LockReason {
leaf reason {
type string;
}
leaf details {
type string;
}
}
grouping SyncState {
leaf sync-state {
type string;
}
leaf last-sync-time {
type string;
}
}
grouping Datastores {
container operational {
uses SyncState;
}
container running {
uses SyncState;
}
}
container dmi-registry {
list cm-handles {
key "id";
leaf id {
type string;
}
leaf dmi-service-name {
type string;
}
leaf dmi-data-service-name {
type string;
}
leaf dmi-model-service-name {
type string;
}
leaf module-set-tag {
type string;
}
leaf alternate-id {
type string;
}
list additional-properties {
key "name";
leaf name {
type string;
}
leaf value {
type string;
}
}
list public-properties {
key "name";
leaf name {
type string;
}
leaf value {
type string;
}
}
container state {
leaf cm-handle-state {
type string;
}
container lock-reason {
uses LockReason;
}
leaf last-update-time {
type string;
}
leaf data-sync-enabled {
type boolean;
default "false";
}
container datastores {
uses Datastores;
}
}
}
}
}
|
Error Reporting
Error Scenarios
| Use-case | CM Handle Id | Alternate Id | Report | Add Cm Handle | Store Alternate ID | Notes | |
|---|---|---|---|---|---|---|---|
| 1 | New registration | Duplicated | N/A | 109, cm-handle already exists | No | No | |
| 2 | New Registration | Unique | used for other cm handle | 111, alternate id already associated | No | No | New NCMP error |
| 3 | Update Registration | New | N/A | 100, cm handle id(s) not found | N/A | No | |
| 4 | Update Registration | Exist | already set | 111, alternate id already associated | N/A | No | New NCMP error |
| 5 | Update Registration | Exist | Use by other cm handle | 111, alternate id already associated | N/A | No | New NCMP error |
Current Implementation of Duplicate Cm Handle Registration (during batch)
TODO: Expand on how below works
- Origin of exception (org.onap.cps.spi.impl.CpsDataPersistenceServiceImpl#retrySavingEachChildIndividually)
- How is retry performed from on remain cm handles in same batch
- how is the error information amalgamated (for multiple failures in oen batch in and in multiple batches)
Proposed JIRAs
Component | Description | JIRA | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | NCMP | Modify cmHandle registration for alternateId |
| ||||||||||||
| 2 | NCMP | Allow updating of cmHandles with an alternateId |
| ||||||||||||
| 3 | NCMP | Update Model to allow Persisting of alternateId |
| ||||||||||||
| 4 | NCMP | Introduce Hazelcast for alternateId-cmHandle relation |
| ||||||||||||
| 5 | NCMP | None uniqueness of alternateid |
|
Notes
A proposal was made to make alternateIds non-unique, since different EMS might register NEs with the same alternateId. But this would affect queries and back-and-forth mapping between cmHandleId-alternateId.