mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-30 07:33:59 +08:00
Piotr Mlocek
f213e9a49b
* docs(extensibility): reorganize extensibility and middleware guides Add an extensibility overview that introduces the extension protocol and links every extension point, and move extension caller authentication to a shared page used by middleware and gateway interceptors. Split the supervisor middleware guide into an overview, a Configure and Operate guide, and a Middleware Operations reference for service authors. The overview explains when to use middleware, shows where it runs, lists current limitations, and defines the service contract. Configure and Operate covers policy attachment, service registration, failure behavior, and observability. Middleware Operations describes HTTP request, HTTP response, and WebSocket message operations with shared inputs and results, per-operation diagrams, and detail accordions. Pin page slugs so links resolve, redirect the replaced dev middleware URL, and update reference and architecture links. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> * docs(middleware): clarify navigation and service contracts Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> * docs(middleware): drop obsolete dev URL redirect Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> --------- Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
41 lines
1.7 KiB
Plaintext
41 lines
1.7 KiB
Plaintext
---
|
|
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
title: "Drivers"
|
|
description: "Understand the compute and credential driver extension points in OpenShell."
|
|
keywords: "OpenShell Extensions, Compute Drivers, Credential Drivers, Extensibility"
|
|
---
|
|
|
|
OpenShell uses drivers to connect the gateway to workload runtimes and
|
|
credential stores. Drivers implement a stable capability boundary while the
|
|
gateway owns the public API, authorization, workspace scoping, and resource
|
|
lifecycle.
|
|
|
|
## Compute Drivers
|
|
|
|
Compute drivers create, inspect, and delete sandbox workloads. OpenShell ships
|
|
drivers for Kubernetes, Docker, Podman, virtual machines, and Windows MXC. An
|
|
external compute driver communicates with the gateway over a Unix domain
|
|
socket and negotiates its protocol version and capabilities before serving
|
|
requests.
|
|
|
|
For built-in driver configuration and behavior, refer to
|
|
[Runtimes](/reference/sandbox-compute-drivers).
|
|
|
|
## Credential Drivers
|
|
|
|
Credential drivers store provider credentials behind opaque handles. The
|
|
gateway resolves those handles when a provider is attached without persisting
|
|
the secret value in the provider record. OpenShell includes database,
|
|
Kubernetes Secret, and Vault-compatible credential drivers.
|
|
|
|
Configure the active credential driver in the
|
|
[Gateway Configuration](/reference/gateway-config#credential-drivers).
|
|
|
|
## Compatibility
|
|
|
|
Drivers exchange peer metadata with the gateway and advertise their extension
|
|
family capability. Upgrade both peers together when the protocol version
|
|
changes. Refer to [Extension Protocol Negotiation](/extensibility/extension-negotiation)
|
|
for the negotiation contract.
|