@@ -31,7 +31,37 @@ to each driver crate:
3131| Kubernetes | [ ` openshell-driver-kubernetes ` ] ( https://github.com/NVIDIA/OpenShell/blob/main/crates/openshell-driver-kubernetes/README.md ) |
3232| Windows MXC | [ ` openshell-driver-mxc ` ] ( https://github.com/NVIDIA/OpenShell/blob/main/crates/openshell-driver-mxc/README.md ) |
3333
34- External compute drivers implement [ ` compute_driver.proto ` ] ( https://github.com/NVIDIA/OpenShell/blob/main/proto/compute_driver.proto ) .
34+ ### Using an External Compute Driver
35+
36+ External compute drivers must implement [ ` compute_driver.proto ` ] ( https://github.com/NVIDIA/OpenShell/blob/main/proto/compute_driver.proto ) .
37+ Refer to [ Protocol Negotiation] ( /extensibility/overview#protocol-negotiation ) for the metadata and capability requirements, and
38+ [ Isolation Backends] ( /extensibility/isolation-backends ) for the workload runtime
39+ contract. Your driver must also acknowledge the gateway's
40+ [ resource admission policy] ( /how-it-works/gateways/configuration#external-resource-admission ) .
41+
42+ Run your driver as a separate service listening on a Unix domain socket. The
43+ gateway does not start or supervise it. Restrict socket access to the gateway
44+ user and make the socket accessible from the gateway's host or container.
45+
46+ Select a name that is not reserved by a built-in driver, then add it and the
47+ socket path to your existing ` gateway.toml ` :
48+
49+ ``` toml
50+ [openshell ]
51+ version = 2
52+
53+ [openshell .gateway ]
54+ compute_driver = " example-compute"
55+
56+ [openshell .drivers .example-compute ]
57+ socket_path = " /run/openshell/example-compute.sock"
58+ ```
59+
60+ Start the driver, then start or restart the gateway with this configuration. Use
61+ ` openshell gateway info ` from a CLI connected to that gateway to verify the
62+ active driver and negotiated capabilities. See the
63+ [ Extension Driver configuration reference] ( /how-it-works/gateways/configuration#extension-driver )
64+ for configuration details.
3565
3666## Credential Drivers
3767
0 commit comments