You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,12 @@ Additionaly, a **shell** variant of the Docker image is available, this version
35
35
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.
36
36
37
37
- If you already have a Kubernetes cluster, please follow the [below documentation](#helm-deployment).
38
-
- 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)
38
+
- 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).
39
+
40
+
> [!WARNING]
41
+
> The [k3d installation method](./docs/k3d-install.md) 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.
Copy file name to clipboardExpand all lines: docs/k3d-install.md
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,26 @@
2
2
3
3
This guide will help you deploy and manage local Kubernetes clusters using k3d for GGBridge deployment.
4
4
5
-
## 📋 Prerequisites
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
+
10
+
## 🔧 Prerequisites
6
11
For this installation method, you will need a single server (VM, bare metal...) and install following components:
7
12
8
13
-[Docker](https://docs.docker.com/get-docker/) installed and running
9
14
-[K3d](https://k3d.io/v5.8.3/#installation) version 5.8.3 or superior
10
15
-[helm](https://helm.sh/docs/intro/install/) to install GGBridge in the k3d cluster
11
16
-[kubectl](https://kubernetes.io/docs/tasks/tools/) to interact with the cluster
12
17
13
-
## Quick Start
14
-
### Basic CLI installation
18
+
## ⚡ Quick Start
19
+
20
+
> [!IMPORTANT]
21
+
> There are two methods for installing GGBridge on k3d, the [Basic CLI installation](#-basic-cli-installation), and [using config files](#-config-file-installationn). While the basic CLI works, we recommend the second one for a long-term and maintainable lifecycle.
22
+
23
+
24
+
### 💻 Basic CLI installation
15
25
16
26
> [!NOTE]
17
27
> Single node cluster here is minimal installation and low footprint
> This installation is using declarative approach with explicit yaml files to describe cluster and Helm installation. It brings several advantages upon [basic CLI installation](#basic-cli-installation). We recommend using this method if you are familiar with Kubernetes.
90
+
> This installation is using declarative approach with explicit yaml files to describe cluster and Helm installation. It brings several advantages upon [basic CLI installation](#-basic-cli-installation). We recommend using this method if you are familiar with Kubernetes.
0 commit comments