Update module reconfiguration lifecycle docs#5042
Conversation
viam-server now always rebuilds modular resources (close + re-create) when their configuration changes. In-place reconfiguration via Reconfigure() is no longer supported for modular resources in any language. This removes the incorrect claim that Python modules can implement reconfigure() to handle config changes in place. Source: viamrobotics/rdk#5944 https://claude.ai/code/session_01Xd7GAtzjRzypiJK1amk4Uu
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
|
Hold: source change reverted. The RDK change this PR documents (viamrobotics/rdk#5944, Remove-Reconfigure) was reverted by viamrobotics/rdk#5997 on 2026-05-07. The #5997 PR description says: "To reland Remove-Reconfigure: revert this PR." So Remove-Reconfigure is expected to re-land in 1-2 weeks. Recommendation: Do not merge this PR until Remove-Reconfigure re-lands. Once it does, this PR's changes will be correct again and can be merged (possibly with minor updates if the re-land differs from #5944). Generated by daily docs change agent Generated by Claude Code |
|
Hey @shannonbradshaw — CI is green and no reviewer is assigned yet. Could you request one when you have a chance? Auto-comment from overwatch. Will not re-nudge for 7 days. |
3 participants
Source changes
Reconfigurefrom theResourceinterface; modular resources are now always rebuilt (close + re-create) instead of reconfigured in place.Docs changes
docs/build-modules/module-reference.md: Removed the "In-place reconfigure" row from the Python/Go defaults table (Python'sreconfigure()via theReconfigurableprotocol is no longer called byviam-server). Added a paragraph clarifying thatviam-serveralways rebuilds modular resources. Updated theReconfigureResourceRPC description to reflect it now rebuilds rather than updates in place.static/include/components/apis/overrides/protos/sensor.Reconfigure.md: Updated the override description to state that modular resources are rebuilt rather than reconfigured atomically in place.How I found these
search-patterns.yamlentry forResource.Reconfigure(discovered 2026-04-15)grep -rl "Reconfigure" docs/build-modules/found 4 pages; the module-reference.md table had the incorrect Python claimGenerated by daily docs change agent
Generated by Claude Code