You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 16005c6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/reference/gateway-config.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -379,7 +379,7 @@ For `kubernetes-secrets`, `namespace` sets where OpenShell-managed provider Secr
379
379
380
380
For `vault`, `address` points at the Vault service, `mount` and `kv_version` describe the KV engine where OpenShell-managed provider secrets are stored, and `auth_method = "kubernetes"` logs in with the gateway Pod's ServiceAccount token. For local or development validation, use `auth_method = "token_file"` with `token_path = "/path/to/token"`. Do not put literal Vault tokens in TOML.
381
381
382
-
Provider records that already contain inline database credentials remain readable for upgrade compatibility. New provider create/update requests still submit credential values through the normal API, but the gateway stores those values through the active credential storage path and persists only handles. The refresh worker migrates legacy inline secret refresh material to the same storage path before minting. Stop all older gateway replicas before starting the version that performs this migration; older protobuf runtimes do not preserve the new internal handle fields when they rewrite refresh state.
382
+
Provider records that already contain inline database credentials remain readable for upgrade compatibility. New provider create/update requests still submit credential values through the normal API, but the gateway stores those values through the active credential storage path and persists only handles. Before OpenShell 0.1.0, OpenShell does not automatically migrate inline refresh material or credential handles between drivers. Reconfigure refresh grants after an upgrade. Before changing credential drivers, remove affected credentials while the original driver is still available, then select the new driver and create them again. Do not run mixed gateway versions against the same refresh records.
383
383
384
384
For remote credential drivers, set `transport = "uds"` with `socket_path`. Omit `command`, `args`, and `startup_timeout_secs` when another service manager prestarts the driver socket. Keep backend tokens out of TOML; point the driver at mounted token files or native identity mechanisms instead.
Copy file name to clipboardExpand all lines: docs/sandboxes/providers-v2.mdx
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -625,14 +625,12 @@ The gateway sends a complete host, port, and path binding for every emitted stat
625
625
626
626
Refresh configuration is stored separately from the current injectable credential value. Non-secret refresh configuration remains in the refresh-state record. Secret material is resolved from the active credential driver only while the gateway mints a new short-lived token. The gateway writes the token back through credential storage and updates credential expiry metadata. If an OAuth issuer rotates its refresh token, the gateway stages the replacement through credential storage before committing the refresh generation and removes the previous handle afterward.
627
627
628
-
On upgrade, the refresh worker migrates legacy inline secret material before it
629
-
mints again. For a multi-replica gateway, stop every older replica before the
630
-
new version begins migration. A normal mixed-version rolling update is unsafe
631
-
because older protobuf runtimes can discard internal handle fields when they
632
-
rewrite refresh state. Migration removes plaintext values from current records,
633
-
but database backups, SQLite WAL/free pages, and Postgres dead tuples may retain
634
-
historical bytes. Rotate the upstream grant and apply the database's retention
635
-
or compaction procedure when historical erasure is required.
628
+
Before OpenShell 0.1.0, refresh-state and credential-driver migrations are not
629
+
supported. Upgrading from a build that stored refresh material inline requires
630
+
reconfiguring the refresh grant. To change credential drivers, delete or
631
+
reconfigure affected providers while the original driver is still available,
632
+
then select the new driver and create the credentials again. Do not run mixed
633
+
gateway versions against the same refresh records.
636
634
637
635
Each explicit `refresh configure` call also starts a new gateway-owned
638
636
authorization epoch. Automatic refresh and `refresh rotate` preserve that epoch,
0 commit comments