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 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions release/models/interfaces/openconfig-interfaces.yang
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,16 @@ module openconfig-interfaces {
Section 4.c of the IETF Trust's Legal Provisions Relating
to IETF Documents (http://trustee.ietf.org/license-info).";

oc-ext:openconfig-version "3.7.1";
oc-ext:openconfig-version "3.7.2";

revision "2024-04-04" {
revision "2024-10-15" {
description
"Clarify cpu and management interface types.";
reference
"3.7.2";
}

revision "2024-04-04" {
description
"Use single quotes in descriptions.";
reference
Expand Down Expand Up @@ -720,21 +727,25 @@ module openconfig-interfaces {
type boolean;
description
"When set to true, the interface is a dedicated
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 for external connectivity to the system.
This interface is not connected to an INTEGRATED_CIRCUIT and
therefore not typically used for dataplane traffic. It may be
Comment on lines +731 to +732
Copy link

Choose a reason for hiding this comment

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

this is the only part of the description that seems slightly off to me. I'm not sure I can come up with a better description, but why the use of capitalised 'INTEGRATED_CIRCUIT'? I think I'm likely missing the significance of this term - it makes sense that a dedicated management only interface is not designed to make use of the devices dataplane, but what is the relevance of not connecting to an IC? Surely there could be a separate IC specifically designed to handle management plane traffic?

used to connect the system to an out-of-band management network,
for example. On systems with a CONTROLLER_CARD, the PORT
components on the CONTROLLER_CARD are typically management
interfaces.";
oc-ext:telemetry-on-change;
}

leaf cpu {
type boolean;
description
"When set to true, the interface is for traffic
that is handled by the system CPU, sometimes also called the
control plane interface. On systems that represent the CPU
interface as an Ethernet interface, for example, this leaf
should be used to distinguish the CPU interface from dataplane
interfaces.";
that is sent between CPU components and other components within
a system. This is sometimes also called an internal control plane
interface. On systems that represent the CPU interface(s)
as Ethernet this leaf should be used to distinguish these internal
interface from dataplane and management interfaces.";
Copy link

Choose a reason for hiding this comment

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

nit: these internal interfaces

oc-ext:telemetry-on-change;
}
}
Expand Down
Loading