From 8e039f36657ac81c318d1433967cebf6b991df42 Mon Sep 17 00:00:00 2001 From: "Alex Ellis (OpenFaaS Ltd)" Date: Sat, 1 Feb 2025 09:02:19 +0000 Subject: [PATCH] Improve docs for base command Signed-off-by: Alex Ellis (OpenFaaS Ltd) --- cmd/inletsctl.go | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/cmd/inletsctl.go b/cmd/inletsctl.go index a1cb4cbb..9e0ecf5f 100644 --- a/cmd/inletsctl.go +++ b/cmd/inletsctl.go @@ -33,11 +33,20 @@ var inletsCmd = &cobra.Command{ Use: "inletsctl", Short: "Create exit nodes for use with inlets.", Long: ` -inletsctl automates the task of creating an exit-node on cloud infrastructure. -Once provisioned, you'll receive a command to connect with. You can use this -tool whether you want to use inlets or inlets-pro for L4 TCP. +Use inletsctl to create a VM (aka exit-node) with the inlets-server +preinstalled on cloud infrastructure. Once provisioned, you'll receive a +connection string for the inlets-pro client. -See also: inlets-operator which does the same job, but for Kubernetes services. +For HTTPS tunnels (L7): +The tunnel server will terminate TLS for you, just include the +--letsencrypt-domain flag for each domain you want to expose via the exit-node. + +For TCP tunnels (L4): +Use the --tcp flag to create a TCP tunnel via inletsctl create. This is +best suited to SSH, TLS, reverse proxies, databases, etc. + +See also: inlets-operator which automates L4 TCP tunnels for any +Kubernetes LoadBalancer services found in a cluster. `, Run: runInlets, SilenceErrors: true,