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
Publish an external compute-driver authoring guide that explains how third parties implement, run, configure, secure, and validate drivers against OpenShell's public contract.
Context
This is a remaining deliverable of the OpenShell Drivers roadmap (#1051) and follow-on hardening for the external compute-driver extension point (#1907 / PR #1703).
PR #2181 adds examples/fake-driver-rs, a scriptable out-of-process driver that exercises the public compute_driver.proto service over a Unix socket. The example currently contains implementation and scenario files but no README or published driver-author documentation.
The guide should use that example as executable reference material and connect it to external-driver endpoint testing (#1950) and driver conformance work (#2183 / PR #2182).
Definition of Done
Add a README for examples/fake-driver-rs covering its purpose, build, launch, configuration, and scripted scenarios.
Document the public compute-driver RPC and capability/version compatibility expectations.
Document Unix socket ownership, filesystem permissions, gateway configuration, and the operator-owned process trust boundary.
Explain lifecycle, watch-stream, callback-endpoint, identity, and unsupported-operation expectations.
Document how to run external-driver endpoint tests and the conformance suite.
Add an external-driver authoring page to the published documentation and navigation.
Description
Publish an external compute-driver authoring guide that explains how third parties implement, run, configure, secure, and validate drivers against OpenShell's public contract.
Context
This is a remaining deliverable of the OpenShell Drivers roadmap (#1051) and follow-on hardening for the external compute-driver extension point (#1907 / PR #1703).
PR #2181 adds
examples/fake-driver-rs, a scriptable out-of-process driver that exercises the publiccompute_driver.protoservice over a Unix socket. The example currently contains implementation and scenario files but no README or published driver-author documentation.The guide should use that example as executable reference material and connect it to external-driver endpoint testing (#1950) and driver conformance work (#2183 / PR #2182).
Definition of Done
examples/fake-driver-rscovering its purpose, build, launch, configuration, and scripted scenarios.