Skip to content

Commit eb3f3f4

Browse files
authored
Merge pull request #1 from geldata/update-readme-with-quickstart
Add a quickstart to the README.
2 parents f2a0a9c + 3e8ba07 commit eb3f3f4

File tree

2 files changed

+50
-3
lines changed

2 files changed

+50
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
44

5-
A collection of Helm charts for deploying the Gel Server (formerly EdgeDB) ecosystem on Kubernetes.
5+
Helm charts for deploying the Gel Server (formerly EdgeDB) ecosystem on Kubernetes.
66

77
---
88

charts/gel-server/README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# helm-gel-server
1+
# Gel Server Helm Chart
22

33
A Helm chart for deploying gel-server on kubernetes with an external PostgreSQL server
44

5-
- [helm-gel-server](#helm-gel-server)
5+
- [Quick Start](#quick-start)
66
- [Get Helm Repository Info](#get-helm-repository-info)
77
- [Install Helm Chart](#install-helm-chart)
88
- [Uninstall Helm Chart](#uninstall-helm-chart)
@@ -16,6 +16,53 @@ A Helm chart for deploying gel-server on kubernetes with an external PostgreSQL
1616
- [Automatically Generated TLS Certificates](#automatically-generated-tls-certificates)
1717
- [Self-Provided TLS Certificates](#self-provided-tls-certificates)
1818

19+
## Quick Start
20+
21+
1. **Create the database connection secret:**
22+
23+
```console
24+
kubectl create secret generic gel-db-creds \
25+
--from-literal=GEL_SERVER_BACKEND_DSN='postgresql://user:pass@postgres.example.com:5432/geldb' \
26+
-n gel
27+
```
28+
29+
2. **Create the server password secret:**
30+
31+
```console
32+
kubectl create secret generic gel-server-password \
33+
--from-literal=GEL_SERVER_PASSWORD='your-secure-password' \
34+
-n gel
35+
```
36+
37+
3. **Create a values.yaml file:**
38+
39+
```yaml
40+
extraEnvFromSecrets:
41+
- name: gel-db-creds
42+
- name: gel-server-password
43+
44+
config:
45+
logLevel: "info"
46+
47+
service:
48+
type: LoadBalancer
49+
```
50+
51+
4. **Install the chart:**
52+
53+
```console
54+
helm install my-gel-server gel/gel-server \
55+
-f values.yaml \
56+
-n gel \
57+
--create-namespace
58+
```
59+
60+
5. **Get the service endpoint:**
61+
62+
```console
63+
kubectl get svc -n gel
64+
```
65+
1966
## Get Helm Repository Info
2067

2168
```console

0 commit comments

Comments
 (0)