docs(warn): include warning for production ready setup

Author: Frederic Spiers

README.md

@@ -35,7 +35,12 @@ Additionaly, a **shell** variant of the Docker image is available, this version
 The project can be deployed on Kubernetes-like infrastructure (k0s, k3s, Talos, EKS, GKE, AKS...). GGBridge leverages **Helm Chart Deployment** which is an industry standard method for production environements, offering enhanced configurability and scalability for Kubernetes setups.
 
 - If you already have a Kubernetes cluster, please follow the [below documentation](#helm-deployment). 
-- If you do not have a dedicated Kubernetes cluster, you can deploy GGBridge with a `k3d` cluster on a single VM. Please follow the [k3d installation documentation](./docs/k3d-install.md)
+- If you do not have access to a Kubernetes cluster, you can deploy GGBridge along with a `k3d` cluster on a single VM. Please follow the [k3d installation documentation](./docs/k3d-install.md).
+
+> [!WARNING]  
+> The [k3d installation method](./docs/k3d-install.md) is not recommended for production due to single point of failure and lack of high availability.
+>
+> **For production setup**, we recommend deploying on a multi-node Kubernetes cluster across multiple AZs with proper redundancy and monitoring.
 
 ### Helm deployment
 

docs/k3d-install.md

@@ -2,6 +2,11 @@
 
 This guide will help you deploy and manage local Kubernetes clusters using k3d for GGBridge deployment.
 
+> [!WARNING]  
+> This setup is not recommended for production due to single point of failure and lack of high availability.
+>
+> **For production setup**, we recommend deploying on a multi-node Kubernetes cluster across multiple AZs with proper redundancy and monitoring.
+
 ## 📋 Prerequisites
 For this installation method, you will need a single server (VM, bare metal...) and install following components:
 
@@ -11,6 +16,11 @@ For this installation method, you will need a single server (VM, bare metal...)
 - [kubectl](https://kubernetes.io/docs/tasks/tools/) to interact with the cluster
 
 ## Quick Start
+
+> [!IMPORTANT]  
+> There are two methods for installing GGBridge on k3d, the [Basic CLI installation](#basic-cli-installation), and [using config files](#config-file-installation). While the basic CLI works, we recommend the second one for a long-term and maintainable lifecycle.
+
+
 ### Basic CLI installation
 
 > [!NOTE]  
@@ -27,7 +37,7 @@ k3d cluster create ggbridge --agents 0 \
                             --k3s-arg "--disable=servicelb@server:*" \
                             --k3s-node-label "project=ggbridge@server:*" \
                             --api-port 0.0.0.0:6445 \
-                            --image rancher/k3s:v1.34.1-k3s1 \
+                            --image rancher/k3s:v1.33.5-k3s1 \
                             --timeout 3m0s
 ```
 2. Create the GGBridge namespace
@@ -46,12 +56,11 @@ kubectl create secret generic ggbridge-client-crt -n ggbridge --from-file=tls.cr
 
 4. Install GGBridge client
 
-> [!IMPORTANT]  
-> Replace `$uid` here with the Bridge UID
+Replace `$uid` here with the Bridge UID
 
 ```bash
 helm -n ggbridge upgrade -i ggbridge oci://ghcr.io/gitguardian/ggbridge/helm/ggbridge \
-                         --set hostname="$uid.ggbridge.gitguardian.com" \
+                         --set hostname="$uid.ggbridge.gitguardian.tech" \
                          --set tls.enable=true \
                          --set tls.existingSecret="ggbridge-client-crt" \
                          --set tls.existingSecretKeys.caCrt="ca.crt" \

k3d/cluster.yaml

@@ -10,7 +10,7 @@ agents: 0
 kubeAPI:
   hostIP: "0.0.0.0"
   hostPort: "6445"
-image: rancher/k3s:v1.34.1-k3s1
+image: rancher/k3s:v1.33.5-k3s1
 files:
   - description: 'GGbridge namespace'
     source: |