TCP redirection guide

.github/workflows/review-app.yml

@@ -29,9 +29,9 @@ jobs:
           ORGA_ID: ${{ secrets.ORGA_ID }}
           GH_CC_PRE_BUILD_HOOK: './clevercloud-deploy-script.sh'
           GH_CC_WEBROOT: '/public'
-          GH_HEXTRA_VERSION: '0.8.0'
+          GH_HEXTRA_VERSION: 'v0.8.2'
           GH_HUGO_ENV: 'production'
-          GH_HUGO_VERSION: '0.129.0'
+          GH_HUGO_VERSION: '0.133.0'
         with:
           type: 'static-apache'
           set-env: true

content/doc/administrate/tcp-redirections.md

@@ -1,6 +1,6 @@
 ---
 type: docs
-title: TCP redirections with Clever Tools
+title: TCP redirections
 shortdesc: TCP redirections to port 4040 of your instance
 tags:
 - administrate
@@ -11,37 +11,93 @@
 type: docs
 ---
 {{< callout type="warning" >}}
-TCP redirections are currently available free of charge as long as the feature is still considered in a BETA stage.
+TCP redirections are currently available free of charge as long as the feature is in BETA stage.
 Once the feature leaves the BETA stage, it won't be free anymore.
 {{< /callout >}}
 
 ## What is a TCP redirection?
 
-A regular application on Clever Cloud needs to listen on port 8080 and answer to HTTP traffic.
+Most of Clever Cloud's applications must listen on port 8080 and answer to HTTP traffic.
+This serves requests routing as well as monitoring purposes.
+
+However, some applications might require binary protocol, with raw TCP interactions.
+In that case, you can use a TCP redirection to route TCP traffic from reverse proxies to your application.
+
+The IN port on reverse proxies (public side) is the usual 4040.
+The TCP redirection assigns a random OUT port specifically to your application (starting from port 5000)
+Configure the application to listen to this provided port.
+
+Once done, your application can now send and receive TCP traffic.
+
+
 Our reverse proxies then make your application available using HTTP(s) using your domain name.
 
 Some applications might additionally want to use a binary protocol, with raw TCP interactions.
 For this scenario, your application will have to listen for TCP traffic on port 4040.
 Once this is done, all you need to do is add a TCP redirection to your application. A port will be
-provided to you, and your TCP listener will be available on your domain name using the provided port.
+
 
 ## What is a namespace?
 
-When creating a TCP redirection, you will need to choose in which namespace you want to create it.
-If you are a Premium customer with dedicated reverse proxies, you will have your own namespace.
-If you are not a Premium customer and want to use a custom domain name, you will have to use the
+A namespace is a group of reverse proxies: either the default public ones, cleverapps.io, or dedicated ones
+A TCP redirection is associated with one of those 3 groups.
+
+- If you are  a regular customer and want to use a custom domain name, you have to use the
 "default" namespace.
-If you want to use a cleverapps domain, you will have to use the "cleverapps" namespace.
+- If you are a premium customer with dedicated reverse proxies, you have your own namespace.
+- If you want to use a cleverapps.io domain, you can use the "cleverapps" namespace.
 
-`clever tcp-redirs list-namespaces` will provide you with a list of namespaces that you are allowed
-to use for the current application.
+If you aren't sure what are the possible namespaces for your application, you can use `clever tcp-redirs list-namespaces`.
+This command lists all the possible namespaces current application.
 
 ## Creating a new TCP redirection
 
-Creating a new TCP redirection is as simple as `clever tcp-redirs add --namespace default` where
+### With the console
+
+From your console, select your application. In the secondary menu, go to **TCP redirections**.
+From there, you can create a `default` or `cleverapps` TCP redirection ( see [namespaces doc](#what-is-a-namespace?))
+
+The creation is instantaneous. Find the application assigned port on this page. 
+
+![Redirection console](/images/doc/TCP_redirection_console.png)
+
+### With the Clever CLI
+
+You can use the `clever tcp-redirs add --namespace default` command to create a TCP redirection from the CLI.
+Depending on your situation, you should replace `default` with the appropriate namespace.
+
+The port assigned to your application is displayed right after the TCP redirection creation.
+You can then contact your application's TCP listener using `tcp://your-domain-name:the-port/`.
+
 you can obviously replace "default" by the namespace of your choice. You will be prompted with
 the port that has been assigned to you and you will be able to contact your application's TCP
-listener using `tcp://your-domain-name:the-port/`
+
+## Managing redirections
+
+### Listing active redirections
+
+To visualize your application's redirections:
+
+- from your console, an active redirection has a green tick next to it
+- from the Clever CLI, you can use:
+
+```bash
+clever tcp-redirs
+```
+
+### Deleting redirections
+
+To delete a redirection on an application:
+
+- from your console, use the `delete` button next to the redirection
+- from the Clever CLI, use:
+
+```bash
+clever tcp-redirs remove (port) --namespace (namespace)
+```
+
+Example: if your redirection is on port **5500** and the **default** namespace, the command would be
+`clever tcp-redirs remove 5500 --namespace default`
 
 ## Listing active TCP redirections
 
@@ -54,4 +110,3 @@
 
 We'll use namespace "default" and port "42" for this example.
 
-You can now remove your TCP redirection using `clever tcp-redirs remove 42 --namespace default`.

go.mod

@@ -2,4 +2,4 @@ module github.com/cnivolle/hextra //to update
 
 go 1.21
 
-require github.com/imfing/hextra v0.8.0 // indirect
+require github.com/imfing/hextra v0.8.2 // indirect

go.sum

@@ -1,2 +1,4 @@
 github.com/imfing/hextra v0.8.0 h1:bG2GavmsMAgRRCrm+N4c+m6mBm9KYrgGH0mgaJpIXjM=
 github.com/imfing/hextra v0.8.0/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=
+github.com/imfing/hextra v0.8.2 h1:/IykSIAywgKfhKUBgAW+dCCjrJWJNny4jr9qvdXfch0=
+github.com/imfing/hextra v0.8.2/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=

layouts/partials/openapi/head_openapi.html

@@ -25,7 +25,7 @@
 
 
   <!-- Google Analytics -->
-  {{- if and .Site.GoogleAnalytics (eq hugo.Environment "production") }}
+  {{- if and .Site.Config.Services.GoogleAnalytics.ID (eq hugo.Environment "production") }}
     <link rel="preconnect" href="https://www.googletagmanager.com" crossorigin />
     {{ partial "google-analytics.html" . }}
   {{- end }}