fixup: docs (#157)

Author: adyanth

docs/configuration/tunnel-and-cluster-tunnel.md

@@ -7,10 +7,10 @@ The Tunnel and the ClusterTunnel have the exact same configuration options. The
 kubectl explain tunnel.spec
 ```
 
-Here is an overview of a ClusterTunnel as YAML.
+Here is an overview of a ClusterTunnel as YAML for `v1alpha2`. Also look at migration docs for [`v1alpha1`](../migrations/crd/v1alpha2.md)
 
 ```yaml
-apiVersion: networking.cfargotunnel.com/v1alpha1
+apiVersion: networking.cfargotunnel.com/v1alpha2
 kind: ClusterTunnel     # or Tunnel
 metadata:
   name: tunnel-cr-name
@@ -43,8 +43,14 @@ spec:
 
   # cloudflared configuration
   fallbackTarget: http_status:404           # The default service to point cloudflared to. Defaults to http_status:404
-  image: cloudflare/cloudflared:2025.4.0    # Image to run. Used for running an up-to-date image. Can be swapped out to an arm based image if needed
   noTlsVerify: false                        # Disables the TLS verification to backend services globally
   originCaPool: homelab-ca                  # Secret containing CA certificates to trust. Must contain tls.crt to be trusted globally and optionally other certificates (see the caPool service annotation for usage)
-  size: 1                                   # Replica count for the tunnel deployment
+  deployPatch: |
+    spec:
+      replicas: 2
+        template:
+          spec:
+            containers:
+              - name: cloudflared
+                image: cloudflare/cloudflared:2025.4.0 # Image to run. Used for running a pinned image. Can be swapped out to an arm based image if needed
 ```

docs/examples/tunnel-binding-simple/manifests/cloudflare-operator/cluster-tunnel.yaml

@@ -1,11 +1,10 @@
-apiVersion: networking.cfargotunnel.com/v1alpha1
+apiVersion: networking.cfargotunnel.com/v1alpha2
 kind: ClusterTunnel
 metadata:
   name: k3s-cluster-tunnel      # The ClusterTunnel Custom Resource Name
 spec:
   newTunnel:
     name: my-k8s-tunnel         # Name of your new tunnel on Cloudflare
-  size: 2                       # This is the number of replicas for cloudflared
   cloudflare:
     email: email@example.com     # Your email used to login to the Cloudflare Dashboard
     domain: example.com         # Domain under which the tunnel runs and adds DNS entries to

docs/examples/tunnel-binding-with-reverse-proxy/README.md

@@ -89,7 +89,7 @@ This assumes:
    - in `manifests/hello/ingress.yaml`
      - `<domain>`: the domain associated with the cloudflare zone you are managing.
        This should match your tunnel/clusterTunnel.
-   - in `manifests/tunnel-binding.yaml`
+   - in `manifests/cloudflare-operator/tunnel-binding.yaml`
        - `<domain>`: the domain associated with the cloudflare zone you are managing.
          This should match your tunnel/clusterTunnel.
 1. deploy the TunnelBinding

docs/examples/tunnel-binding-with-reverse-proxy/manifests/cloudflare-operator/cluster-tunnel.yaml

@@ -0,0 +1,14 @@
+apiVersion: networking.cfargotunnel.com/v1alpha2
+kind: ClusterTunnel
+metadata:
+  name: example-tunnel      # The ClusterTunnel Custom Resource Name
+spec:
+  newTunnel:
+    name: my-k8s-tunnel         # Name of your new tunnel on Cloudflare
+  cloudflare:
+    email: email@example.com     # Your email used to login to the Cloudflare Dashboard
+    domain: example.com         # Domain under which the tunnel runs and adds DNS entries to
+    secret: cloudflare-secrets  # The secret created before
+    # accountId and accountName cannot be both empty. If both are provided, Account ID is used if valid, else falls back to Account Name.
+    accountName: <Cloudflare account name>
+    accountId: <Cloudflare account ID>

docs/examples/tunnel-binding-with-reverse-proxy/manifests/cloudflare-operator/tunnel-binding.yaml

@@ -0,0 +1,23 @@
+apiVersion: networking.cfargotunnel.com/v1alpha1
+kind: TunnelBinding
+metadata:
+  name: ingress-nginx
+subjects:
+  # this example assumes you are exposing services with your reverse proxy without certificates.
+  # In general this is not recommended
+  - name: wildcard
+    spec:
+      fqdn: "*.<domain>"
+      target: http://ingress-nginx-controller.ingress-nginx.svc.cluster.local:80
+      noTlsVerify: true
+
+#  # this example assumes you are generating certificates for your reverse proxy using e.g. cert-manager
+#  # you should use only one of the following two configurations, not both.
+#  - name: wildcard
+#    spec:
+#      fqdn: "*.<domain>"
+#      target: https://ingress-nginx-controller.ingress-nginx.svc.cluster.local:443
+
+tunnelRef:
+  kind: ClusterTunnel
+  name: example-tunnel

docs/examples/tunnel-binding-with-reverse-proxy/manifests/tunnel-binding.yaml

@@ -1,11 +1,10 @@
-apiVersion: networking.cfargotunnel.com/v1alpha1
+apiVersion: networking.cfargotunnel.com/v1alpha2
 kind: Tunnel
 metadata:
   name: example-tunnel
 spec:
   newTunnel:
     name: example-tunnel
-  size: 1
   cloudflare:
     email: <email-address>
     domain: <domain>

docs/examples/tunnel-simple/manifests/tunnel.yaml

@@ -63,9 +63,12 @@ kubectl apply -k 'https://github.com/adyanth/cloudflare-operator/config/default'
 Now that the operator is installed, we can make it useful.
 
 1. [Deploy a secret with your API token](./docs/examples/operator-authentication)
-1. [Create a Tunnel/ClusterTunnel resource](./docs/examples/tunnel-simple)
-1. Configure routing for your tunnel by following one of:
+2. [Create a Tunnel/ClusterTunnel resource](./docs/examples/tunnel-simple)
+3. Configure routing for your tunnel by following one of:
     - [configure routing directly (simple)](./docs/examples/tunnel-binding-simple)
     - [configure routing with a reverse proxy](./docs/examples/tunnel-binding-with-reverse-proxy)
 
-Look into the documentation in `docs/configuration` to understand various configurable parameters of this operator.
+## Additional Info
+
+* Look into the documentation in `docs/configuration` to understand various configurable parameters of this operator.
+* Look at migration documentation in `docs/migrations` for upgrades.