Add component install-position, install-component and deprecate location #1095

dplore · 2024-04-13T01:31:56Z

Change Scope

Deprecate the location leaf as it's current usage varies across implementations.
Introduce the install-position, install-component which more precisely define where a component is installed into a target index or install-position of a target install-component.

This change is backwards compatible.

The operational use case forinstall-position is: as a hardware replacement technician I want to receive an indication of the location of a replaceable hardware component within some network device physical package (chassis, shelf, linecard, etc). An example subset of the replaceable components in scope could include a chassis, fan, fabric, powersupply , linecard module or transceiver module. The value of the position indication should exactly match some physical label or display on the hardware or if that is not feasible, it should exactly match documentation identifying the available positions on the hardware component(s).

Tree view

*** /Users/dloher/old-tree.txt  Thu May  2 15:29:21 2024
--- new-tree.txt        Thu May  2 15:29:08 2024
***************
--- 8670,8678 ----
module: openconfig-platform
  +--rw components
     +--rw component* [name]
        +--rw name                           -> ../config/name
        +--rw config
        |  +--rw name?   string
        +--ro state          |  +--ro name?                           string
          |  +--ro type?                           union
          |  +--ro id?                             string
!         |  x--ro location?                       string
>         |  +--ro install-position?               string
>         |  +--ro install-component?              string
          |  +--ro description?                    string
          |  +--ro mfg-name?                       string
          |  +--ro mfg-date?                       oc-yang:date

[... snip ...]

        +--rw oc-linecard:linecard
           +--rw oc-linecard:config
           |  +--rw oc-linecard:power-admin-state?   oc-platform-types:component-power-type
           +--ro oc-linecard:state
           |  +--ro oc-linecard:power-admin-state?   oc-platform-types:component-power-type
!          |  x--ro oc-linecard:slot-id?             string

Platform Implementations

IOS XR

openconfig-platform-types:PORT
   /components/component[name="Port0/1/0/12"]/state/parent = "0/1/CPU0-NPU1"
   /components/component[name="Port0/1/0/12"]/state/location = "0/1/CPU0"

   New values:
   /components/component[name="Port0/1/0/12"]/state/install-position = "12"
   /components/component[name="Port0/1/0/12"]/state/install-component = "0/0/CPU0"

(IOSXR on the 8800 series names linecards including a CPU identifier)

JunOS

openconfig-platform-types:PORT components:
/components/component[name="FPC0:PIC0:PORT1"]/state/location = "FPC0:PIC0:PORT1"

New value:
/components/component[name="FPC0:PIC0:PORT1"]/state/install-position = "1"
/components/component[name="FPC0:PIC0:PORT1"]/state/install-component = "FPC0:PIC0"

EOS

openconfig-platform-types:PORT components:
/components/component[name="Ethernet4/1-Port"]/state/location = "4/1"

New value:
/components/component[name="Ethernet4/1-Port"]/state/install-position = "1"
/components/component[name="FPC0:PIC0:PORT1"]/state/install-component = "Linecard4"

OpenConfigBot · 2024-04-13T01:33:38Z

No major YANG version changes in commit f01c1fe

LimeHat · 2024-04-13T02:14:40Z

This is an interesting example.
Does an ASIC (NPU1) represent a helpful parent-position value for this use case?

dplore · 2024-04-13T02:56:00Z

This is an interesting example. Does an ASIC (NPU1) represent a helpful parent-position value for this use case?

No, the port to NPU does not map to the parent-position use case.

It is perhaps and example of why location may not be needed. The port to NPU component relationship is good to represent using the parent leaf. location is redundant.

LimeHat · 2024-04-13T03:11:06Z

It is perhaps and example of why location may not be needed. The port to NPU component relationship is good to represent using the parent leaf. location is redundant.

Perhaps, but it also shows that the parent-position is not applicable in some cases. In fact, the location leaf in this scenario would be more useful, since the location doesn't have to be directly related to the parent.

Just want to make sure you're ok with this (some components may not have a parent-position, or have a parent-position that isn't useful)

dplore · 2024-04-16T00:48:04Z

It is perhaps and example of why location may not be needed. The port to NPU component relationship is good to represent using the parent leaf. location is redundant.

Perhaps, but it also shows that the parent-position is not applicable in some cases. In fact, the location leaf in this scenario would be more useful, since the location doesn't have to be directly related to the parent.

Just want to make sure you're ok with this (some components may not have a parent-position, or have a parent-position that isn't useful)

I expanded on the description for parent-position.

release/models/interfaces/openconfig-interfaces.yang

release/models/platform/openconfig-platform.yang

rgwilton · 2024-04-24T10:17:01Z

@dplore, for clarity, in your example for IOS XR, should the parent-position not be '12' rather than 'NPU1'?

dplore · 2024-04-24T22:05:53Z

