CPS-1963 Register alternate identifiers (alternative for CM Handle ID)

References

CPS-1963 - Getting issue details... STATUS

Assumptions

	Issue	Notes	Sign-off
1	alternateId not used when processing 'deletedCmHandles' or 'upgradedCmHandles'	Any alternateId stored in the cache earlier will be used	kieran mccarthy 29 Nov 2023
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!	05 Dec 2023 Kolawole Adebisi-AdeolokunYes, ignore as long as it is documented this is not supported (yaml)

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: alternate id → cm-handle-id cm-handle-id → alternate id
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. However if a previously created CM Handle's alternate ID is not defined then an update should be possible. The only way to change this value is to delete the current CM Handle and then re-register it.
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

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).

A fully distinguished name uniquely identifies an entry and describes its position.

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.

Proposed DMI Registry model

The DMI registry modeul 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

DMI Registry Model 2023-11-27

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;
        }
      }
    }
  }
}

Proposed JIRAs

	Component	Description	JIRA
1	NCMP	Modify cmHandle registration for alternateId	CPS-1985 - Getting issue details... STATUS - Modify cmHandle registration for alternateId
2	NCMP	Allow updating of cmHandles with an alternateId	CPS-1986 - Getting issue details... STATUS - Allow updating of cmHandles with an alternateId
3
4

Space shortcuts

Page tree