Skip to main content

Module cli

Module cli 

Source
Available on crate feature bin only.
Expand description

CLI surface for the standalone storage-proxy binary.

Two subcommands, mirroring the deployable half of the server crate’s CLI (the proxy has no database, so there is no migrate):

  • serve — run the byte-proxy (see serve::serve). Flags overlay the config file, CLI flags taking precedence. A config file is optional when the required upstream URL is supplied via --upstream-url.
  • healthcheck — probe the configured /health endpoint and exit 0 (healthy) or non-zero (unhealthy). This is the probe the distroless image’s Docker HEALTHCHECK runs, since distroless has no shell/curl.

Modules§

config
YAML configuration for the standalone storage-proxy binary.
serve
Serve wiring for the standalone storage-proxy binary.

Structs§

Cli
storage-proxy — standalone Unity Catalog storage byte-proxy.
HealthcheckArgs
Arguments for healthcheck. Shares the config/host/port resolution inputs so the probe targets the same address the server binds.
ServeArgs
Arguments for serve. Every flag is optional and, when present, overlays the value loaded from the config file (highest precedence). With no config file, --upstream-url is required.

Enums§

Command

Functions§

run_healthcheck
Run the health probe. Ok(()) iff the endpoint returns a 2xx with body OK; the caller maps any Err to a non-zero exit.