Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify management and cpu interface type descriptions #1156

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dplore
Copy link
Member

@dplore dplore commented Jul 25, 2024

Change Scope

  • Add more detail to the descriptions for cpu and management interface types.
  • Since the component tree for management and cpu interfaces both should trace up to a CPU component, more description and examples are helpful to ensure the intended types are used.

@OpenConfigBot
Copy link

OpenConfigBot commented Jul 25, 2024

No major YANG version changes in commit 31b8562

management interface that is not connected to dataplane
interfaces. It may be used to connect the system to an
out-of-band management network, for example.";
management interface connected to the CPU and available
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think connected to the CPU phrasing is imprecise. They're co-located on the same board, but the CPU (a chip) is not a direct owner of the interface and does not have a direct connection. If we start counting indirect connections, then any regular interface is connected to the CPU.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps all we can say that is unique about a management connected interface is:

  1. it is not connected to an INTEGRATED_CIRCUIT.
  2. It is externally accessible to the device for user management access.

Is this more clear and precise enough to disambiguate from a 'cpu' interface?

Copy link

@LimeHat LimeHat Jul 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems reasonable.
FWIW I'm happy with the current (upstream) definition of the management leaf. In my view, ambiguity was related mostly to the definition of the cpu leaf (and the way it is used in gnmi-1.22 https://github.com/openconfig/featureprofiles/blob/4cff2c8fa1815887a481b0b051fbf077464c47ad/feature/platform/controllercard/tests/port/README.md?plain=1#L32-L33)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants