platform: add fault description leaf and ACTION_FW_REPROGRAM

[brianneville]

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

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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. ↩

[gemini-code-assist]

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.