openBackhaul / core

Core Information Model that consolidates all technology specific extension
Apache License 2.0
1 stars 0 forks source link

LogicalTerminationPoint::_(!)physicalPortReference String -> leafref #10

Closed openBackhaul closed 1 year ago

openBackhaul commented 4 years ago

The WireEquipment specification prescribes in chapter Instantiation:LogicalTerminationPoint and LayerProtocol : "The LogicalTerminationPoint::_physicalPortReference attribute shall be automatically configured to associate the Equipment object with the LogicalTerminationPoint object."

But LogicalTerminationPoint::physicalPortReference attribute is of String datatype in the Core IM.

Proposed Solution: UML: Changing the datatype from String towards a shared association YANG: Changing the type from string towards leafref with require-instance true;

openBackhaul commented 4 years ago

YANG has been changed from

    leaf-list physical-port-reference {
      type string;
      description
        "One or more text labels for the unmodeled physical port associated with the LTP.
         In many cases there is no associated physical port.";
    }

to

    leaf-list physical-port-reference {
      type leafref {
        require-instance true;
        path "/core-model:control-construct/core-model:equipment/core-model:uuid";
      }
      description
        "One or more text labels for the unmodeled physical port associated with the LTP.
         In many cases there is no associated physical port.";
    }

Issue to remain open until the datatype has been changed from String towards a shared association in the UML.

PrathibaJee commented 2 years ago

Related issue https://github.com/openBackhaul/core/issues/14

michbin commented 2 years ago

I am a little bit confused:

  1. The "description" element of the Yang definition shown above does not match the new type nor the intended usage described in the original proposal.
  2. IMO the original proposal was later superseded by the ltp-augment model.
demx8as6 commented 2 years ago

Describing the current status for the core-model related to physical-port-reference from "Release candidate #1"

    leaf-list physical-port-reference {
      type leafref {
        path "/core-model:control-construct/core-model:equipment/core-model:uuid";
        require-instance false;
      }
      description
        "One or more text labels for the unmodeled physical port associated with the LTP.
         In many cases there is no associated physical port.";
    }

As @michbin pointed the physical-port-reference conflicts with the later add LTP-Augment:

    leaf connector {
      type leafref {
        path "/core-model:control-construct/core-model:equipment/core-model:connector/core-model:local-id";
        require-instance false;
      }
      config false;
      description
        "Connector, where this interface (LTP) can be physically connected.";
    }

Question:

Bringing all the things together - the pyhsical-port-reference parameter is obsolete and replaced by the LTP-Augment::connector.

Potential Proposal:

demx8as6 commented 2 years ago

Decision at the 5G-xhaul call on 28th of September 2022:

openBackhaul commented 1 year ago

Implemented as decided.