quick-tunnel

Name: quick-tunnel
Author: iii

v0.1.1

Manage expiring durable leases on authorized cloudflared Quick Tunnel child processes.

Install

bash

iii trigger compose::add worker=quick-tunnel

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Function

Acquire or extend an expiring durable lease for an operator-authorized local target; returns immediately, possibly starting

Request

consumer_idstringrequired
Stable opaque consumer identity; not a credential.
expires_atstring· date-timerequired
Absolute lease expiry in RFC3339, strictly in the future.
tunnel_idstring

Response

Function

Release one lease idempotently; the last lease stops and reaps the tunnel child

Request

Response

Function

Read the latest tunnel generation, connection state, public URL and non-secret leases

Request

Response

errorstring
Sanitized lifecycle failure, never raw cloudflared output.
generationstringrequired
leasesobject[]required
- consumer_idstringrequired
- expires_atstring· date-timerequired
- lease_idstringrequired
- tunnel_idstringrequired
prerequisitesany of
Whether the operator-provided cloudflared is usable, and where to get it.
any of (2)
Variant 1
cloudflaredobjectrequired
Show 5 nestedHide nested
errorstring
Why it is not usable, when `found` is false.
foundbooleanrequired
True when an executable was found and answered `--version`.
install_urlstringrequired
Where to install it from; quick-tunnel never installs it.
pathstring
Absolute path quick-tunnel runs.
versionstring
First line of `cloudflared --version`.
Variant 2
valuenull
public_urlstring
statusstringrequiredenum starting, ready, reconnecting, failed, stopped
tunnel_idstringrequired

Trigger

Tunnel lifecycle snapshot changed; subscribe before acquire, then read status to close races

Invocation

Return