ork proxy
Forward ports for deployed Orkestra components to localhost.
ork proxy
ork proxy --for cc
ork proxy --for runtime,cc
ork proxy -n my-platform-ns
Inspired by kubectl proxy, ork proxy replaces manual kubectl port-forward invocations when working with a Helm-deployed Orkestra. It discovers each component by its orkestra.orkspace.io/komponent label, resolves the right pod, and keeps all forwards alive with automatic reconnection. For the Runtime, it resolves the elected leader via the orkestra-konductor Lease so requests always reach the pod with authoritative state.
Flags
| Flag | Short | Default | Description |
|---|---|---|---|
--for | (all) | Comma-separated list of components to forward. Omit to forward all three. | |
--namespace | -n | orkestra-system | Namespace where Orkestra is deployed |
--runtime-port | 8080 | Local port for the Runtime | |
--cc-port | 8081 | Local port for the Control Center | |
--gateway-port | 8443 | Local port for the Gateway | |
--context | (active context) | Kubernetes context to use |
Component names (--for)
| Value | Aliases | Component |
|---|---|---|
runtime | run | Reconcilers, leader election, /katalog API |
cc | controlcenter, control-center | Control Center web UI |
gateway | gw | Gateway, admission webhooks |
Examples
# Forward all three components
ork proxy
# Control Center only
ork proxy --for cc
# Runtime and Control Center, custom namespace
ork proxy --for runtime,cc -n my-platform-ns
# Use a non-default port for Runtime (e.g. avoid conflict)
ork proxy --runtime-port 9090
# Forward against a specific kubeconfig context
ork proxy --context staging-context
What it does
- Reads the active kubeconfig (respecting
--kubeconfigand--context) - Discovers each selected component’s Service by the
orkestra.orkspace.io/komponentlabel - For Runtime: reads the
orkestra-konductorLease to resolve the elected leader pod - For CC and Gateway: selects a running pod from the Service’s selector
- Pre-checks that each local port is free — errors before opening any tunnel
- Opens a SPDY port-forward per component and prints the local URL
- Watches each forwarded pod independently — when a pod disappears, reconnection starts immediately without waiting for traffic to surface the broken tunnel
- For Runtime: probes
/healthafter the tunnel is established to confirm the new leader is serving before declaring connected (guards against the Lease transition window) - Exits cleanly on
Ctrl+C, or automatically if no selected components are deployed
Notes
ork proxyrequires a Helm-deployed Orkestra. For local development useork rundirectly.- The Runtime forward always targets the leader pod, not a random replica. This matters when inspecting live reconciler state or the
/katalogAPI. - Port conflicts are reported before any tunnel opens — use
--runtime-port,--cc-port, or--gateway-portto remap. - The Gateway forward uses plain HTTP on the local side; TLS is handled inside the cluster by the Gateway itself.