feat(settings): gateway-to-sandbox runtime settings channel#474
Open
johntmyers wants to merge 21 commits intomainfrom
Open
feat(settings): gateway-to-sandbox runtime settings channel#474johntmyers wants to merge 21 commits intomainfrom
johntmyers wants to merge 21 commits intomainfrom
Conversation
|
Closes #405 Refactor the sandbox policy polling channel into an effective settings response with config revision tracking, global policy source metadata, and merged global/sandbox key resolution. Add gateway-global and sandbox-scoped setting mutations with per-key mutual exclusion, global delete unlock semantics, and global policy override behavior. Extend the CLI with settings get/set/delete and --global policy flows, then document the new control-plane behavior in architecture and user docs. Signed-off-by: John Myers <9696606+johntmyers@users.noreply.github.com>
…ditionally reload policy
…read-modify-write races
… consolidate TUI utils
…d CLI/TUI support
…d auto-refresh sandbox settings
johntmyers
force-pushed
the
codex/feat-405-sandbox-settings-channel
branch
from
4d4e3ce to
85fef54
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a general-purpose settings channel between the gateway and sandboxes, enabling runtime configuration changes without sandbox restarts. This separates the settings transport concern from issue #393 (OCSF logging) so it can land independently.
Related Issue
Closes #405
UX Changes
CLI
New commands:
openshell settings get [sandbox] [--global] [--json]-- show effective settings with scope indicators (sandbox/global/unset)openshell settings set [sandbox] --key K --value V [--global] [--yes]-- set a setting at sandbox or global scopeopenshell settings delete [sandbox] --key K [--global] [--yes]-- delete a setting (sandbox-scoped when not globally managed, or global)openshell policy list --global-- list global policy revision historyopenshell policy get --global [--rev N] [--full]-- show a specific global policy revisionChanged commands:
openshell policy set --globalnow creates versioned revisions (deduped by hash) instead of overwriting in-placeopenshell policy set --global --waitis rejected with a message ("global policies are effective immediately")--globalmutations require HITL confirmation (bypass with--yes)Scope resolution:
FailedPrecondition.TUI
Dashboard:
Providers | Global Settings(switch withh/l)Global Policy Active (v3)in yellow when a global policy is setSandbox screen:
Policy | Settings(switch withh/l)Policy: managed globally (v3)when sandbox policy is globally overriddenSandbox Logs
Policy poll:toSettings poll:Setting changed key=log_level new=debug old=<unset>Policy reloaded successfullyonly appears when the policy hash actually changed (not for settings-only changes)global_version=Nin the logArchitecture (tl;dr)
Proto changes (
sandbox.proto,openshell.proto)New types:
SettingValue(oneof string/bool/int64/bytes),EffectiveSetting(value + scope),SettingScope,PolicySource.New RPCs:
GetSandboxSettings-- returns effective policy + merged settings + config_revision + global_policy_versionGetGatewaySettings-- returns global-only settingsRenamed:
UpdateSandboxPolicy->UpdateSettings-- now handles policy and setting mutations at both scopes through field-based dispatch (global,setting_key,setting_value,delete_setting).Extended:
GetSandboxPolicyStatusandListSandboxPoliciesgained aglobalbool to query global policy revisions.Settings storage
Settings are stored as JSON blobs in the existing
objectstable withgateway_settingsandsandbox_settingsobject types. Sandbox settings use a prefixed ID (settings:{sandbox_uuid}) to avoid PK collision with sandbox objects. Atokio::sync::Mutexserializes all settings mutations to prevent read-modify-write races.Global policy versioning
Global policies are now versioned in the
sandbox_policiestable using a sentinelsandbox_idof__global__. Revisions are markedloadedimmediately (no sandbox confirmation for global policies). The existingget_latest_policy,list_policies, andsupersede_older_policiesStore methods work unchanged with the sentinel.Settings registry (
openshell-core/src/settings.rs)Compile-time
REGISTERED_SETTINGSarray defines allowed keys with typedSettingValueKind. Test keys (dummy_bool,dummy_int) gated behinddev-settingsfeature flag (on by default). The doc comment on the registry documents the process for adding new settings.Config revision
config_revisionis a 64-bit content hash (first 8 bytes of SHA-256 over policy + settings + source). The sandbox poll loop compares it to detect changes. Not a monotonic counter -- useswrapping_addfor the settings revision counter.TUI Dashboard with a global policy set:
Sandbox view with a global policy and one global setting override:
Changes
GetSandboxSettings/GetGatewaySettingsRPCs,UpdateSettingsrename, global flag on policy status/list RPCs,global_policy_versionfieldsettings get/set/delete,policy list/get --global,--jsonoutput,--waitrejection for globalparse_bool_like,display_setting_valuesettings_management.rscovering full lifecycle (sandbox set/delete, global override, lock/unlock)openshell-coreandopenshell-server(merge algorithm, conflict guard, delete-unlock, concurrency, round-trips)Testing
mise run pre-commitpassessettings_management.rs)Checklist