Skip to content

Add dynamic configuration to a BootConfig message. #158

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 31, 2025
Merged

Add dynamic configuration to a BootConfig message. #158

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94b4912
Add dynamic configuration to a `BootConfig` message.
robshakir May 19, 2025
39da8da
Add clarification as to where `dynamic_*_config` fields are valid.
robshakir May 19, 2025
c245830
Fix lint error.
robshakir May 19, 2025
4e6b4e5
Update comments per review.
robshakir May 23, 2025
5a0251a
Add clarification that `dynamic_*` fields must return an error.
robshakir May 31, 2025
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
18 changes: 18 additions & 0 deletions proto/bootz.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,10 +304,28 @@ message BootConfig {
// Proprietary key-value parameters that are required as part of boot
// configuration (e.g., feature flags, or vendor-specific hardware knobs).
google.protobuf.Struct metadata = 1;

// vendor_config and oc_config specify boot configuration that is considered
// immutable per the specification described in github.com/openconfig/bootz.
//
// Native format vendor configuration.
bytes vendor_config = 2;
// JSON rendered OC configuration.
bytes oc_config = 3;

// dynamic_vendor_config and dynamic_oc_config specify boot configuration
// that is required at boot time, but can be overwritten by dynamic
// configuration such as that applied by a gnmi.Set RPC call.
//
// These fields MUST only be used in the context of a BootstrapDataResponse
// and are not valid when a `BootConfig` is updated after device
// initialisation, for example through `gnoi.bootconfig.SetBootConfig`.
//
// Native format vendor configuration.
bytes dynamic_vendor_config = 5;
// JSON rendered OC configuration.
bytes dynamic_oc_config = 6;

// Bootloader key-value parameters that are required as part of boot
// configuration.
google.protobuf.Struct bootloader_config = 4;
Expand Down