tunnel

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateStorefront added in v0.8.1

func CreateStorefront(cfg *config.Config, tunnelURL string) error

CreateStorefront creates (or updates) a simple HTML landing page served at the tunnel hostname's root path. This uses the same busybox-httpd + ConfigMap pattern as the .well-known registration in monetize.py.

func DeleteStorefront added in v0.8.1

func DeleteStorefront(cfg *config.Config) error

DeleteStorefront removes the storefront landing page resources.

func EnsureRunning added in v0.8.1

func EnsureRunning(cfg *config.Config, u *ui.UI) (string, error)

EnsureRunning scales the cloudflared deployment to 1 replica if it's at 0, waits for the pod to be ready, and returns the tunnel URL once available. If the tunnel is already running, it returns the current URL immediately.

func EnsureTunnelForSell added in v0.8.1

func EnsureTunnelForSell(cfg *config.Config, u *ui.UI) (string, error)

EnsureTunnelForSell ensures the tunnel is running and propagates the URL to the public service discovery surfaces needed by seller flows. It updates the frontend ConfigMap and storefront, but deliberately avoids syncing the obol-agent overlay. The agent overlay should be updated by explicit tunnel provisioning/login flows, not every ServiceOffer mutation.

func GetTunnelURL

func GetTunnelURL(cfg *config.Config) (string, error)

GetTunnelURL parses cloudflared logs to extract the quick tunnel URL.

func InjectBaseURL added in v0.8.1

func InjectBaseURL(cfg *config.Config, tunnelURL string) error

InjectBaseURL sets AGENT_BASE_URL on the default OpenClaw deployment so that monetize.py uses the tunnel URL in registration JSON.

func Login

func Login(cfg *config.Config, u *ui.UI, opts LoginOptions) error

Login provisions a locally-managed tunnel using `cloudflared tunnel login` (browser auth), then writes the required credentials/config into Kubernetes and upgrades the cloudflared Helm release so the in-cluster connector runs the locally-managed tunnel.

Docs: - Create a locally-managed tunnel: https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/do-more-with-tunnels/local-management/create-local-tunnel/ - Configuration file for published apps: https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/do-more-with-tunnels/local-management/configuration-file/ - `origincert` run parameter (locally-managed tunnels): https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/configure-tunnels/cloudflared-parameters/run-parameters/

func Logs

func Logs(cfg *config.Config, follow bool) error

Logs displays cloudflared logs.

func Provision

func Provision(cfg *config.Config, u *ui.UI, opts ProvisionOptions) error

Provision provisions a persistent Cloudflare Tunnel routed via a proxied DNS record.

Based on Cloudflare's "Create a tunnel (API)" guide: - POST /accounts/$ACCOUNT_ID/cfd_tunnel - PUT /accounts/$ACCOUNT_ID/cfd_tunnel/$TUNNEL_ID/configurations - POST /zones/$ZONE_ID/dns_records (proxied CNAME to <tunnel-id>.cfargotunnel.com)

func Restart

func Restart(cfg *config.Config, u *ui.UI) error

Restart restarts the cloudflared deployment.

func Status

func Status(cfg *config.Config, u *ui.UI) error

Status displays the current tunnel status and URL.

func Stop added in v0.8.1

func Stop(cfg *config.Config, u *ui.UI) error

Stop scales the cloudflared deployment to 0 replicas.

func SyncAgentBaseURL added in v0.8.1

func SyncAgentBaseURL(cfg *config.Config, tunnelURL string) error

SyncAgentBaseURL patches AGENT_BASE_URL in the obol-agent's values-obol.yaml and runs helmfile sync to apply the change. It is a no-op if the obol-agent deployment directory does not exist (agent not yet initialized).

func SyncTunnelConfigMap added in v0.8.1

func SyncTunnelConfigMap(cfg *config.Config, tunnelURL string) error

SyncTunnelConfigMap creates or patches the obol-stack-config ConfigMap in the obol-frontend namespace with the current tunnel URL. The frontend reads this ConfigMap to construct the correct dashboard URL.

Types

type LoginOptions

type LoginOptions struct {
	Hostname string
}

type ProvisionOptions

type ProvisionOptions struct {
	Hostname  string
	AccountID string
	ZoneID    string
	APIToken  string
}

ProvisionOptions configures `obol tunnel provision`.

type TunnelState added in v0.8.1

type TunnelState = tunnelState

TunnelState is an exported alias so other packages (agent, openclaw) can read tunnel state without reaching into unexported types.

func LoadTunnelState added in v0.8.1

func LoadTunnelState(cfg *config.Config) (*TunnelState, error)

LoadTunnelState reads the persisted tunnel state from disk. Returns (nil, nil) if no state file exists.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL