NosImage Profile enhancement readme creation#5395
NosImage Profile enhancement readme creation#5395kapilrajput-g wants to merge 3 commits intoopenconfig:mainfrom
Conversation
Summary of ChangesHello, 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 introduces documentation to support the transition of the NOSImageProfile to a more structured, machine-readable format. By defining specific requirements for test results, platform integrity data, and release categorization, this change facilitates better automated ingestion and validation of network operating system image metadata. Highlights
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new requirements document for NOSImageProfile enhancements, detailing structured reporting for test results, platform configuration registers (PCRs), and image release types. Feedback indicates that the pcrs and image_type fields, along with their respective message and enum types, are not yet defined in the protobuf schema, which will cause validation and unmarshaling failures in the associated tools.
| ### 2. Platform Configuration Registers (PCRs) | ||
| The `pcrs` field stores the expected hardware-specific integrity values for a given NOS image. Providing this data in a structured format allows for automated verification of platform security states. | ||
|
|
||
| * **Field**: `repeated PlatformConfigurationRegister pcrs = 9;` | ||
| * **Attributes**: | ||
| * **index**: The vendor-specific index number (e.g., 0, 7). | ||
| * **values**: One or more valid hash values (typically SHA hexadecimal strings). | ||
| * **name**: (Optional) A human-readable description for the register (e.g., "BIOS", "Secure Boot Policy"). |
There was a problem hiding this comment.
The pcrs field and the PlatformConfigurationRegister message type are not defined in proto/nosimage.proto. Documenting fields that do not exist in the schema will cause validation errors for users following this guide.
| ### 3. Image Release Type | ||
| The `image_type` field defines the release stage of the network operating system image, allowing automated ingestion pipelines to categorize builds correctly. | ||
|
|
||
| * **Field**: `ImageType image_type = 10;` | ||
| * **Supported Values**: | ||
| * `IMAGETYPE_GENERAL_AVAILABILITY`: Standard GA release. | ||
| * `IMAGETYPE_ENGINEERING`: Intermediate or engineering build. | ||
| * `IMAGETYPE_BETA`: Beta release. | ||
| * `IMAGETYPE_CUSTOMER_SPECIAL`: Customer-specific build. |
There was a problem hiding this comment.
The image_type field and the ImageType enum are not defined in proto/nosimage.proto. Please ensure the protobuf definition is updated to include these fields to maintain consistency between the code and documentation.
| # Enhancement: Structured platform integrity data | ||
| pcrs: { | ||
| index: 0 | ||
| values: "abc123def456..." | ||
| name: "BIOS" | ||
| } | ||
| pcrs: { | ||
| index: 7 | ||
| values: "789ghi012jkl..." | ||
| name: "Secure Boot Policy" | ||
| } | ||
|
|
||
| # Enhancement: Categorized image release type | ||
| image_type: IMAGETYPE_GENERAL_AVAILABILITY |
There was a problem hiding this comment.
The example includes pcrs and image_type fields which are not present in the NOSImageProfile message. Using this example with the current validate.go tool will result in unmarshaling failures.
2 participants
No description provided.