Skip to content

Commit 2904ff2

Browse files
author
Frederic Spiers
committed
docs(warn): include warning for production ready setup
1 parent 2275a1c commit 2904ff2

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ The project can be deployed on Kubernetes-like infrastructure (k0s, k3s, Talos,
3737
- If you already have a Kubernetes cluster, please follow the [below documentation](#helm-deployment).
3838
- 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)
3939

40+
> [!WARNING]
41+
> The `k3d` installation method is not recommended for production due to single point of failure and lack of high availability.
42+
>
43+
> **For production setup**, we recommend deploying on a multi-node Kubernetes cluster across multiple AZs with proper redundancy and monitoring.
44+
4045
### Helm deployment
4146

4247
To deploy the ggbridge client in your Kubernetes cluster using Helm, follow these steps:

docs/k3d-install.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This guide will help you deploy and manage local Kubernetes clusters using k3d for GGBridge deployment.
44

5+
> [!WARNING]
6+
> This setup is not recommended for production due to single point of failure and lack of high availability.
7+
>
8+
> **For production setup**, we recommend deploying on a multi-node Kubernetes cluster across multiple AZs with proper redundancy and monitoring.
9+
510
## 📋 Prerequisites
611
For this installation method, you will need a single server (VM, bare metal...) and install following components:
712

0 commit comments

Comments
 (0)