@dplore, for clarity, in your example for IOS XR, should the parent-position not be '12' rather than 'NPU1'?

Yes, thanks for this. I updated the example in the PR description to reflect this.

In that particular example, the parent of the PORT is an NPU. The operational use case we are solving for requires a mapping from the PORT to the position in the LINECARD (or CHASSIS in a fixed form factor device). Looking at this physically, both relationships exist; the port is wired to an NPU and NPU also occupies a position in the LINECARD/CHASSIS. So the hierarchy is PORT -> INTEGRATED_CIRCUIT -> LINECARD -> CHASSIS or PORT -> INTEGRATED_CIRCUIT -> CHASSIS or . We see this often. There could be additional additional ancestors in the tree between PORT and LINECARD/CHASSIS.

@SydneyCaulfeild and I discussed and had some ideas on how to resolve this programmatically. I'll let her comment.

LimeHat · 2024-04-24T22:29:30Z

Based on the updated example for IOS XR, it seems that parent-position should be ancestor-position instead?

According to the conversation above, my understanding was that the parent-position would not be applicable to a port when the parent is not a linecard module.

SydneyCaulfeild · 2024-04-24T23:03:53Z

I will still need this new leaf to be applicable even when the parent is not a linecard module. For example, the ports on an Arista have ancestors of PORT -> INTEGRATED_CIRCUIT -> LINECARD, and I need the slot of the port in the linecard. As another example, I need the relative location of a power supply in a power tray on Cisco 8808 devices. Here, the power tray is the grandparent of the power supply (using component names, it goes from 0/PT0-PM1 (power supply) -> 0/PT0-Power Module Slot 1" (no type) -> 0/PT0 (power tray)). There are other components within a parent of CHASSIS that I need the relative location of, such as a fabric card on some Arista devices.

I agree this should likely be renamed to ancestor-position to avoid confusion, because the position is not necessarily within the direct parent.

To make this leaf more clear, I think we should update the description to say that this leaf is "the relative location of the component within the first ancestor that is x". I believe x could be something like "is an FRU" (perhaps using the state/removable path) or "has part and serial numbers". In all examples I have seen, the intermediate parent that we want to "ignore" (ex INTEGRATED_CIRCUIT or NPU) does not have a part or serial number. They are also not removable.

Does anyone have any suggestions on which path would be best to describe the ancestor that we want the relative location from?

SydneyCaulfeild · 2024-04-25T16:44:22Z

I would also like to point out that some components already apply this logic of "use the location of a removable ancestor" in their current state/location path, so I don't think that this constraint is necessarily new.

For example, in a Cisco 8808, a component of type POWER_SUPPLY is the grandchild of a power tray. Example names: 0/PT0-PM1 power supply -> 0/PT0-Power Module Slot 1 intermediate component -> 0/PT0 power tray. The state/location of the power supply right now is 0/PT0 which is the name of the grandparent, not the parent. (I find it confusing that it holds the name and not the location, but either way this shows that it skips the immediate parent).

release/models/platform/openconfig-platform-common.yang

dplore · 2024-05-02T22:02:38Z

This was re-reviewed in the April 30 2024 OC operators meeting without objection.

@oscargdd wanted to review as his organization was running into similar challenges using the location leaf. @oscargdd please review and if you approve.

dplore · 2024-05-02T22:03:33Z

Setting this to last call for May 14th to give Oscar time to review.

dplore · 2024-05-02T22:46:45Z

Refreshed the PR description. @SydneyCaulfeild please review if it meets your expectations.

SydneyCaulfeild · 2024-05-06T15:50:37Z

@dplore the PR meets my expectations. Thanks for adding those examples!

release/models/platform/openconfig-platform.yang

s19nal

looks like all the open comments have been addressed Darren - happy to approve this one.

release/models/platform/openconfig-platform.yang

earies · 2024-05-29T21:42:49Z

release/models/platform/openconfig-platform.yang

+
+    leaf install-position {
+      type leafref {
+        path "../name";


Isn't this now incorrect according to the description?

Thank you for catching this. Yes, it should've remained as a string. I will update it now.

dplore added 6 commits April 10, 2024 16:18

add interface name type with regex pattern constraint

e1b0f64

fix regex

e904aad

require one or more chars in name and index

9f52e79

add parent-position

e82e0db

Merge branch 'master' into dplore/location-position

d0cbff9

trim whitespace

75c84d8

OpenConfigBot added the non-breaking label Apr 13, 2024

common ver bump

b96d871

dplore marked this pull request as ready for review April 16, 2024 00:38

dplore requested a review from a team as a code owner April 16, 2024 00:38

expand description

dffc4c5

trim whitespace

e3da0a1

dplore assigned s19nal Apr 16, 2024

s19nal reviewed Apr 17, 2024

View reviewed changes

release/models/interfaces/openconfig-interfaces.yang Outdated Show resolved Hide resolved

dplore added 4 commits April 17, 2024 08:43

remove changes from another PR

1407e91

remove changes from another PR

196f909

remove changes from another PR

e890cfc

Merge branch 'master' into dplore/location-position

db03a57

LimeHat reviewed Apr 17, 2024

View reviewed changes

release/models/platform/openconfig-platform.yang Outdated Show resolved Hide resolved

replace backtick with apostrophe (#1089)

fc467aa

dplore added 3 commits April 25, 2024 17:21

update deprecated description

8d4cbd5

revise install-component description

18127a7

revise install-component description

b61b01b

SydneyCaulfeild reviewed Apr 26, 2024

View reviewed changes

release/models/platform/openconfig-platform-common.yang Outdated Show resolved Hide resolved

dplore added 2 commits April 26, 2024 17:13

update rev descriptions

fa2706f

merge master

d624983

dplore assigned oscargdd May 2, 2024

fix revision statement

e6047e6

dplore changed the title ~~Add component parent-position and deprecate location~~ Add component install-position, install-component and deprecate location May 2, 2024

LimeHat suggested changes May 6, 2024

View reviewed changes

release/models/platform/openconfig-platform.yang Outdated Show resolved Hide resolved

dplore added 2 commits May 14, 2024 14:57

deprecate slot-id

11d5d8d

Merge branch 'master' into dplore/location-position

06fc458

dplore assigned SydneyCaulfeild May 17, 2024

Merge branch 'master' into dplore/location-position

8245471

dplore requested a review from s19nal May 28, 2024 16:46

s19nal approved these changes May 28, 2024

View reviewed changes

earies reviewed May 28, 2024

View reviewed changes

release/models/platform/openconfig-platform.yang Outdated Show resolved Hide resolved

SydneyCaulfeild approved these changes May 28, 2024

View reviewed changes

release/models/platform/openconfig-platform.yang Outdated Show resolved Hide resolved

dplore added 3 commits May 28, 2024 16:09

use leafref

70b61c2

use leafref

d994557

fix indent

f01c1fe

dplore merged commit 9eeeb20 into master May 29, 2024
14 checks passed

earies reviewed May 29, 2024

View reviewed changes

dplore mentioned this pull request May 30, 2024

fix install-position #1117

Merged

This was referenced Jun 10, 2024

Update gNMI-1.4 with FAN_TRAY type. openconfig/featureprofiles#3046

Merged

Update gNMI-1.4 with install-position and install-component. openconfig/featureprofiles#3069

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add component install-position, install-component and deprecate location #1095

Add component install-position, install-component and deprecate location #1095

dplore commented Apr 13, 2024 •

edited

Loading

OpenConfigBot commented Apr 13, 2024 •

edited

Loading

LimeHat commented Apr 13, 2024 •

edited

Loading

dplore commented Apr 13, 2024

LimeHat commented Apr 13, 2024 •

edited

Loading

dplore commented Apr 16, 2024

rgwilton commented Apr 24, 2024

dplore commented Apr 24, 2024

LimeHat commented Apr 24, 2024

SydneyCaulfeild commented Apr 24, 2024

SydneyCaulfeild commented Apr 25, 2024 •

edited

Loading

dplore commented May 2, 2024

dplore commented May 2, 2024

dplore commented May 2, 2024

SydneyCaulfeild commented May 6, 2024

s19nal left a comment

earies May 29, 2024

dplore May 30, 2024

Add component install-position, install-component and deprecate location #1095

Add component install-position, install-component and deprecate location #1095

Conversation

dplore commented Apr 13, 2024 • edited Loading

Change Scope

Tree view

Platform Implementations

OpenConfigBot commented Apr 13, 2024 • edited Loading

LimeHat commented Apr 13, 2024 • edited Loading

dplore commented Apr 13, 2024

LimeHat commented Apr 13, 2024 • edited Loading

dplore commented Apr 16, 2024

rgwilton commented Apr 24, 2024

dplore commented Apr 24, 2024

LimeHat commented Apr 24, 2024

SydneyCaulfeild commented Apr 24, 2024

SydneyCaulfeild commented Apr 25, 2024 • edited Loading

dplore commented May 2, 2024

dplore commented May 2, 2024

dplore commented May 2, 2024

SydneyCaulfeild commented May 6, 2024

s19nal left a comment

Choose a reason for hiding this comment

earies May 29, 2024

Choose a reason for hiding this comment

dplore May 30, 2024

Choose a reason for hiding this comment

dplore commented Apr 13, 2024 •

edited

Loading

OpenConfigBot commented Apr 13, 2024 •

edited

Loading

LimeHat commented Apr 13, 2024 •

edited

Loading

LimeHat commented Apr 13, 2024 •

edited

Loading

SydneyCaulfeild commented Apr 25, 2024 •

edited

Loading