Skip to content

Commit ab68c5b

Browse files
author
Frederic Spiers
committed
docs(readme): improve documentation to mention replicacount should be 3
1 parent f6a5f7b commit ab68c5b

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,23 @@ The project offers two deployment methods:
3939

4040
### Docker deployment
4141

42+
> [!WARNING]
43+
> Please consider that [Docker deployment](#docker-deployment) mode is intended for testing purposes. We highly recommend using [Helm deployment](#helm-deployment) mode.
44+
4245
Deploy the ggbridge client via Docker Compose by performing the following actions:
4346

4447
- Create `docker-compose.yml` file
4548

49+
> [!IMPORTANT]
50+
> GGBridge is designed by default to work as HA, so it needs `3` client deployments to work properly. Ensure `replicas: 3` in your `docker-compose.yml` file.
51+
>
52+
> ```yaml
53+
> services:
54+
> client:
55+
> deploy:
56+
> replicas: 3
57+
> ```
58+
4659
```yaml
4760
name: ggbridge
4861
@@ -53,7 +66,6 @@ services:
5366
SERVER_ADDRESS: <my-subdomain>.ggbridge.gitguardian.com
5467
TLS_ENABLED: 'true'
5568
deploy:
56-
mode: replicated
5769
replicas: 3
5870
volumes:
5971
- ./tls/ca.crt:/etc/ggbridge/tls/ca.crt:ro
@@ -102,11 +114,18 @@ kubectl -n ggbridge create secret generic ggbridge-client-crt \
102114
Edit your Helm values file to point to your bridge server and the secret created above
103115
(see the [Helm chart values documentation](./helm/ggbridge) for all available configuration options):
104116
117+
> [!IMPORTANT]
118+
> GGBridge is designed by default to work as HA, so it needs `3` client deployments to work properly. Leave it blank or ensure `deploymentCount: 3` in your `values.yaml` file.
119+
>
120+
> ```yaml
121+
> deploymentCount: 3
122+
> ```
123+
105124
```yaml
106125
hostname: <my-subdomain>.ggbridge.gitguardian.com
107126
108127
image:
109-
tag: latest-shell
128+
tag: latest
110129
111130
tls:
112131
enabled: true
@@ -117,6 +136,15 @@ tls:
117136
key: tls.key
118137
```
119138
139+
> [!TIP]
140+
> If you need to debug the deployment, you can use the image `latest-shell` instead of `latest`. This image comes with embedded tooling for debugging purposes. :
141+
>
142+
> ```yaml
143+
> image:
144+
> tag: latest-shell
145+
> ```
146+
147+
120148
For **OpenShift** deployment, use the following values:
121149
122150
```yaml

0 commit comments

Comments
 (0)