README
¶
osg-driver
Compute drivers
Docker-first sandbox runtime — mounts, ExtraHosts, egress sidecar wiring.
Part of the zorneth / osg ecosystem
Overview
osg-driver implements ComputeDriver for osg: create/start/exec/delete containers, attach the egress sidecar, validate bind mounts, and inject OpenShell-style host-gateway aliases (host.osg.internal).
Key Features
| Category | Capabilities |
|---|---|
| Docker | Engine API create/exec/logs (Podman-compatible socket) |
| Sidecar | Proxy container on dual-home network + CA bundle env |
| Hosts | HostGatewayExtraHosts() → host.osg.internal / host.docker.internal |
| Mounts | Workdir + reserved system paths validation |
| Stubs | VM / K8s placeholders for future drivers |
Installation
go get github.com/zorneth/osg-driver@latest
Requirements: Go 1.27+, Docker Engine API access.
Quick Start
import dockerdriver "github.com/zorneth/osg-driver/driver/docker"
d, err := dockerdriver.New()
_ = d
_ = err
hosts := dockerdriver.HostGatewayExtraHosts()
// []string{"host.osg.internal:host-gateway", "host.docker.internal:host-gateway"}
_ = hosts
Package Structure
| Path | Purpose |
|---|---|
driver/ |
Driver interface + stubs |
driver/docker/ |
Docker Engine implementation |
mounts/ |
Bind-mount policy |
sidecar/ |
CA / env helpers for the proxy sidecar |
Related
| Resource | Link |
|---|---|
| Roadmap | ROADMAP.md |
| Organization | https://github.com/zorneth |
| Organization overview | github.com/zorneth |
| pkg.go.dev | github.com/zorneth/osg-driver |
License
MIT © zorneth
Directories
¶
| Path | Synopsis |
|---|---|
|
Package driver defines the compute backend interface (Docker, Podman, VM, K8s).
|
Package driver defines the compute backend interface (Docker, Podman, VM, K8s). |
|
docker
Package docker implements driver.ComputeDriver via the Docker Engine API.
|
Package docker implements driver.ComputeDriver via the Docker Engine API. |
|
kubernetes
Package kubernetes is an EXP Kubernetes compute-driver spike (not implemented).
|
Package kubernetes is an EXP Kubernetes compute-driver spike (not implemented). |
|
podman
Package podman discovers a rootless/rootful Podman API socket and speaks the Docker-compatible Engine API (same client as driver/docker).
|
Package podman discovers a rootless/rootful Podman API socket and speaks the Docker-compatible Engine API (same client as driver/docker). |
|
vm
Package vm is an EXP MicroVM compute-driver spike (not implemented).
|
Package vm is an EXP MicroVM compute-driver spike (not implemented). |
|
Package mounts validates host bind mounts and guest mount targets.
|
Package mounts validates host bind mounts and guest mount targets. |
|
Package sidecar starts the egress proxy container beside a sandbox.
|
Package sidecar starts the egress proxy container beside a sandbox. |
Click to show internal directories.
Click to hide internal directories.