📝 Update documentation for adyanth#57

PowerBootWS · Dec 20, 2022 · 4dd8a76 · 4dd8a76
1 parent 5f10fbb
commit 4dd8a76
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -66,7 +66,9 @@ spec:
 
 ### TunnelBinding
 
-This replaces the older implementation which used annotations on services to configure the endpoints. The TunnelBinding resource, inspired by RoleBinding, uses a similar structure with `subjects`, which are the target services to tunnel, and `tunnelRef` which provides details on what tunnel to use. Below is a detailed sample. Again, using `kubectl explain tunnelbinding.subjects` and `kubectl explain tunnelbinding.tunnelRef` gives the latest documentation on these.
+This replaces the older implementation which used annotations on services to configure the endpoints. The TunnelBinding resource, inspired by RoleBinding, uses a similar structure with `subjects`, which are the target services to tunnel, and `tunnelRef` which provides details on what tunnel to use. Below is a detailed sample. Again, using `kubectl explain tunnelbinding.subjects` and `kubectl explain tunnelbinding.tunnelRef` gives the latest documentation on these. Below are the new config options over the service annotations.
+
+* `tunnelRef.disableDNSUpdates`: Disables DNS record updates by the controller. You need to manually add the CNAME entries to point to the tunnel domain. The tunnel domain is of the form `tunnel-id.cfargotunnel.com`. The tunnel ID can be found using `kubectl get clustertunnel/tunnel <tunnel-name>`. You can also make use of the [proxied wildcard domains](https://blog.cloudflare.com/wildcard-proxy-for-everyone/) to CNAME `*.domain.com` to your tunnel domain so that manual DNS updates are not required.
 
 ```yaml
 apiVersion: networking.cfargotunnel.com/v1alpha1
@@ -86,6 +88,7 @@ subjects:
 tunnelRef:
   kind: Tunnel # Or ClusterTunnel
   name: k3s-tunnel
+  disableDNSUpdates: false
 ```
 
 ## Migrating from pre v0.9

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -155,4 +155,4 @@ And that's it. Head over to `whoami.example.com` to see your deployment exposed
 ## Deleting a tunnel
 
 Remember the delete order while deleting the tunnel. If you delete the secrets before deleting the tunnel, the operator won't be able to clean up the tunnel from Cloudflare, since it no longer has the credentials for the same.
-The correct order is to delete the tunnel, wait for it to actually get deleted (after the finalizer is removed) and then delete the secret.
+The correct order is to delete the tunnel, wait for it to actually get deleted (after the finalizer is removed) and then delete the secret.