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 1 commit
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
16 changes: 13 additions & 3 deletions proto/bootz.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,17 @@ message BootConfig {
// configuration (e.g., feature flags, or vendor-specific hardware knobs).
google.protobuf.Struct metadata = 1;

// Fields to store the configuration that is expected of a device at boot
// time. In all cases, the configuration used on the system is computed based
// on the union of vendor_config + oc_config + dynamic_vendor_config +
// dynamic_oc_config. The union should be performed according to the same
// rules as `union_replace` in gNMI.
//
// Note, the dynamic_* fields MUST only be considered in the context of a
// `BootstrapDataResponse` and are NOT valid when a `BootConfig` is updated
// after device bootstrapping/initialisation -- for example, through
// `gnoi.bootconfig.SetBootConfig`.
//
// vendor_config and oc_config specify boot configuration that is considered
// immutable per the specification described in github.com/openconfig/bootz.
//
Expand All @@ -317,9 +328,8 @@ message BootConfig {
// 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`.
// As per the above comment dynamic_vendor_config and dynamic_oc_config
// are ONLY valid in the context of `BootstrapDataResponse`.
//
// Native format vendor configuration.
bytes dynamic_vendor_config = 5;
Expand Down