Skip to content

platform: add fault description leaf and ACTION_FW_REPROGRAM#1455

Open
brianneville wants to merge 8 commits into
openconfig:masterfrom
brianneville:fault-action
Open

platform: add fault description leaf and ACTION_FW_REPROGRAM#1455
brianneville wants to merge 8 commits into
openconfig:masterfrom
brianneville:fault-action

Conversation

@brianneville
Copy link
Copy Markdown
Contributor

@brianneville brianneville commented Mar 23, 2026

Change Scope

  • Add an action identity ACTION_FW_REPROGRAM to represent the case where the network operator should reprogram a component.
  • Add a description leaf at /components/component/healthz/faults/fault/remediations/remediation/state/description to allow vendors to provide more platform specific information about a particular remediating action.
  • this change is backward compatible

Platform Implementations

  • I am unaware of any publicly available documentation mentioning existing implementations of support for fault reporting over YANG via this model.

Tree View

This change adds the description leaf at:

  augment /oc-platform:components/oc-platform:component/oc-platform-healthz:healthz:
    +--rw faults
       +--ro fault* [symptom]
          +--ro remediations
             +--ro remediation* [index]
                +--ro state
                   +--ro description?   string

Add an identity to represent the case where the network
operator should reprogram FPGA images and reload drivers
in an effort to remediate a fault
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request extends the platform fault reporting model by introducing a new, explicit remediation action. This enhancement allows for better communication and automation of fault resolution by providing a standardized way to indicate when firmware reprogramming and driver reloading are necessary to address a fault, ensuring backward compatibility with existing implementations.

Highlights

  • New Action Identity: Added a new identity, ACTION_FW_REPROGRAM, to the openconfig-platform-healthz-fault YANG model. This identity represents a remediation action for network operators to reprogram FPGA images and reload drivers.
  • Model Version Update: The openconfig-platform-healthz-fault model's openconfig-version was incremented from "0.1.0" to "0.1.1", and a new revision entry was added to reflect the ACTION_FW_REPROGRAM addition.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new ACTION_FW_REPROGRAM identity to the openconfig-platform-healthz-fault YANG model. The change is backward-compatible and follows the existing structure. I have one suggestion to improve the clarity of the new identity's description to avoid potential ambiguity for implementers.

Comment thread release/models/platform/openconfig-platform-healthz-fault.yang Outdated
@brianneville brianneville changed the title platform: add ACTION_FW_REPROGRAM platform: add fault description leaf and ACTION_FW_REPROGRAM Mar 23, 2026
Comment thread release/models/platform/openconfig-platform-healthz-fault.yang
@dplore dplore moved this to Ready to discuss in OC Operator Review May 8, 2026
@dplore
Copy link
Copy Markdown
Member

dplore commented May 8, 2026

@mrevang for comment

@dplore
Copy link
Copy Markdown
Member

dplore commented May 8, 2026

/gcbrun

@OpenConfigBot
Copy link
Copy Markdown

No major YANG version changes in commit a3337db

@dplore
Copy link
Copy Markdown
Member

dplore commented May 8, 2026

Added to review for May 12, 2026 OC Operators meeting

"This model defines device reported fault";

oc-ext:openconfig-version "0.1.0";
oc-ext:openconfig-version "0.1.1";
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we are adding yang, this should be a minor version increment per semver rules

Suggested change
oc-ext:openconfig-version "0.1.1";
oc-ext:openconfig-version "0.2.0";

Copy link
Copy Markdown
Member

@dplore dplore left a comment

Choose a reason for hiding this comment

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

@earies @rgwilton @nokia1adam do your implementations have a similar function ?

Comment on lines +139 to +140
The targeted component may need to be powercycled
for the reprogramming to take effect.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Recommend updating to say something like:

if a power cycle is required, then ACTION_POWER_CYCLE will also be set as a remediations/remediation/action.

Comment on lines +142 to +146
In comparison to ACTION_FACTORY_RESET action,
ACTION_FW_REPROGRAM does not necessarily involve resetting
the firmware back to its factory default. It also does not
involve resetting any certificates on disk or removing
any config files or OS images.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can you elaborate on where the firmware is stored? Is this reloading firmware stored in the device filesystem? In particular are there any other actions that may need to be performed for ACTION_FW_REPROGRAM ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Ready to discuss

Development

Successfully merging this pull request may close these issues.

4 participants